0
|
1 |
/*
|
|
2 |
* Copyright (c) 2009 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 the License "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:
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
#ifndef __ISICHANNELROUTERIF_H__
|
|
21 |
#define __ISICHANNELROUTERIF_H__
|
|
22 |
|
|
23 |
#include <e32def.h> // For TInt, TAny
|
|
24 |
|
|
25 |
class MISIRouterChannelIf;
|
|
26 |
|
|
27 |
/*
|
|
28 |
* Abstract interface for channel to use router services.
|
|
29 |
*/
|
|
30 |
class MISIChannelRouterIf
|
|
31 |
{
|
|
32 |
|
|
33 |
public:
|
|
34 |
|
|
35 |
enum TISIDfcQThreadType
|
|
36 |
{
|
|
37 |
EISIKernelMainThread = 0,
|
|
38 |
EISIKernelRequestCompletionThread,
|
|
39 |
EISIUserMainThread,
|
|
40 |
EISIUserRequestCompletionThread
|
|
41 |
};
|
|
42 |
|
|
43 |
/*
|
|
44 |
* Informs router that channel is closed.
|
|
45 |
*/
|
|
46 |
virtual void Disconnect( const TUint8 aObjId ) = 0;
|
|
47 |
|
|
48 |
/*
|
|
49 |
* Returns thread according to TISIDfcThread enums.
|
|
50 |
* @param aThreadIndex, threads index in table
|
|
51 |
* @return pointer to thread
|
|
52 |
*/
|
|
53 |
virtual TDfcQue* GetDfcThread( const TISIDfcQThreadType aType ) = 0;
|
|
54 |
|
|
55 |
virtual void FreeDfcThread( TDfcQue* aThread ) = 0;
|
|
56 |
|
|
57 |
/*
|
|
58 |
* Returns the interface.
|
|
59 |
* @return pointer to the interface
|
|
60 |
*/
|
|
61 |
static MISIChannelRouterIf* GetIf();
|
|
62 |
|
|
63 |
/*
|
|
64 |
* Informs router that channel is ready to be open.
|
|
65 |
* If transceiver is not found sets the open pending.
|
|
66 |
* Router shall complete the pending opens when transceiver is ready.
|
|
67 |
* @param aUID, clients UID.
|
|
68 |
* @param aObjId, reference to write clients object id.
|
|
69 |
* @param aCallback, pointer to channel interface.
|
|
70 |
*/
|
|
71 |
virtual void Connect( const TInt32 aUID, TUint8& aObjId, MISIRouterChannelIf* aCallback ) = 0;
|
|
72 |
|
|
73 |
/*
|
|
74 |
* Sends a message to router.
|
|
75 |
* Responsibility to deallocate the message is transferred router.
|
|
76 |
* @param aMessage, messages reference
|
|
77 |
* @return, KErrNone if succesfull, KErrNotReady if transceiver is not present.
|
|
78 |
*/
|
|
79 |
virtual TInt Send( TDes8& aMessage, const TUint8 aObjId ) = 0;
|
|
80 |
|
|
81 |
};
|
|
82 |
|
|
83 |
#endif /* __ISICHANNELROUTERIF_H__ */
|