author | William Roberts <williamr@symbian.org> |
Tue, 16 Mar 2010 16:12:26 +0000 | |
branch | Symbian2 |
changeset 2 | 2fe1408b6811 |
parent 0 | 061f57f2323e |
permissions | -rw-r--r-- |
williamr@2 | 1 |
/* |
williamr@2 | 2 |
* Copyright (c) 2004-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 : siptokenheaderbase.h |
williamr@2 | 16 |
* Part of : SIP Codec |
williamr@2 | 17 |
* Interface : SDK API, SIP Codec API |
williamr@2 | 18 |
* Version : SIP/4.0 |
williamr@2 | 19 |
* |
williamr@2 | 20 |
*/ |
williamr@2 | 21 |
|
williamr@2 | 22 |
|
williamr@2 | 23 |
|
williamr@2 | 24 |
|
williamr@2 | 25 |
#ifndef CSIPTOKENHEADERBASE_H |
williamr@2 | 26 |
#define CSIPTOKENHEADERBASE_H |
williamr@2 | 27 |
|
williamr@2 | 28 |
// INCLUDES |
williamr@2 | 29 |
#include "sipheaderbase.h" |
williamr@2 | 30 |
#include "_sipcodecdefs.h" |
williamr@2 | 31 |
|
williamr@2 | 32 |
// CLASS DECLARATION |
williamr@2 | 33 |
/** |
williamr@2 | 34 |
* @publishedAll |
williamr@2 | 35 |
* @released |
williamr@2 | 36 |
* |
williamr@2 | 37 |
* A base class for SIP headers having form "Name: token *(COMMA token)" |
williamr@2 | 38 |
* |
williamr@2 | 39 |
* @lib sipcodec.lib |
williamr@2 | 40 |
*/ |
williamr@2 | 41 |
class CSIPTokenHeaderBase : public CSIPHeaderBase |
williamr@2 | 42 |
{ |
williamr@2 | 43 |
public: // Constructors and destructor |
williamr@2 | 44 |
|
williamr@2 | 45 |
/** |
williamr@2 | 46 |
* Destructor, deletes the resources of CSIPTokenHeaderBase. |
williamr@2 | 47 |
*/ |
williamr@2 | 48 |
IMPORT_C virtual ~CSIPTokenHeaderBase(); |
williamr@2 | 49 |
|
williamr@2 | 50 |
|
williamr@2 | 51 |
public: // New functions |
williamr@2 | 52 |
|
williamr@2 | 53 |
/** |
williamr@2 | 54 |
* Sets the header value as a token |
williamr@2 | 55 |
* @param aValue a value to set |
williamr@2 | 56 |
*/ |
williamr@2 | 57 |
IMPORT_C void SetValueL(RStringF aValue); |
williamr@2 | 58 |
|
williamr@2 | 59 |
/** |
williamr@2 | 60 |
* Gets the header value as a token |
williamr@2 | 61 |
* @return the header value |
williamr@2 | 62 |
*/ |
williamr@2 | 63 |
IMPORT_C RStringF Value() const; |
williamr@2 | 64 |
|
williamr@2 | 65 |
|
williamr@2 | 66 |
public: // From CSIPHeaderBase |
williamr@2 | 67 |
|
williamr@2 | 68 |
/** |
williamr@2 | 69 |
* From CSIPHeaderBase ToTextValueL |
williamr@2 | 70 |
*/ |
williamr@2 | 71 |
IMPORT_C HBufC8* ToTextValueL() const; |
williamr@2 | 72 |
|
williamr@2 | 73 |
|
williamr@2 | 74 |
public: // From CSIPHeaderBase, for internal use |
williamr@2 | 75 |
|
williamr@2 | 76 |
/** |
williamr@2 | 77 |
* @internalComponent |
williamr@2 | 78 |
*/ |
williamr@2 | 79 |
virtual TBool MoreThanOneAllowed() const; |
williamr@2 | 80 |
|
williamr@2 | 81 |
protected: // Constructors |
williamr@2 | 82 |
|
williamr@2 | 83 |
CSIPTokenHeaderBase(); |
williamr@2 | 84 |
CSIPTokenHeaderBase(const CSIPTokenHeaderBase& aHeader); |
williamr@2 | 85 |
void ConstructL(const TDesC8& aValue, TBool aEmptyValueAllowed=EFalse); |
williamr@2 | 86 |
void ConstructL(RStringF aValue, TBool aEmptyValueAllowed=EFalse); |
williamr@2 | 87 |
|
williamr@2 | 88 |
protected: // New functions |
williamr@2 | 89 |
|
williamr@2 | 90 |
void DoInternalizeValueL(RReadStream& aReadStream); |
williamr@2 | 91 |
|
williamr@2 | 92 |
protected: // Data |
williamr@2 | 93 |
|
williamr@2 | 94 |
/** |
williamr@2 | 95 |
* @internalComponent |
williamr@2 | 96 |
*/ |
williamr@2 | 97 |
RStringF iValue; |
williamr@2 | 98 |
|
williamr@2 | 99 |
private: // From CSIPHeaderBase |
williamr@2 | 100 |
|
williamr@2 | 101 |
void ExternalizeValueL(RWriteStream& aWriteStream) const; |
williamr@2 | 102 |
|
williamr@2 | 103 |
private: // New functions |
williamr@2 | 104 |
|
williamr@2 | 105 |
void SetValueL(const TDesC8& aValue); |
williamr@2 | 106 |
|
williamr@2 | 107 |
private: // For testing purposes |
williamr@2 | 108 |
|
williamr@2 | 109 |
UNIT_TEST(CSIPTokenHeaderBaseTest) |
williamr@2 | 110 |
}; |
williamr@2 | 111 |
|
williamr@2 | 112 |
#endif // CSIPTOKENHEADERBASE_H |
williamr@2 | 113 |
|
williamr@2 | 114 |
// End of File |