1 sdpcodecstringpool.h

     1 /*

     2 * Copyright (c) 2003-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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 * Name          : SdpCodecStringPool.h

    16 * Part of       : SDP Codec

    17 * Interface     : SDK API, SDP Codec API

    18 * Version       : 1.0

    19 *

    20 */

    21 

    22 

    23 

    24 #ifndef SDPCODECSTRINGPOOL_H

    25 #define SDPCODECSTRINGPOOL_H

    26 

    27 //  INCLUDES

    28 #include <e32base.h>

    29 #include "_sdpdefs.h"

    30 #include <stringpool.h>

    31 

    32 class CSdpCodecStringPool;

    33 

    34 // CLASS DECLARATION

    35 /**

    36 * @publishedAll

    37 * @released

    38 *

    39 * This class defines string pool for SDP Codec.

    40 * The client of SDP Codec must call OpenL() before 

    41 * invoking any function of SDP Codec classes.

    42 * The client must close the string pool when finished using

    43 * SDP Codec classes.

    44 *

    45 * Note: the client must not close the string pool while

    46 *       using SDP Codec classes.

    47 * 

    48 * @lib sdpcodec.lib

    49 */

    50 class SdpCodecStringPool

    51 	{

    52 public: // Constructors and destructor

    53  		

    54 	/**

    55 	* Opens SDP Codec string pool.

    56 	*

    57     * @leave KErrAlreadyExists if pool already exists in TLS.

    58 	*/

    59 	IMPORT_C static void OpenL();

    60 

    61 	/**

    62 	* Closes SDP Codec string pool.

    63 	*

    64 	*/

    65 	IMPORT_C static void Close(); 

    66 

    67 public: 

    68 	

    69 	/**

    70 	* Gets the string pool used by SDP Codec.

    71 	*

    72 	* @return RStringPool: A handle to a string pool

    73 	* @leave KErrSdpCodecStringPool if the pool is not opened.

    74 	*

    75 	*/

    76 	IMPORT_C static RStringPool StringPoolL();

    77 

    78 	/**

    79 	* Gets the string table used by SDP Codec.

    80 	*

    81 	* @return TStringTable&: The string pool table

    82 	* @leave KErrSdpCodecStringPool if the pool is not opened.

    83 	*

    84 	*/

    85 	IMPORT_C static const TStringTable& StringTableL();

    86 	};

    87 

    88 #endif