|
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 MWspCOSessionInvoker.h |
|
18 @warning : This file contains Rose Model ID comments - please do not delete |
|
19 */ |
|
20 |
|
21 #ifndef __MWSPCOSESSIONINVOKER_H__ |
|
22 #define __MWSPCOSESSIONINVOKER_H__ |
|
23 |
|
24 // System includes |
|
25 #include <e32std.h> |
|
26 #include <wsp/wsptypes.h> |
|
27 |
|
28 // Types used for arguments in this file (e.g. TWspBearer) are from the Wap namespace |
|
29 using namespace Wap; |
|
30 |
|
31 |
|
32 class MWspCOSessionInvoker |
|
33 /** |
|
34 @class MWspCOSessionInvoker |
|
35 @since 7.0 |
|
36 The MWspCOSessionInvoker and MWspCOSessionCallback form the API that provides |
|
37 the WSP Connection-Orientated Session Service Session Management, Session |
|
38 Resume and Exception Handling facilities, as described by the WSP |
|
39 Specification, July 2001. |
|
40 |
|
41 The MWspCOSessionInvoker interface is supplied by the Provider entity. The |
|
42 MWspCOSessionCallback interface is supplied by the Client entity. The Provider |
|
43 implements the communications necessary to send the primitives issued by the |
|
44 Client to the Server, and from the Server to the Client. |
|
45 |
|
46 The APIs that provide connection information, session headers and capabilities |
|
47 are supplied to the Provider from the Client during configuration. The Provider |
|
48 uses these APIs to return any Server session headers and the negotiated |
|
49 capabilities from the Server |
|
50 |
|
51 The use of the Session Resume facility during the lifetime of a WSP session is |
|
52 dependent on this being a successfully negotiated capability for that session. |
|
53 @publishedAll |
|
54 @deprecated |
|
55 */ |
|
56 { |
|
57 public: // Methods |
|
58 |
|
59 /** |
|
60 @fn ConnectReq() =0 |
|
61 Intended Usage : This represents the S-Connect.req primitive. The Provider |
|
62 initiates WSP session establishment with the Server. The |
|
63 expected primitives to be issued from the Provider are |
|
64 S-Connect.cnf or S-Disconnect.ind. |
|
65 @since 7.0 |
|
66 @pre The WSP Session is in the Null state. |
|
67 @post The Provider has initiated a connection with the Server (a |
|
68 WAP Gateway). The WSP Session is in the Connecting state. |
|
69 */ |
|
70 virtual void ConnectReq() =0; |
|
71 |
|
72 /** |
|
73 @fn DisconnectReq(TWspReason aReasonCode) =0 |
|
74 Intended Usage : This represents the S-Disconnect.req primitive.The Client |
|
75 requests that the WSP session be disconnected. The session |
|
76 is not disconnected until the Provider has given the |
|
77 indication for this primitive, S-Disconnect.ind. Before |
|
78 the disconnect indication, the Provider must have aborted |
|
79 any outstanding method and push transactions. The Client |
|
80 will not issue any further primitives. |
|
81 @since 7.0 |
|
82 @param aReasonCode A parameter that indicates the reason for the |
|
83 disconnection. The value maps to the 'WSP Reason' type |
|
84 defined in the WSP Specification, July 2001. |
|
85 @pre The WSP session is in any state other than Null or Closing. |
|
86 @post The Provider is disconnecting the session. The WSP session |
|
87 is in the Closing state. |
|
88 */ |
|
89 virtual void DisconnectReq(TWspReason aReason) =0; |
|
90 |
|
91 /** |
|
92 @fn SuspendReq() =0 |
|
93 Intended Usage : This represents the S-Suspend.req primitive. The Client |
|
94 requests that the WSP session be suspended. This function |
|
95 can only called if the Session Resume facility has been |
|
96 successfully negotiated for this WSP session. The session |
|
97 is not suspended until the Provider has given the |
|
98 indication to this primitive, S-Suspend.ind. Before the |
|
99 suspend indication, the Provider must have aborted any |
|
100 outstanding method and push transactions. The Client |
|
101 will only issue the S-Resume.req and S-Disconnect.req |
|
102 primitives. |
|
103 @since 7.0 |
|
104 @pre The Session Resume facitlity has been successfully negotiated |
|
105 for this WSP session. The WSP session is either in the |
|
106 Connected or Resuming state. |
|
107 @post The Provider has requested that the server suspend the WSP |
|
108 session. The WSP session is in the Suspending state. |
|
109 */ |
|
110 virtual void SuspendReq() =0; |
|
111 |
|
112 /** |
|
113 @fn ResumeReq() =0 |
|
114 Intended Usage : This represents the S-Resume.req primitive. The Client |
|
115 requests that the WSP session be resumed. This function |
|
116 can only called if the Session Resume facility has been |
|
117 successfully negotiated for this WSP session.If the |
|
118 session is in the Connected state, this primitive can be |
|
119 used to update the Session Headers used in the WSP |
|
120 session. |
|
121 @since 7.0 |
|
122 @pre The Session Resume facitlity has been successfully negotiated |
|
123 for this WSP session. The WSP session is in either the Connected, |
|
124 Suspending or Suspended state. |
|
125 @post The Provider has requested that the Server resume the WSP |
|
126 session. The WSP session is in the Resuming state. |
|
127 */ |
|
128 virtual void ResumeReq() =0; |
|
129 |
|
130 }; |
|
131 |
|
132 #endif // __MWSPCOSESSIONINVOKER_H__ |