|
1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 /** |
|
17 @file MWspCapabilityViewer.h |
|
18 @warning : This file contains Rose Model ID comments - please do not delete |
|
19 */ |
|
20 |
|
21 #ifndef __MWSPCAPABILITYVIEWER_H__ |
|
22 #define __MWSPCAPABILITYVIEWER_H__ |
|
23 |
|
24 // System includes |
|
25 #include <e32base.h> |
|
26 |
|
27 // Forward declarations |
|
28 class MWspAliasAddresses; |
|
29 class MWspExtendedMethods; |
|
30 class MWspHeaderCodePages; |
|
31 class MWspUnknownCapabilities; |
|
32 |
|
33 |
|
34 class MWspCapabilityViewer |
|
35 /** |
|
36 @class MWspCapabilityViewer |
|
37 @since 7.0 |
|
38 The MWspCapabiltyViewer API provides an interface to view a set of capabilities |
|
39 as defined by the WSP Specification, July 2001. |
|
40 @publishedAll |
|
41 @deprecated |
|
42 */ |
|
43 { |
|
44 public: // Methods |
|
45 |
|
46 /** |
|
47 @fn GetAliasAddresses() const =0 |
|
48 Intended Usage : The set of Alias Addresses. This capability indicates |
|
49 alternate addresses that can be used to access the same |
|
50 entity instance in this current session. The addresses |
|
51 are listed in preferential order, with the most preferred |
|
52 at the start. |
|
53 @since 7.0 |
|
54 @return A const reference to a MWspAliasAddresses object. |
|
55 */ |
|
56 virtual const MWspAliasAddresses& GetAliasAddresses() const =0; |
|
57 |
|
58 /** |
|
59 @fn GetExtendedMethods() const =0 |
|
60 Intended Usage : The set of extended methods. This capability gives a |
|
61 set of methods, beyond those defined in HTTP/1.1. |
|
62 @since 7.0 |
|
63 @return A const reference to a MWspExtendedMethods object. |
|
64 */ |
|
65 virtual const MWspExtendedMethods& GetExtendedMethods() const =0; |
|
66 |
|
67 /** |
|
68 @fn GetHeaderCodePages() const =0 |
|
69 Intended Usage : The set of extension header code pages. |
|
70 @since 7.0 |
|
71 @return A const reference to a MWspHeaderCodePages object. |
|
72 */ |
|
73 virtual const MWspHeaderCodePages& GetHeaderCodePages() const =0; |
|
74 |
|
75 /** |
|
76 @fn GetMethodMOR() const =0 |
|
77 Intended Usage : The Method MOR defines the number of active/outstanding |
|
78 method invocations at one time during the session. |
|
79 @since 7.0 |
|
80 @return The Method MOR size as an unsigned 8-bit number. |
|
81 */ |
|
82 virtual TUint8 GetMethodMOR() const =0; |
|
83 |
|
84 /** |
|
85 @fn GetPushMOR() const =0 |
|
86 Intended Usage : The Push MOR defines the number of active/outstanding |
|
87 push invocations at one time during the session. |
|
88 @since 7.0 |
|
89 @return The Push MOR size as an unsigned 8-bit number. |
|
90 */ |
|
91 virtual TUint8 GetPushMOR() const =0; |
|
92 |
|
93 /** |
|
94 @fn GetProtocolOptions() const =0 |
|
95 Intended Usage : The Protocol Options capability defines the optional |
|
96 service facilities and features for the session. The |
|
97 presence of an element indicates that the use of the |
|
98 specified facility or feature is enabled. The features |
|
99 and facilities described in the WSP Specification, July |
|
100 2001, are specified by flags in a single byte. |
|
101 Additional flags will be specified in subsequent bytes, |
|
102 but this is not supported currently. |
|
103 |
|
104 @since 7.0 |
|
105 @return The Protocol Options encoded within a byte. |
|
106 Options. |
|
107 |
|
108 */ |
|
109 virtual TUint8 GetProtocolOptions() const =0; |
|
110 |
|
111 /** |
|
112 @fn GetClientSDUSize() const =0 |
|
113 Intended Usage : The Client SDU size is the size of the largest service |
|
114 data unit that may be sent to the Client during the |
|
115 session. A value of zero indicates that there is no limit |
|
116 to the SDU size. |
|
117 @since 7.0 |
|
118 @return The SDU size, in bytes, as an unsigned 32-bit number. |
|
119 */ |
|
120 virtual TUint32 GetClientSDUSize() const =0; |
|
121 |
|
122 /** |
|
123 @fn GetServerSDUSize() const =0 |
|
124 Intended Usage : The Server SDU size is the size of the largest service |
|
125 data unit that may be sent to the Server during the |
|
126 session. A value of zero indicates that there is no limit |
|
127 to the SDU size. |
|
128 @since 7.0 |
|
129 @return The SDU size, in bytes, as an unsigned 32-bit number. |
|
130 */ |
|
131 virtual TUint32 GetServerSDUSize() const =0; |
|
132 |
|
133 /** |
|
134 @fn GetClientMessageSize() const =0 |
|
135 Intended Usage : The Client Message size is the size of the largest |
|
136 message that may be sent to the Client during the |
|
137 session. A message may consist of multiple SDUs. A |
|
138 value of zero indicates that there is no limit to the |
|
139 Message size. |
|
140 @since 7.0 |
|
141 @return The Message size, in bytes, as an unsigned 32-bit number. |
|
142 */ |
|
143 virtual TUint32 GetClientMessageSize() const =0; |
|
144 |
|
145 /** |
|
146 @fn GetServerMessageSize() const =0 |
|
147 Intended Usage : The Server Message size is the size of the largest |
|
148 message that may be sent to the Server during the |
|
149 session. A message may consist of multiple SDUs. A |
|
150 value of zero indicates that there is no limit to the |
|
151 Message size. |
|
152 @since 7.0 |
|
153 @return The Message size, in bytes, as an unsigned 32-bit number. |
|
154 */ |
|
155 virtual TUint32 GetServerMessageSize() const =0; |
|
156 |
|
157 /** |
|
158 @fn GetUnknownCapabilities() const =0 |
|
159 Intended Usage : A set of capabilities not defined by the WSP |
|
160 Specification, July 2001. The Identifier is encoded in |
|
161 the same way as the header field name - it uses the BNF |
|
162 rule for Field-Name, as shown in 8.4.2.6. Well-known |
|
163 capabilities have their identifier encoded using a short- |
|
164 integer, and unknown capabilities encode their identifier |
|
165 using a Null-terminated string. Any extra capabilities |
|
166 must be defined in such a way that an empty parameter |
|
167 value is illegal. This allows the unknown capability to |
|
168 be rejected. |
|
169 @since 7.0 |
|
170 @return A const reference to a MWspUknownCapabilities object. |
|
171 */ |
|
172 virtual const MWspUnknownCapabilities& GetUnknownCapabilities() const =0; |
|
173 |
|
174 }; |
|
175 |
|
176 #endif // __MWSPCAPABILITYVIEWER_H__ |