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 // Defines the series of requests which a ESOCK client can send to the MBuf Gobbler using

    15 // the publish and subscribe attribute EMBufGobbler.

    16 //

    17 // A test ESOCK client can deplete all the MBufs from the MBuf pool as follows:

    18 //

    19 //    TInt result = RProperty::Set(TUid::Uid(EMBufGobbler ), EAdjustNumberOfMBufsRemainingInPool , EGobbleAllMBufs);

    20 //

    21 // Issuing this command should cause a socket read or write request to fail due to MBuf pool exhaustion.

    22 //

    23 // Subsequently a test ESOCK client can return all the MBufs it has taken from the pool as follows:

    24 //

    25 //   result = RProperty::Set(TUid::Uid(EMBufGobbler), EAdjustNumberOfMBufsRemainingInPool, EReleaseAllMBufs);  

    26 //

    27 // After taking all the MBufs from the pool, an ESOCK test client can also return a single MBuf back to the pool as follows:

    28 //

    29 //   result = RProperty::Set(TUid::Uid(EMBufGobbler), EAdjustNumberOfMBufsRemainingInPool, EReleaseASingleMBuf);

    30 //

    31 /**

    32  @file

    33  @internalComponent

    34 */

    35 

    36 #ifndef MBUFGOBBLERPUBSUB_H

    37 #define MBUFGOBBLERPUBSUB_H

    38 

    39 

    40 

    41 

    42 enum

    43 {

    44 EMBufGobbler = 0x10272F97

    45 };

    46 

    47 enum

    48 {

    49 EAdjustNumberOfMBufsRemainingInPool = 1

    50 };    

    51     

    52 enum

    53 {

    54 EGobbleAllMBufs,

    55 EReleaseAllMBufs,

    56 EReleaseASingleMBuf

    57 };

    58 

    59 #endif

    60