1 /*

     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 * Name          : MSigComp.h

    16 * Part of       : ConnectionMgr

    17 * Version       : SIP/4.0 

    18 *

    19 */

    20 

    21 

    22 

    23 

    24 /**

    25  @internalComponent

    26 */

    27 #ifndef MSIGCOMP_H

    28 #define MSIGCOMP_H

    29 

    30 #include <e32std.h>

    31 

    32 

    33 class MSigComp

    34 	{

    35 public:

    36 

    37     /**

    38      * Destructor.

    39 	 */

    40 	virtual ~MSigComp () {}

    41 

    42     /**

    43      * Checks if signalling compression is installed.

    44      *

    45      * @returns ETrue if installed, EFalse otherwise.

    46 	 */

    47     virtual TBool IsSupported () const = 0;

    48 

    49     /**

    50      * After calling this function ConnectionMgr always uses

    51      * signalling compression for requests sent with 

    52      * the returned compartment ID.

    53      * Multiple users can share a compartment to a 

    54      * next hop identified by TInetAddr.

    55      * The compartment ID and the TInetAddr are bound together 

    56      * when the first request towards the TInetAddr is sent.

    57      * Multiple comparment IDs can point to the same TInetAddr.

    58      *

    59      * @param aIapId the IAP used for the compartment

    60      *

    61      * @returns a generated ID for the compartment

    62 	 */

    63     virtual TUint32 CreateCompartmentL(TUint32 aIapId) = 0;

    64 

    65     /**

    66      * Removes compartment identified by the compartment ID

    67      *

    68      * @param aCompartmentId the compartment ID

    69 	 */

    70     virtual void RemoveCompartment(TUint32 aCompartmentId) = 0;

    71 

    72 	/**

    73      * The function returns count of compartments

    74      *

    75      * @returns	count of compartments

    76      */

    77 	virtual TInt CompartmentCount() = 0;

    78 

    79 	/**

    80      * If the compartment has been previously used for decompressing,

    81      * resets the compartment. If not, deletes the compartment. 

    82      *

    83      * @param aCompartmentId the compartment ID

    84      */

    85 	virtual void SendFailedL(TUint32 aCompartmentId) = 0;

    86 	};

    87 

    88 #endif // MSIGCOMP_H

    89 

    90 // End of File