commsfwutils/commsbufs/mbufgobblerlayer/inc/mbufgobblerconnproviderfactory.h
author hgs
Thu, 23 Sep 2010 10:22:55 +0100
changeset 78 dd4909eb54cd
permissions -rw-r--r--
201037_01
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
78
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
     1
// Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
     2
// All rights reserved.
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
     7
//
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
     8
// Initial Contributors:
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    10
//
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    11
// Contributors:
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    12
//
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    13
// Description:
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    14
// Connection Provider Factory
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    15
//  (control plane)
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    16
//
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    17
//
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    18
//  This is a 3-plane comms layer implementation example, which has been customised to be a test layer which gobbles and releases ESOCK MBUFs.
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    19
//  The MBuf gobbling functionality can be disabled by undefining the macro SYMBIAN_COMMSFW_MBUF_GOBBLER which is specified in mbufgobblerproviders.mmp.
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    20
//  When SYMBIAN_COMMSFW_MBUF_GOBBLER is undefined, the source code specified by mbufgobblerproviders.mmp becomes a pass through layer i.e. it passes the data
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    21
//  through to the layer above or below without altering it. This makes it useful as a starting point for implementing your own layers / providers;
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    22
//  useful documentation on how to customise your own passthrough layer can be found in ..\docs\MbufGobblerLayer.doc
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    23
//
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    24
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    25
/**
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    26
 @file
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    27
 @internalComponent
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    28
*/
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    29
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    30
#ifndef CMBUFGOBBLERCONNPROVIDERFACTORY_H
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    31
#define CMBUFGOBBLERCONNPROVIDERFACTORY_H
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    32
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    33
// INCLUDES
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    34
#include <e32std.h>
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    35
#include <e32base.h>
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    36
#include <comms-infras/ss_connprov.h>
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    37
#include <comms-infras/ss_nodemessages_legacy.h>
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    38
#include <comms-infras/ss_legacyinterfaces.h>
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    39
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    40
#include "mbufgobbleruids.h"
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    41
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    42
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    43
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    44
// CLASS DECLARATION
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    45
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    46
/**
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    47
 *  CMbufGobblerConnProviderFactory
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    48
 * 
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    49
 */
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    50
class CMbufGobblerConnProviderFactory : public ESock::CConnectionProviderFactoryBase
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    51
	{
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    52
public:
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    53
	// Constructors and destructor
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    54
	enum { iUid = EMbufGobblerCPrUid };
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    55
	static CMbufGobblerConnProviderFactory* NewL(TAny* aParentContainer);
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    56
	/**
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    57
	 * Destructor.
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    58
	 */
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    59
	~CMbufGobblerConnProviderFactory();
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    60
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    61
protected: //from CConnectionProviderFactoryBase
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    62
	virtual ESock::ACommsFactoryNodeId* DoCreateObjectL(ESock::TFactoryQueryBase& /* aQuery */);
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    63
	virtual void CMbufGobblerConnProviderFactory::EnumerateConnectionsL(RPointerArray<ESock::TSourcedConnectionInfo>& aConnectionInfoPtrArray);
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    64
	
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    65
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    66
private: //class not intended for derivation 
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    67
	/**
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    68
	 * Constructor for performing 1st stage construction
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    69
	 */
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    70
	CMbufGobblerConnProviderFactory(TUid aFactoryId, ESock::CConnectionFactoryContainer& aParentContainer);
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    71
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    72
	/**
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    73
	 * EPOC default constructor for performing 2nd stage construction
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    74
	 */
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    75
	void ConstructL();
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    76
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    77
	};
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    78
dd4909eb54cd 201037_01
hgs
parents:
diff changeset
    79
#endif // CMBUFGOBBLERCONNPROVIDERFACTORY_H