commsfwutils/commsbufs/mbufgobblerlayer/inc/mbufgobblerconnprovider.h
branchRCL_3
changeset 84 486e9e9c45a7
parent 76 576874e13a2c
child 85 7c25be0307fe
equal deleted inserted replaced
76:576874e13a2c 84:486e9e9c45a7
     1 // Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // Connection Provider
       
    15 //  (control plane)
       
    16 //
       
    17 //
       
    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.
       
    19 //  The MBuf gobbling functionality can be disabled by undefining the macro SYMBIAN_COMMSFW_MBUF_GOBBLER which is specified in mbufgobblerproviders.mmp.
       
    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
       
    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;
       
    22 //  useful documentation on how to customise your own passthrough layer can be found in ..\docs\MbufGobblerLayer.doc
       
    23 //
       
    24 
       
    25 /**
       
    26  @file
       
    27  @internalComponent
       
    28 */
       
    29 
       
    30 #ifndef CMBUFGOBBLERCONNPROVIDER_H
       
    31 #define CMBUFGOBBLERCONNPROVIDER_H
       
    32 
       
    33 // INCLUDES
       
    34 #include <e32std.h>
       
    35 #include <e32base.h>
       
    36 #include <comms-infras/corecpr.h>
       
    37 #include "mbufgobblertestflags.h"
       
    38 
       
    39 
       
    40 
       
    41 
       
    42 // CLASS DECLARATION
       
    43 
       
    44 /**
       
    45  *  CMbufGobblerConnProvider
       
    46  * 
       
    47  */
       
    48 
       
    49 //comment on diffeent super class options e.g. CMobilityConnectionProvider
       
    50 class ESock::CConnectionProviderFactoryBase;
       
    51 class CMbufGobblerConnProvider : public CCoreConnectionProvider
       
    52 	{
       
    53 public:
       
    54 	// Constructors and destructor
       
    55 	static CMbufGobblerConnProvider* NewL(ESock::CConnectionProviderFactoryBase& aFactory);
       
    56 
       
    57 	/**
       
    58 	 * Destructor.
       
    59 	 */
       
    60 	~CMbufGobblerConnProvider();
       
    61 
       
    62 	
       
    63 protected: //from CCoreConnectionProvider
       
    64 	void ReceivedL(const Messages::TRuntimeCtxId& aSender, const Messages::TNodeId& aRecipient, Messages::TSignatureBase& aMessage);
       
    65 
       
    66 private:
       
    67 
       
    68 	/**
       
    69 	 * Constructor for performing 1st stage construction
       
    70 	 */
       
    71 	CMbufGobblerConnProvider(ESock::CConnectionProviderFactoryBase& aFactory);
       
    72 
       
    73 	/**
       
    74 	 * EPOC default constructor for performing 2nd stage construction
       
    75 	 */
       
    76 	void ConstructL();
       
    77 	
       
    78 private:
       
    79 	TInt iClientCount; //holds count of clients that node is joined with
       
    80 
       
    81 	MBUFGOBBLER_TEST_DATA
       
    82 	};
       
    83 
       
    84 #endif // CMBUFGOBBLERCONNPROVIDER_H