epoc32/include/mw/sdpcodecstringpool.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/sdpcodecstringpool.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
* Name          : SdpCodecStringPool.h
williamr@2
    16
* Part of       : SDP Codec
williamr@2
    17
* Interface     : SDK API, SDP Codec API
williamr@2
    18
* Version       : 1.0
williamr@2
    19
*
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
#ifndef SDPCODECSTRINGPOOL_H
williamr@2
    25
#define SDPCODECSTRINGPOOL_H
williamr@2
    26
williamr@2
    27
//  INCLUDES
williamr@2
    28
#include <e32base.h>
williamr@2
    29
#include "_sdpdefs.h"
williamr@2
    30
#include <stringpool.h>
williamr@2
    31
williamr@2
    32
class CSdpCodecStringPool;
williamr@2
    33
williamr@2
    34
// CLASS DECLARATION
williamr@2
    35
/**
williamr@2
    36
* @publishedAll
williamr@2
    37
* @released
williamr@2
    38
*
williamr@2
    39
* This class defines string pool for SDP Codec.
williamr@2
    40
* The client of SDP Codec must call OpenL() before 
williamr@2
    41
* invoking any function of SDP Codec classes.
williamr@2
    42
* The client must close the string pool when finished using
williamr@2
    43
* SDP Codec classes.
williamr@2
    44
*
williamr@2
    45
* Note: the client must not close the string pool while
williamr@2
    46
*       using SDP Codec classes.
williamr@2
    47
* 
williamr@2
    48
* @lib sdpcodec.lib
williamr@2
    49
*/
williamr@2
    50
class SdpCodecStringPool
williamr@2
    51
	{
williamr@2
    52
public: // Constructors and destructor
williamr@2
    53
 		
williamr@2
    54
	/**
williamr@2
    55
	* Opens SDP Codec string pool.
williamr@2
    56
	*
williamr@2
    57
    * @leave KErrAlreadyExists if pool already exists in TLS.
williamr@2
    58
	*/
williamr@2
    59
	IMPORT_C static void OpenL();
williamr@2
    60
williamr@2
    61
	/**
williamr@2
    62
	* Closes SDP Codec string pool.
williamr@2
    63
	*
williamr@2
    64
	*/
williamr@2
    65
	IMPORT_C static void Close(); 
williamr@2
    66
williamr@2
    67
public: 
williamr@2
    68
	
williamr@2
    69
	/**
williamr@2
    70
	* Gets the string pool used by SDP Codec.
williamr@2
    71
	*
williamr@2
    72
	* @return RStringPool: A handle to a string pool
williamr@2
    73
	* @leave KErrSdpCodecStringPool if the pool is not opened.
williamr@2
    74
	*
williamr@2
    75
	*/
williamr@2
    76
	IMPORT_C static RStringPool StringPoolL();
williamr@2
    77
williamr@2
    78
	/**
williamr@2
    79
	* Gets the string table used by SDP Codec.
williamr@2
    80
	*
williamr@2
    81
	* @return TStringTable&: The string pool table
williamr@2
    82
	* @leave KErrSdpCodecStringPool if the pool is not opened.
williamr@2
    83
	*
williamr@2
    84
	*/
williamr@2
    85
	IMPORT_C static const TStringTable& StringTableL();
williamr@2
    86
	};
williamr@2
    87
williamr@2
    88
#endif