29
|
1 |
/*
|
60
|
2 |
* Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).
|
29
|
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: DUN USB configuration accessor and listener
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef C_CDUNUSBCONFIG_H
|
|
20 |
#define C_CDUNUSBCONFIG_H
|
|
21 |
|
|
22 |
#include <e32property.h>
|
|
23 |
#include <usb/acmconfig.h>
|
|
24 |
#include "DunPlugin.h"
|
|
25 |
|
|
26 |
/**
|
|
27 |
* Notification interface class to report USB ACM configuration change
|
|
28 |
*
|
|
29 |
* @lib dunusb.lib
|
|
30 |
* @since S60 v3.2
|
|
31 |
*/
|
|
32 |
NONSHARABLE_CLASS( MDunUsbConfig )
|
|
33 |
{
|
|
34 |
|
|
35 |
public:
|
|
36 |
|
|
37 |
/**
|
|
38 |
* Gets called when one or more ACM configurations are added
|
|
39 |
*
|
|
40 |
* @since S60 3.2
|
|
41 |
* @param aIndex Index (also port number) of added ACM configuration
|
|
42 |
* @return Symbian error code on error, KErrNone otherwise
|
|
43 |
*/
|
|
44 |
virtual TInt NotifyConfigAddition( TInt aIndex ) = 0;
|
|
45 |
|
|
46 |
/**
|
|
47 |
* Gets called when one or more ACM configurations are removed
|
|
48 |
*
|
|
49 |
* @since S60 3.2
|
|
50 |
* @param aIndex Index (also port number) of removed ACM configuration
|
|
51 |
* @return Symbian error code on error, KErrNone otherwise
|
|
52 |
*/
|
|
53 |
virtual TInt NotifyConfigRemoval( TInt aIndex ) = 0;
|
|
54 |
|
|
55 |
};
|
|
56 |
|
|
57 |
/**
|
|
58 |
* Class for detecting USB ACM configuration change
|
|
59 |
*
|
|
60 |
* @lib dunutils.lib
|
|
61 |
* @since S60 v3.2
|
|
62 |
*/
|
|
63 |
NONSHARABLE_CLASS( CDunUsbConfig ) : public CActive
|
|
64 |
{
|
|
65 |
|
|
66 |
public:
|
|
67 |
|
|
68 |
/**
|
|
69 |
* Two-phased constructor.
|
|
70 |
* @param aServer Server
|
|
71 |
* @param aCallback Pointer to listener callback
|
|
72 |
* @param aProtocol Protocol number to listen
|
|
73 |
* @return Instance of self
|
|
74 |
*/
|
|
75 |
static CDunUsbConfig* NewL( MDunServerCallback* aServer,
|
|
76 |
MDunUsbConfig* aCallback,
|
|
77 |
TUint8 aProtocol );
|
|
78 |
|
|
79 |
/**
|
|
80 |
* Destructor.
|
|
81 |
*/
|
|
82 |
virtual ~CDunUsbConfig();
|
|
83 |
|
|
84 |
/**
|
|
85 |
* Resets data to initial values
|
|
86 |
*
|
|
87 |
* @since S60 3.2
|
|
88 |
* @return None
|
|
89 |
*/
|
|
90 |
void ResetData();
|
|
91 |
|
|
92 |
/**
|
|
93 |
* Compares initialized protocol number to configuration by index
|
|
94 |
*
|
|
95 |
* @since S60 3.2
|
|
96 |
* @param aIndex Index for which to compare protocol number
|
|
97 |
* @param aValidity If initialized protocol matched at aIndex then ETrue
|
|
98 |
* @return Symbian error code on error, KErrNone otherwise
|
|
99 |
*/
|
|
100 |
TInt GetConfigValidityByIndex( TInt aIndex, TBool& aValidity );
|
|
101 |
|
|
102 |
/**
|
|
103 |
* Starts listening for ACM configuration changes
|
|
104 |
*
|
|
105 |
* @since S60 3.2
|
|
106 |
* @return Symbian error code on error, KErrNone otherwise
|
|
107 |
*/
|
|
108 |
TInt IssueRequest();
|
|
109 |
|
|
110 |
/**
|
|
111 |
* Stops listening for ACM configuration changes
|
|
112 |
*
|
|
113 |
* @since S60 3.2
|
60
|
114 |
* @return None
|
29
|
115 |
*/
|
60
|
116 |
void Stop();
|
29
|
117 |
|
|
118 |
private:
|
|
119 |
|
|
120 |
CDunUsbConfig( MDunServerCallback* aServer,
|
|
121 |
MDunUsbConfig* aCallback,
|
|
122 |
TUint8 aProtocol );
|
|
123 |
|
|
124 |
void ConstructL();
|
|
125 |
|
|
126 |
/**
|
|
127 |
* Initializes this class
|
|
128 |
*
|
|
129 |
* @since S60 3.2
|
|
130 |
* @return None
|
|
131 |
*/
|
|
132 |
void Initialize();
|
|
133 |
|
|
134 |
/*
|
|
135 |
* Gets current ACM configuration
|
|
136 |
*/
|
|
137 |
TInt GetConfiguration( TPublishedAcmConfigs& aConfig );
|
|
138 |
|
|
139 |
// from base class CActive
|
|
140 |
|
|
141 |
/**
|
|
142 |
* From CActive.
|
|
143 |
* Gets called when ACM configuration changes
|
|
144 |
*
|
|
145 |
* @since S60 3.2
|
|
146 |
* @return None
|
|
147 |
*/
|
|
148 |
void RunL();
|
|
149 |
|
|
150 |
/**
|
|
151 |
* From CActive.
|
|
152 |
* Gets called on cancel
|
|
153 |
*
|
|
154 |
* @since S60 3.2
|
|
155 |
* @return None
|
|
156 |
*/
|
|
157 |
void DoCancel();
|
|
158 |
|
|
159 |
private: // data
|
|
160 |
|
|
161 |
/**
|
|
162 |
* Callback to call when notification via MDunServerCallback to be made
|
|
163 |
* Not own.
|
|
164 |
*/
|
|
165 |
MDunServerCallback* iServer;
|
|
166 |
|
|
167 |
/**
|
|
168 |
* Callback to call when notification(s) via MDunUsbConfig to be made
|
|
169 |
*/
|
|
170 |
MDunUsbConfig* iCallback;
|
|
171 |
|
|
172 |
/*
|
|
173 |
* Protocol number of USB ACM to which listening is done
|
|
174 |
*/
|
|
175 |
TUint8 iProtocol;
|
|
176 |
|
|
177 |
/**
|
|
178 |
* ACM config from the previous Get()
|
|
179 |
* Used to check whether configs are added or removed and also array data
|
|
180 |
* needed for check in the removal case
|
|
181 |
*/
|
|
182 |
TPublishedAcmConfigs iConfig;
|
|
183 |
|
|
184 |
/*
|
|
185 |
* ACM configuration property
|
|
186 |
*/
|
|
187 |
RProperty iAcmProperty;
|
|
188 |
|
|
189 |
/*
|
|
190 |
* Flag to indicate if configuration already received
|
|
191 |
*/
|
|
192 |
TBool iConfigExist;
|
|
193 |
|
|
194 |
};
|
|
195 |
|
|
196 |
#endif // C_CDUNUSBCONFIG_H
|