williamr@2: /*
williamr@2: * Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: * Name          : SdpCodecStringPool.h
williamr@2: * Part of       : SDP Codec
williamr@2: * Interface     : SDK API, SDP Codec API
williamr@2: * Version       : 1.0
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef SDPCODECSTRINGPOOL_H
williamr@2: #define SDPCODECSTRINGPOOL_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <e32base.h>
williamr@2: #include "_sdpdefs.h"
williamr@2: #include <stringpool.h>
williamr@2: 
williamr@2: class CSdpCodecStringPool;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: * @publishedAll
williamr@2: * @released
williamr@2: *
williamr@2: * This class defines string pool for SDP Codec.
williamr@2: * The client of SDP Codec must call OpenL() before 
williamr@2: * invoking any function of SDP Codec classes.
williamr@2: * The client must close the string pool when finished using
williamr@2: * SDP Codec classes.
williamr@2: *
williamr@2: * Note: the client must not close the string pool while
williamr@2: *       using SDP Codec classes.
williamr@2: * 
williamr@2: * @lib sdpcodec.lib
williamr@2: */
williamr@2: class SdpCodecStringPool
williamr@2: 	{
williamr@2: public: // Constructors and destructor
williamr@2:  		
williamr@2: 	/**
williamr@2: 	* Opens SDP Codec string pool.
williamr@2: 	*
williamr@2:     * @leave KErrAlreadyExists if pool already exists in TLS.
williamr@2: 	*/
williamr@2: 	IMPORT_C static void OpenL();
williamr@2: 
williamr@2: 	/**
williamr@2: 	* Closes SDP Codec string pool.
williamr@2: 	*
williamr@2: 	*/
williamr@2: 	IMPORT_C static void Close(); 
williamr@2: 
williamr@2: public: 
williamr@2: 	
williamr@2: 	/**
williamr@2: 	* Gets the string pool used by SDP Codec.
williamr@2: 	*
williamr@2: 	* @return RStringPool: A handle to a string pool
williamr@2: 	* @leave KErrSdpCodecStringPool if the pool is not opened.
williamr@2: 	*
williamr@2: 	*/
williamr@2: 	IMPORT_C static RStringPool StringPoolL();
williamr@2: 
williamr@2: 	/**
williamr@2: 	* Gets the string table used by SDP Codec.
williamr@2: 	*
williamr@2: 	* @return TStringTable&: The string pool table
williamr@2: 	* @leave KErrSdpCodecStringPool if the pool is not opened.
williamr@2: 	*
williamr@2: 	*/
williamr@2: 	IMPORT_C static const TStringTable& StringTableL();
williamr@2: 	};
williamr@2: 
williamr@2: #endif