diff -r c9776eadbffd -r dd4909eb54cd commsfwutils/commsbufs/mbufgobblerlayer/inc/mbufgobblerpubsub.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/commsfwutils/commsbufs/mbufgobblerlayer/inc/mbufgobblerpubsub.h Thu Sep 23 10:22:55 2010 +0100 @@ -0,0 +1,70 @@ +// Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). +// All rights reserved. +// This component and the accompanying materials are made available +// under the terms of "Eclipse Public License v1.0" +// which accompanies this distribution, and is available +// at the URL "http://www.eclipse.org/legal/epl-v10.html". +// +// Initial Contributors: +// Nokia Corporation - initial contribution. +// +// Contributors: +// +// Description: +// Defines the series of requests which a ESOCK client can send to the MBuf Gobbler using +// the publish and subscribe attribute EMBufGobbler. +// +// A test ESOCK client can deplete all the MBufs from the MBuf pool as follows: +// +// TInt result = RProperty::Set(TUid::Uid(EMBufGobbler ), EAdjustNumberOfMBufsRemainingInPool , EGobbleAllMBufs); +// +// Issuing this command should cause a socket read or write request to fail due to MBuf pool exhaustion. +// +// Subsequently a test ESOCK client can return all the MBufs it has taken from the pool as follows: +// +// result = RProperty::Set(TUid::Uid(EMBufGobbler), EAdjustNumberOfMBufsRemainingInPool, EReleaseAllMBufs); +// +// After taking all the MBufs from the pool, an ESOCK test client can also return a single MBuf back to the pool as follows: +// +// result = RProperty::Set(TUid::Uid(EMBufGobbler), EAdjustNumberOfMBufsRemainingInPool, EReleaseASingleMBuf); +// +// +// This is a 3-plane comms layer implementation example, which has been customised to be a test layer which gobbles and releases ESOCK MBUFs. +// The MBuf gobbling functionality can be disabled by undefining the macro SYMBIAN_COMMSFW_MBUF_GOBBLER which is specified in mbufgobblerproviders.mmp. +// 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 +// through to the layer above or below without altering it. This makes it useful as a starting point for implementing your own layers / providers; +// useful documentation on how to customise your own passthrough layer can be found in ..\docs\MbufGobblerLayer.doc +// + +/** + @file + @internalComponent +*/ + +#ifndef MBUFGOBBLERPUBSUB_H +#define MBUFGOBBLERPUBSUB_H + + +#ifdef SYMBIAN_COMMSFW_MBUF_GOBBLER + +enum +{ +EMBufGobbler = 0x10272F97 +}; + +enum +{ +EAdjustNumberOfMBufsRemainingInPool = 1 +}; + +enum +{ +EGobbleAllMBufs, +EReleaseAllMBufs, +EReleaseASingleMBuf +}; + +#endif + +#endif +