Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
2 * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
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".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
15 * Name : sipfromheader.h
17 * Interface : SDK API, SIP Codec API
25 #ifndef CSIPFROMHEADER_H
26 #define CSIPFROMHEADER_H
29 #include "sipfromtoheaderbase.h"
30 #include "_sipcodecdefs.h"
37 * Class provides functions for setting and getting SIP "From" header.
41 class CSIPFromHeader : public CSIPFromToHeaderBase
43 public: // Constructors and destructor
46 * Constructs a CSIPFromHeader from textual representation
47 * of the header's value part.
48 * @param aValue a value part of a "From"-header (e.g. "<user@host>...")
49 * @return a new instance of CSIPFromHeader
51 IMPORT_C static CSIPFromHeader* DecodeL(const TDesC8& aValue);
54 * Creates a new instance of CSIPFromHeader
55 * @pre aSIPAddress != 0
56 * @param aSIPAddress a name-address, the ownership is transferred.
57 * @return a new instance of CSIPFromHeader
59 IMPORT_C static CSIPFromHeader* NewL(CSIPAddress* aSIPAddress);
62 * Creates a new instance of CSIPFromHeader and puts it to CleanupStack
63 * @pre aSIPAddress != 0
64 * @param aSIPAddress a name-address, the ownership is transferred,
65 * @return a new instance of CSIPFromHeader
67 IMPORT_C static CSIPFromHeader* NewLC(CSIPAddress* aSIPAddress);
70 * Creates a deep-copy of a CSIPFromToHeaderBase
71 * Note that this function can be used for creating a From-header
72 * using an existing To-header.
73 * @param aHeader CSIPFromToHeaderBase to be copied
74 * @return a new instance of CSIPFromHeader
76 IMPORT_C static CSIPFromHeader*
77 NewL(const CSIPFromToHeaderBase& aHeader);
80 * Creates a deep-copy of a CSIPFromToHeaderBase and
81 * puts it to CleanupStack
82 * Note that this function can be used for creating a From-header
83 * using an existing To-header.
84 * @param aHeader CSIPFromToHeaderBase to be copied
85 * @return a new instance of CSIPFromHeader
87 IMPORT_C static CSIPFromHeader*
88 NewLC(const CSIPFromToHeaderBase& aHeader);
91 * Destructor, deletes the resources of CSIPFromHeader.
93 IMPORT_C ~CSIPFromHeader();
96 public: // New functions
99 * Constructs an instance of a CSIPFromHeader from a RReadStream
100 * @param aReadStream a stream containing the value of the
101 * externalized object (header name not included).
102 * @return an instance of a CSIPFromHeader
104 IMPORT_C static CSIPHeaderBase*
105 InternalizeValueL(RReadStream& aReadStream);
108 public: // From CSIPHeaderBase
111 * From CSIPHeaderBase CloneL
113 IMPORT_C CSIPHeaderBase* CloneL() const;
116 * From CSIPHeaderBase Name
118 IMPORT_C RStringF Name() const;
121 public: // From CSIPHeaderBase, for internal use
126 RStringF CompactName() const;
128 public: // New functions, for internal use
130 static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
132 private: // Constructors
137 #endif // CSIPFROMHEADER_H