|
1 /* |
|
2 * Copyright (c) 2006 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: Callback methods used by SIP stack callback implementations |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 #ifndef MSimpleSipConnCallback_H |
|
22 #define MSimpleSipConnCallback_H |
|
23 |
|
24 // INCLUDES |
|
25 #include <e32base.h> |
|
26 #include "simplecommon.h" |
|
27 |
|
28 // FORWARD DECLARATIONS |
|
29 |
|
30 class CSIPConnection; |
|
31 class CSIPClientTransaction; |
|
32 class CSIPDialogAssocBase; |
|
33 class CSIPMessageElements; |
|
34 class CSimpleRequest; |
|
35 class CSIPDialog; |
|
36 |
|
37 /** |
|
38 * Callback methods used by SIP stack callback implementations. |
|
39 * |
|
40 * @lib simplesiputils |
|
41 * @since S60 3.2 |
|
42 */ |
|
43 class MSimpleSipConnCallback |
|
44 { |
|
45 |
|
46 public: |
|
47 |
|
48 /** |
|
49 * Connection state is changed |
|
50 * |
|
51 * @since S60 3.2 |
|
52 * @param aState new SIP state |
|
53 */ |
|
54 virtual void ConnectionStateChange( |
|
55 TSimpleSipState aState, TInt aSipError) = 0; |
|
56 |
|
57 /** |
|
58 * Connection method has changed (Roaming). |
|
59 * |
|
60 * @since S60 3.2.3 |
|
61 */ |
|
62 virtual void ConnectionChanged() = 0; |
|
63 |
|
64 /** |
|
65 * Time to refresh a request |
|
66 * |
|
67 * @since S60 3.2 |
|
68 * @param aReq corresponding engine's request |
|
69 */ |
|
70 virtual void StartToRefreshL( CSimpleRequest& aReq ) = 0; |
|
71 |
|
72 /** |
|
73 * Time to check expiration |
|
74 * @param aReq corresponding engine's request |
|
75 */ |
|
76 virtual void StartToCheckExpiryL( CSimpleRequest& aReq ) = 0; |
|
77 |
|
78 /** |
|
79 * Search the corresponding client request |
|
80 * |
|
81 * @since S60 3.2 |
|
82 * @param aTrans SIP transaction |
|
83 * @return request or NULL if request not found |
|
84 */ |
|
85 virtual CSimpleRequest* GetRequest( CSIPClientTransaction& aTrans ) = 0; |
|
86 |
|
87 /** |
|
88 * Search the corresponding client request |
|
89 * |
|
90 * @since S60 3.2 |
|
91 * @param aDialog SIP dialog |
|
92 * @return initial SUBSCRIBE request or NULL if request not found |
|
93 */ |
|
94 virtual CSimpleRequest* GetdDialogRequest( const CSIPDialog& aDialog ) = 0; |
|
95 |
|
96 /** |
|
97 * Handles publish response. |
|
98 * This reads SIP-ETAG and resets refresh timer. |
|
99 * |
|
100 * @since S60 3.2 |
|
101 * @param aMesElems SIP message elements |
|
102 * @param aReq corresponding engine's request |
|
103 */ |
|
104 virtual void HandlePublishRespL( const CSIPMessageElements& aMesElems, CSimpleRequest* aReq ) = 0; |
|
105 |
|
106 /** |
|
107 * Handles server request in a dialog |
|
108 * This resets refresh timer when needed. |
|
109 * |
|
110 * @since S60 3.2 |
|
111 * @param aMesElems SIP message elements |
|
112 * @param aReq corresponding engine's request |
|
113 * @param aMethod SIP method |
|
114 */ |
|
115 virtual void HandleDialogRequestL( |
|
116 const CSIPMessageElements& aMesElems, |
|
117 CSimpleRequest& aReq, |
|
118 const TDesC8& aMethod ) = 0; |
|
119 |
|
120 /** |
|
121 * Retry publication, with a body when pending data exists. |
|
122 * |
|
123 * @since S60 3.2 |
|
124 * @param aReq corresponding engine's request |
|
125 * @return error code |
|
126 */ |
|
127 virtual TInt DoSendPendingPublish( CSimpleRequest& aReq ) = 0; |
|
128 |
|
129 /** |
|
130 * Handle received message |
|
131 * |
|
132 * @since S60 5.0 |
|
133 * @param aFrom message received from |
|
134 * @param aContent message content |
|
135 * @return error code |
|
136 */ |
|
137 virtual TInt HandleReceivedMessage( const TDesC8& aFrom, |
|
138 const TDesC8& aContent ) = 0; |
|
139 |
|
140 }; |
|
141 |
|
142 #endif |