|
sl@0
|
1 |
/**
|
|
sl@0
|
2 |
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
* Declaration of CActiveBackupCallbackHandler
|
|
sl@0
|
16 |
*
|
|
sl@0
|
17 |
*
|
|
sl@0
|
18 |
*/
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
/**
|
|
sl@0
|
23 |
@file
|
|
sl@0
|
24 |
*/
|
|
sl@0
|
25 |
#ifndef __ACTIVEBACKUPCALLBACKHANDLER_H__
|
|
sl@0
|
26 |
#define __ACTIVEBACKUPCALLBACKHANDLER_H__
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
#include <e32base.h>
|
|
sl@0
|
29 |
#include <connect/abclient.h>
|
|
sl@0
|
30 |
#include <connect/abclientserver.h>
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
namespace conn
|
|
sl@0
|
33 |
{
|
|
sl@0
|
34 |
class MActiveBackupDataClient;
|
|
sl@0
|
35 |
class RABClientSession;
|
|
sl@0
|
36 |
|
|
sl@0
|
37 |
class CActiveBackupCallbackHandler : public CActive
|
|
sl@0
|
38 |
/**
|
|
sl@0
|
39 |
CActiveBackupCallbackHandler is used to handle the asynchronous calls back from the
|
|
sl@0
|
40 |
active backup server. IPC only allows client initiated message transfer and hence the
|
|
sl@0
|
41 |
Active Backup Callback Handler must prime the server with an initial message and use
|
|
sl@0
|
42 |
the async response to "send" a message to the client side.
|
|
sl@0
|
43 |
|
|
sl@0
|
44 |
@internal component
|
|
sl@0
|
45 |
*/
|
|
sl@0
|
46 |
{
|
|
sl@0
|
47 |
public:
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
/**
|
|
sl@0
|
50 |
Empty virtual destructor to avoid memory leaks
|
|
sl@0
|
51 |
*/
|
|
sl@0
|
52 |
virtual ~CActiveBackupCallbackHandler();
|
|
sl@0
|
53 |
|
|
sl@0
|
54 |
static CActiveBackupCallbackHandler* NewL(MActiveBackupDataClient* aABDC,
|
|
sl@0
|
55 |
RABClientSession& aClientSession);
|
|
sl@0
|
56 |
|
|
sl@0
|
57 |
/**
|
|
sl@0
|
58 |
RunL will synchronously call the callback implementation passed in to this object
|
|
sl@0
|
59 |
*/
|
|
sl@0
|
60 |
void RunL();
|
|
sl@0
|
61 |
|
|
sl@0
|
62 |
/**
|
|
sl@0
|
63 |
*/
|
|
sl@0
|
64 |
void DoCancel();
|
|
sl@0
|
65 |
|
|
sl@0
|
66 |
/**
|
|
sl@0
|
67 |
RunError implementation should send the leave code to the ABServer for propagation back
|
|
sl@0
|
68 |
to the SBEngine client. This enables any leaves from the callbacks to be returned to the
|
|
sl@0
|
69 |
PC for display/handling by the user
|
|
sl@0
|
70 |
|
|
sl@0
|
71 |
@return any unhandled error code
|
|
sl@0
|
72 |
*/
|
|
sl@0
|
73 |
TInt RunError(TInt aError);
|
|
sl@0
|
74 |
|
|
sl@0
|
75 |
void ConstructL();
|
|
sl@0
|
76 |
|
|
sl@0
|
77 |
void StartListeningForServerMessagesL();
|
|
sl@0
|
78 |
|
|
sl@0
|
79 |
private:
|
|
sl@0
|
80 |
CActiveBackupCallbackHandler(MActiveBackupDataClient* aABDC, RABClientSession& aClientSession);
|
|
sl@0
|
81 |
void PrimeServerForCallbackL();
|
|
sl@0
|
82 |
void PrimeServerForCallbackWithResponseL(TInt aResponse);
|
|
sl@0
|
83 |
void PrimeServerForCallbackWithResponseL(TDesC8& aResponse);
|
|
sl@0
|
84 |
TPtr8 CreateFixedBufferL();
|
|
sl@0
|
85 |
|
|
sl@0
|
86 |
private:
|
|
sl@0
|
87 |
/** Callback mixin implementation provided by the active backup client */
|
|
sl@0
|
88 |
MActiveBackupDataClient* iActiveBackupDataClient;
|
|
sl@0
|
89 |
|
|
sl@0
|
90 |
/** The client session to call methods on */
|
|
sl@0
|
91 |
RABClientSession& iClientSession;
|
|
sl@0
|
92 |
|
|
sl@0
|
93 |
/** This modifiable package buf is set by the Server to define which callback should
|
|
sl@0
|
94 |
be called on the client */
|
|
sl@0
|
95 |
TPckgBuf<TABCallbackCommands> iCallbackCommand;
|
|
sl@0
|
96 |
|
|
sl@0
|
97 |
/** Modifiable package buf containing the first of a maximum of two arguments for the callback */
|
|
sl@0
|
98 |
TPckgBuf<TInt> iCallbackArg1;
|
|
sl@0
|
99 |
|
|
sl@0
|
100 |
/** Modifiable package buf containing the second of a maximum of two arguments for the callback */
|
|
sl@0
|
101 |
TPckgBuf<TInt> iCallbackArg2;
|
|
sl@0
|
102 |
|
|
sl@0
|
103 |
/** Buffer for holding transferred data from server */
|
|
sl@0
|
104 |
HBufC8* iTransferBuffer;
|
|
sl@0
|
105 |
};
|
|
sl@0
|
106 |
|
|
sl@0
|
107 |
} // end namespace
|
|
sl@0
|
108 |
|
|
sl@0
|
109 |
#endif // __ACTIVEBACKUPCALLBACKHANDLER_H__
|
|
sl@0
|
110 |
|