|
1 /* |
|
2 * Copyright (c) 2004-2009 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 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * Name : MTransactionHeaders.h |
|
16 * Part of : TransactionUser |
|
17 * Version : SIP/4.0 |
|
18 * |
|
19 */ |
|
20 |
|
21 |
|
22 |
|
23 |
|
24 /** |
|
25 @internalComponent |
|
26 */ |
|
27 |
|
28 |
|
29 #ifndef MTRANSACTIONHEADERS_H |
|
30 #define MTRANSACTIONHEADERS_H |
|
31 |
|
32 #include <e32base.h> |
|
33 |
|
34 class CURIContainer; |
|
35 class CSIPToHeader; |
|
36 class CSIPFromHeader; |
|
37 class CSIPCallIDHeader; |
|
38 class CSIPRouteHeaderBase; |
|
39 class CSIPContactHeader; |
|
40 |
|
41 |
|
42 /** |
|
43 * This class is used to wrap together the SIP headers which can be requested |
|
44 * by upper subsystems. |
|
45 * If MTransactionHeaders is pushed into CleanupStack, TCleanupItem has to be |
|
46 * used. |
|
47 */ |
|
48 class MTransactionHeaders |
|
49 { |
|
50 public: |
|
51 virtual ~MTransactionHeaders() {} |
|
52 |
|
53 |
|
54 /** |
|
55 * Gets the Request-URI |
|
56 * |
|
57 * @pre |
|
58 * @post |
|
59 * |
|
60 * @see |
|
61 * |
|
62 * @return value Request-URI, or NULL if it doesn't exist. |
|
63 * The ownership is transferred |
|
64 */ |
|
65 virtual CURIContainer* RequestURI() = 0; |
|
66 |
|
67 |
|
68 /** |
|
69 * Gets the To-header |
|
70 * |
|
71 * @pre |
|
72 * @post |
|
73 * |
|
74 * @see |
|
75 * |
|
76 * @return value To-header, or NULL if To-header doesn't exist. |
|
77 * The ownership is transferred |
|
78 */ |
|
79 virtual CSIPToHeader* ToHeader() = 0; |
|
80 |
|
81 |
|
82 /** |
|
83 * Gets the From-header |
|
84 * |
|
85 * @pre |
|
86 * @post |
|
87 * |
|
88 * @see |
|
89 * |
|
90 * @return value From-header, or NULL if From-header doesn't exist. |
|
91 * The ownership is transferred |
|
92 */ |
|
93 virtual CSIPFromHeader* FromHeader() = 0; |
|
94 |
|
95 |
|
96 /** |
|
97 * Gets the Call-ID header |
|
98 * |
|
99 * @pre |
|
100 * @post |
|
101 * |
|
102 * @see |
|
103 * |
|
104 * @return value Call-ID header, or NULL if Call-ID does not exist. |
|
105 * The ownership is transferred |
|
106 */ |
|
107 virtual CSIPCallIDHeader* CallIDHeader() = 0; |
|
108 |
|
109 |
|
110 /** |
|
111 * Gets the CSeq number part. |
|
112 * |
|
113 * @pre |
|
114 * @post |
|
115 * |
|
116 * @see |
|
117 * |
|
118 * @return value CSeq number |
|
119 */ |
|
120 virtual TUint CSeqNumber() const = 0; |
|
121 |
|
122 |
|
123 /** |
|
124 * Gets the Record-route headers |
|
125 * |
|
126 * @pre |
|
127 * @post |
|
128 * |
|
129 * @see |
|
130 * |
|
131 * @return value Record-route headers, or NULL if Record-route headers |
|
132 * do not exist. The ownership is transferred |
|
133 */ |
|
134 virtual RPointerArray<CSIPRouteHeaderBase>* RecordRoute() = 0; |
|
135 |
|
136 |
|
137 /** |
|
138 * Gets the Contact headers |
|
139 * |
|
140 * @pre |
|
141 * @post |
|
142 * |
|
143 * @see |
|
144 * |
|
145 * @return value Contact headers, or NULL if Contact headers do not exist. |
|
146 * The ownership is transferred |
|
147 */ |
|
148 virtual RPointerArray<CSIPContactHeader>* Contact() = 0; |
|
149 }; |
|
150 |
|
151 #endif // end of MTRANSACTIONHEADERS_H |
|
152 |
|
153 // End of File |