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@4
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
williamr@2
|
6 |
* which accompanies this distribution, and is available
|
williamr@4
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.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 : siprefertoheader.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 CSIPREFERTOHEADER_H
|
williamr@2
|
26 |
#define CSIPREFERTOHEADER_H
|
williamr@2
|
27 |
|
williamr@2
|
28 |
// INCLUDES
|
williamr@2
|
29 |
#include "sipaddressheaderbase.h"
|
williamr@2
|
30 |
|
williamr@2
|
31 |
// FORWARD DECLARATIONS
|
williamr@2
|
32 |
class CSIPAddress;
|
williamr@2
|
33 |
class CSIPHeaderGenericParams;
|
williamr@2
|
34 |
|
williamr@2
|
35 |
// CLASS DECLARATION
|
williamr@2
|
36 |
/**
|
williamr@2
|
37 |
* @publishedAll
|
williamr@2
|
38 |
* @released
|
williamr@2
|
39 |
*
|
williamr@2
|
40 |
* Class provides functions for setting and getting parameters in SIP
|
williamr@2
|
41 |
* "Refer-To" header.
|
williamr@2
|
42 |
*
|
williamr@2
|
43 |
* @lib sipcodec.lib
|
williamr@2
|
44 |
*/
|
williamr@2
|
45 |
class CSIPReferToHeader : public CSIPAddressHeaderBase
|
williamr@2
|
46 |
{
|
williamr@2
|
47 |
public: // Constructors and destructor
|
williamr@2
|
48 |
|
williamr@2
|
49 |
/**
|
williamr@2
|
50 |
* Constructs a CSIPReferToHeader from textual representation
|
williamr@2
|
51 |
* of the header's value part.
|
williamr@2
|
52 |
* @param aValue a value part of a "Refer-To"-header
|
williamr@2
|
53 |
* (e.g. "User <user@host>")
|
williamr@2
|
54 |
* @return a new instance of CSIPReferToHeader
|
williamr@2
|
55 |
*/
|
williamr@2
|
56 |
IMPORT_C static CSIPReferToHeader* DecodeL(const TDesC8& aValue);
|
williamr@2
|
57 |
|
williamr@2
|
58 |
/**
|
williamr@2
|
59 |
* Creates a new instance of CSIPReferToHeader
|
williamr@2
|
60 |
* @pre aSIPAddress != 0
|
williamr@2
|
61 |
* @param aSIPAddress a name-address, the ownership is transferred.
|
williamr@2
|
62 |
* @return a new instance of CSIPReferToHeader
|
williamr@2
|
63 |
*/
|
williamr@2
|
64 |
IMPORT_C static CSIPReferToHeader* NewL(CSIPAddress* aSIPAddress);
|
williamr@2
|
65 |
|
williamr@2
|
66 |
/**
|
williamr@2
|
67 |
* Creates a new instance of CSIPReferToHeader and puts it to CleanupStack
|
williamr@2
|
68 |
* @pre aSIPAddress != 0
|
williamr@2
|
69 |
* @param aSIPAddress a name-address, the ownership is transferred,
|
williamr@2
|
70 |
* @return a new instance of CSIPReferToHeader
|
williamr@2
|
71 |
*/
|
williamr@2
|
72 |
IMPORT_C static CSIPReferToHeader* NewLC(CSIPAddress* aSIPAddress);
|
williamr@2
|
73 |
|
williamr@2
|
74 |
/**
|
williamr@2
|
75 |
* Destructor, deletes the resources of CSIPReferToHeader.
|
williamr@2
|
76 |
*/
|
williamr@2
|
77 |
IMPORT_C virtual ~CSIPReferToHeader();
|
williamr@2
|
78 |
|
williamr@2
|
79 |
|
williamr@2
|
80 |
public: // New functions
|
williamr@2
|
81 |
|
williamr@2
|
82 |
/**
|
williamr@2
|
83 |
* Constructs an instance of a CSIPReferToHeader from a RReadStream
|
williamr@2
|
84 |
* @param aReadStream a stream containing the value of the
|
williamr@2
|
85 |
* externalized object (header name not included).
|
williamr@2
|
86 |
* @return an instance of a CSIPReferToHeader
|
williamr@2
|
87 |
*/
|
williamr@2
|
88 |
IMPORT_C static CSIPHeaderBase* InternalizeValueL(RReadStream& aReadStream);
|
williamr@2
|
89 |
|
williamr@2
|
90 |
|
williamr@2
|
91 |
public: // From CSIPHeaderBase
|
williamr@2
|
92 |
|
williamr@2
|
93 |
/**
|
williamr@2
|
94 |
* From CSIPHeaderBase CloneL
|
williamr@2
|
95 |
*/
|
williamr@2
|
96 |
IMPORT_C CSIPHeaderBase* CloneL() const;
|
williamr@2
|
97 |
|
williamr@2
|
98 |
/**
|
williamr@2
|
99 |
* From CSIPHeaderBase Name
|
williamr@2
|
100 |
*/
|
williamr@2
|
101 |
IMPORT_C RStringF Name() const;
|
williamr@2
|
102 |
|
williamr@2
|
103 |
|
williamr@2
|
104 |
public: // From CSIPHeaderBase, for internal use
|
williamr@2
|
105 |
|
williamr@2
|
106 |
/**
|
williamr@2
|
107 |
* @internalComponent
|
williamr@2
|
108 |
*/
|
williamr@2
|
109 |
TBool HasCompactName() const;
|
williamr@2
|
110 |
|
williamr@2
|
111 |
/**
|
williamr@2
|
112 |
* @internalComponent
|
williamr@2
|
113 |
*/
|
williamr@2
|
114 |
RStringF CompactName() const;
|
williamr@2
|
115 |
|
williamr@2
|
116 |
/**
|
williamr@2
|
117 |
* @internalComponent
|
williamr@2
|
118 |
*/
|
williamr@2
|
119 |
TPreferredPlace PreferredPlaceInMessage() const;
|
williamr@2
|
120 |
|
williamr@2
|
121 |
public: // New functions, for internal use
|
williamr@2
|
122 |
|
williamr@2
|
123 |
static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
|
williamr@2
|
124 |
|
williamr@2
|
125 |
private: // Constructors
|
williamr@2
|
126 |
|
williamr@2
|
127 |
CSIPReferToHeader();
|
williamr@2
|
128 |
|
williamr@2
|
129 |
private: // For testing purposes
|
williamr@4
|
130 |
#ifdef CPPUNIT_TEST
|
williamr@4
|
131 |
friend class CSIPReferToHeaderTest;
|
williamr@4
|
132 |
#endif
|
williamr@2
|
133 |
};
|
williamr@2
|
134 |
|
williamr@2
|
135 |
#endif // end of CSIPREFERTOHEADER_H
|
williamr@2
|
136 |
|
williamr@2
|
137 |
// End of File
|