|
1 /* |
|
2 * Copyright (c) 2009-2010 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 "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html." |
|
8 * Initial Contributors: |
|
9 * Nokia Corporation - initial contribution. |
|
10 * Contributors: |
|
11 * |
|
12 * Description: |
|
13 * MSRP Implementation |
|
14 * |
|
15 */ |
|
16 |
|
17 #ifndef CMSRPMESSAGEBASE_H |
|
18 #define CMSRPMESSAGEBASE_H |
|
19 |
|
20 // INCLUDES |
|
21 #include <e32base.h> |
|
22 #include <s32strm.h> |
|
23 |
|
24 // FORWARD DECLARATIONS |
|
25 class CMSRPFromPathHeader; |
|
26 class CMSRPToPathHeader; |
|
27 class CMSRPMessageIdHeader; |
|
28 class CMSRPByteRangeHeader; |
|
29 class CMSRPContentTypeHeader; |
|
30 class CMSRPFailureReportHeader; |
|
31 class CMSRPSuccessReportHeader; |
|
32 |
|
33 // CONSTANTS |
|
34 const TInt KMaxLengthOfShortMessage = 4096; |
|
35 const TInt KLengthOfMSRPSmallBuffer = 2048; |
|
36 |
|
37 // CLASS DECLARATION |
|
38 |
|
39 /** |
|
40 * @publishedAll |
|
41 * |
|
42 * Class provides functions for creation and manipulation of MSRP headers |
|
43 * |
|
44 * @lib msrpclient.lib |
|
45 */ |
|
46 class CMSRPMessageBase : public CBase |
|
47 { |
|
48 |
|
49 public: // Constructors and destructor |
|
50 |
|
51 /** |
|
52 * Destructor. |
|
53 */ |
|
54 IMPORT_C virtual ~CMSRPMessageBase(); |
|
55 |
|
56 public: // New functions |
|
57 |
|
58 /** |
|
59 * Sets/resets the recipient's To-Path header |
|
60 * @param aTo a To-Path header to be set, the ownership is transferred |
|
61 */ |
|
62 IMPORT_C void SetToPathHeader( CMSRPToPathHeader* aToPath ); |
|
63 |
|
64 /** |
|
65 * Gets the recipient's To-Path header |
|
66 * @return NULL if not present. Ownership is not |
|
67 * transferred. |
|
68 */ |
|
69 IMPORT_C const CMSRPToPathHeader* ToPathHeader() const; |
|
70 |
|
71 /** |
|
72 * Sets/resets the From-Path header |
|
73 * @param aFromPath From-Path header to be set, the ownership is transferred |
|
74 */ |
|
75 IMPORT_C void SetFromPathHeader( CMSRPFromPathHeader* aFromPath ); |
|
76 |
|
77 /** |
|
78 * Returns From-Path header |
|
79 * @return NULL if not present. Ownership is not |
|
80 * transferred. |
|
81 */ |
|
82 IMPORT_C const CMSRPFromPathHeader* FromPathHeader() const; |
|
83 |
|
84 /** |
|
85 * Sets/resets the Content-Type header |
|
86 * @param aContentType ContentType header to be set, the ownership is transferred |
|
87 */ |
|
88 IMPORT_C void SetContentTypeHeader( CMSRPContentTypeHeader* aContentType ); |
|
89 |
|
90 /** |
|
91 * Returns Content-Type header |
|
92 * @return NULL if not present. Ownership is not |
|
93 * transferred. |
|
94 */ |
|
95 IMPORT_C const CMSRPContentTypeHeader* ContentTypeHeader() const; |
|
96 |
|
97 /** |
|
98 * Sets/resets the Failure-Report header |
|
99 * @param aFailureReport FailureReport header to be set, the ownership is transferred |
|
100 */ |
|
101 IMPORT_C void SetFailureReportHeader( CMSRPFailureReportHeader* aFailureReport ); |
|
102 |
|
103 /** |
|
104 * Returns Failure-Report header |
|
105 * @return NULL if not present. Ownership is not |
|
106 * transferred. |
|
107 */ |
|
108 IMPORT_C const CMSRPFailureReportHeader* FailureReportHeader() const; |
|
109 |
|
110 /** |
|
111 * Sets/resets the Success-Report header |
|
112 * @param aSuccessReport SuccessReport header to be set, the ownership is transferred |
|
113 */ |
|
114 IMPORT_C void SetSuccessReportHeader( CMSRPSuccessReportHeader* aSuccessReport ); |
|
115 |
|
116 /** |
|
117 * Returns Success-Report header |
|
118 * @return NULL if not present. Ownership is not |
|
119 * transferred. |
|
120 */ |
|
121 IMPORT_C const CMSRPSuccessReportHeader* SuccessReportHeader() const; |
|
122 |
|
123 /** |
|
124 * Sets/resets the Message-ID header |
|
125 * @param aMessageId MessageId header to be set, the ownership is transferred |
|
126 */ |
|
127 IMPORT_C void SetMessageIdHeader( CMSRPMessageIdHeader* aMessageId ); |
|
128 |
|
129 /** |
|
130 * Returns Message-ID header |
|
131 * @return NULL if not present. Ownership is not |
|
132 * transferred. |
|
133 */ |
|
134 IMPORT_C const CMSRPMessageIdHeader* MessageIdHeader() const; |
|
135 |
|
136 /** |
|
137 * Sets/resets the Byte-Range header |
|
138 * @param aByteRange ByteRange header to be set, the ownership is transferred |
|
139 */ |
|
140 IMPORT_C void SetByteRangeHeader( CMSRPByteRangeHeader* aByteRange ); |
|
141 |
|
142 /** |
|
143 * Returns Byte-Range header |
|
144 * @return NULL if not present. Ownership is not |
|
145 * transferred. |
|
146 */ |
|
147 IMPORT_C const CMSRPByteRangeHeader* ByteRangeHeader() const; |
|
148 |
|
149 /** |
|
150 * Writes the object to a RWriteStream |
|
151 * @param aWriteStream a stream where the object is to be externalized |
|
152 */ |
|
153 virtual void ExternalizeL( RWriteStream& aWriteStream ) = 0; |
|
154 |
|
155 protected: |
|
156 |
|
157 /** |
|
158 * Constructor. |
|
159 */ |
|
160 CMSRPMessageBase(); |
|
161 |
|
162 protected: // Data |
|
163 |
|
164 // Headers |
|
165 // For setting and getting MSRP "From-Path" header field |
|
166 CMSRPFromPathHeader* iFromPath; |
|
167 // For setting and getting MSRP "To-Path" header field |
|
168 CMSRPToPathHeader* iToPath; |
|
169 // For setting and getting MSRP "Message-ID" header field |
|
170 CMSRPMessageIdHeader* iMessageId; |
|
171 // For setting and getting MSRP "Byte-Range" header field |
|
172 CMSRPByteRangeHeader* iByteRange; |
|
173 // For setting and getting MSRP "Content-Type" header field |
|
174 CMSRPContentTypeHeader* iContentType; |
|
175 // For setting and getting MSRP "Failure-Report" header field |
|
176 CMSRPFailureReportHeader* iFailureReport; |
|
177 // For setting and getting MSRP "Success-Report" header field |
|
178 CMSRPSuccessReportHeader* iSuccessReport; |
|
179 |
|
180 }; |
|
181 |
|
182 #endif // CMSRPMESSAGEBASE_H |
|
183 |
|
184 // End of File |