realtimenetprots/sipfw/SIP/ConnectionMgr/inc/MSigComp.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Fri, 11 Jun 2010 14:01:23 +0300
changeset 27 740ceea8e153
parent 0 307788aac0a8
permissions -rw-r--r--
Revision: 201021 Kit: 2010123

/*
* Copyright (c) 2005-2009 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:
* Name          : MSigComp.h
* Part of       : ConnectionMgr
* Version       : SIP/4.0 
*
*/




/**
 @internalComponent
*/
#ifndef MSIGCOMP_H
#define MSIGCOMP_H

#include <e32std.h>


class MSigComp
	{
public:

    /**
     * Destructor.
	 */
	virtual ~MSigComp () {}

    /**
     * Checks if signalling compression is installed.
     *
     * @returns ETrue if installed, EFalse otherwise.
	 */
    virtual TBool IsSupported () const = 0;

    /**
     * After calling this function ConnectionMgr always uses
     * signalling compression for requests sent with 
     * the returned compartment ID.
     * Multiple users can share a compartment to a 
     * next hop identified by TInetAddr.
     * The compartment ID and the TInetAddr are bound together 
     * when the first request towards the TInetAddr is sent.
     * Multiple comparment IDs can point to the same TInetAddr.
     *
     * @param aIapId the IAP used for the compartment
     *
     * @returns a generated ID for the compartment
	 */
    virtual TUint32 CreateCompartmentL(TUint32 aIapId) = 0;

    /**
     * Removes compartment identified by the compartment ID
     *
     * @param aCompartmentId the compartment ID
	 */
    virtual void RemoveCompartment(TUint32 aCompartmentId) = 0;

	/**
     * The function returns count of compartments
     *
     * @returns	count of compartments
     */
	virtual TInt CompartmentCount() = 0;

	/**
     * If the compartment has been previously used for decompressing,
     * resets the compartment. If not, deletes the compartment. 
     *
     * @param aCompartmentId the compartment ID
     */
	virtual void SendFailedL(TUint32 aCompartmentId) = 0;
	};

#endif // MSIGCOMP_H

// End of File