|
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 MWspCLPushInvoker.h |
|
18 @warning : This file contains Rose Model ID comments - please do not delete |
|
19 */ |
|
20 |
|
21 #ifndef __MWSPCLPUSHINVOKER_H__ |
|
22 #define __MWSPCLPUSHINVOKER_H__ |
|
23 |
|
24 // System includes |
|
25 #include <e32base.h> |
|
26 |
|
27 // Forward declarations |
|
28 class MWspCLPushCallback; |
|
29 |
|
30 |
|
31 class MWspCLPushInvoker |
|
32 /** |
|
33 @class MWspCLPushInvoker |
|
34 @since 7.0 |
|
35 The MWspCLPushInvoker and MWspCLPushCallback form the API that provides the |
|
36 WSP Connectionless Session Service Push facility, as in the WSP Specification, |
|
37 July 2001. The MWspCLMethodInvoker interface is supplied by the Provider |
|
38 entity. The MWspCLMethodCallback interface is supplied by the Client entity. |
|
39 The Provider implements the communications necessary to send the primitives |
|
40 issued by the Client to the Server, and from the Server to the Client. |
|
41 |
|
42 The Client object that encapsulates a push transaction implements the call-back |
|
43 API MWspCLPushCallback. Internally, the Provider should associate each of these |
|
44 objects with a WSP Push Id in order to distinguish between push transactions. |
|
45 @publishedAll |
|
46 @deprecated |
|
47 */ |
|
48 { |
|
49 public: // Methods |
|
50 |
|
51 /** |
|
52 @fn InitPushReceive(MWspCLPushCallback& aPushCallback) =0 |
|
53 Intended Usage : Supplies the Provider with a Push transaction object. |
|
54 Also, informs the Provider that the Client is ready to |
|
55 receive Push information. The Provider uses this call- |
|
56 back object to pass Push information to the Client. |
|
57 @since 7.0 |
|
58 @param aPushCallback A reference to an instance of the call-back |
|
59 API MWspCLPushCallback.It uniquely identifies |
|
60 this method transaction for the lifetime of |
|
61 the transaction. |
|
62 @pre The underlying layers are prepared for communication. |
|
63 @post The Provider is waiting for a S-Unit-Push primitive from |
|
64 the Server. Increases the number of listening Push |
|
65 transactions by one. |
|
66 */ |
|
67 virtual void InitPushReceive(MWspCLPushCallback& aPushCallback) =0; |
|
68 |
|
69 /** |
|
70 @fn CancelPushReceive(MWspCLPushCallback& aPushCallback) =0 |
|
71 Intended Usage : Removes the listening Push transaction. The Client no |
|
72 longer wishes to receive Push information via the |
|
73 specified MWspCLPushCallback object. |
|
74 @since 7.0 |
|
75 @param aPushCallback A reference to an instance of the call-back |
|
76 API MWspCLPushCallback.It uniquely identifies |
|
77 this method transaction for the lifetime of |
|
78 the transaction. |
|
79 @pre The Push transaction object is exists. |
|
80 @post The aPushCallback object is no longer valid. The number of |
|
81 listening Push transaction objects in the Provider is reduced |
|
82 by one. |
|
83 */ |
|
84 virtual void CancelPushReceive(MWspCLPushCallback& aPushCallback) =0; |
|
85 |
|
86 }; |
|
87 |
|
88 #endif // __MWSPCLPUSHINVOKER_H__ |
|
89 |