1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/*===========================================================================
FILE:
ProtocolRequest.cpp
DESCRIPTION:
Generic protocol request/command related structures and
affliated methods, these structures are used by clients of
the protocol server to specify outgoing requests
PUBLIC CLASSES AND METHODS:
sProtocolRequest
Copyright (c) 2012, Code Aurora Forum. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of Code Aurora Forum nor
the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
===========================================================================*/
//---------------------------------------------------------------------------
// Include Files
//---------------------------------------------------------------------------
#include "StdAfx.h"
#include "ProtocolRequest.h"
#include "ProtocolNotification.h"
#include "ProtocolServer.h"
//---------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------------
// Default protocol request timeout
const ULONG DEFAULT_REQ_TIMEOUT = 1000;
// Minimum and maximum allowable timeout values (in milliseconds)
const ULONG MIN_REQ_TIMEOUT = 100;
const ULONG MAX_REQ_TIMEOUT = 300000;
// Minimum number of attempts a request can be scheduled for
const ULONG MIN_REQ_ATTEMPTS = 1;
// Value to indicate that a request is to be sent out indefinately
const ULONG INFINITE_REQS = 0xFFFFFFFF;
// Minimum/default amount of time between repeated requests (in milliseconds)
const ULONG MIN_REQ_FREQUENCY = 10;
const ULONG DEFAULT_REQ_FREQUENCY = 100;
/*=========================================================================*/
// sProtocolRequest Methods
/*=========================================================================*/
/*===========================================================================
METHOD:
sProtocolRequest
DESCRIPTION:
Parameterized constructor
PARAMETERS:
pBuffer [ I ] - Shareable buffer representing the request (must be
valid)
schedule [ I ] - When (from now, in milliseconds) to send the first
request, this isn't a hard value as the request is
only guaranteed to go out after this time elapses
timeout [ I ] - Milliseconds to wait for a response to an individual
request before declaring a timeout. Regardless of
what is passed in the timeout value used will be
between MIN/MAX_REQ_TIMEOUT
requests [ I ] - Number of request attempts to make, this isn't a
retry count rather this value is used to specify
repeating requests. Regardless of what is passed in
the requests value used will be at least
MIN_REQ_ATTEMPTS
frequency [ I ] - If the 'requests' value is greater than the
MIN_REQ_ATTEMPTS than this represents the amount of
time to wait between requests (from the completion of
the last request attempt, in milliseconds), again this
isn't a hard value. Regardless of what is passed in
the frequency value used will be at least
MIN_REQ_FREQUENCY
pNotifier [ I ] - Status notification mechanism (may be 0)
RETURN VALUE:
None
===========================================================================*/
sProtocolRequest::sProtocolRequest(
sSharedBuffer * pBuffer,
ULONG schedule,
ULONG timeout,
ULONG requests,
ULONG frequency,
cProtocolNotification * pNotifier )
: sProtocolBuffer( pBuffer ),
mSchedule( schedule ),
mTimeout( DEFAULT_REQ_TIMEOUT ),
mRequests( MIN_REQ_ATTEMPTS ),
mFrequency( DEFAULT_REQ_FREQUENCY ),
mpNotifier( 0 ),
mpAuxData( 0 ),
mAuxDataSize( 0 ),
mbTXOnly( false )
{
// Constrain requested timeout to allowable range
if (timeout < MIN_REQ_TIMEOUT)
{
timeout = MIN_REQ_TIMEOUT;
}
if (timeout > MAX_REQ_TIMEOUT)
{
timeout = MAX_REQ_TIMEOUT;
}
mTimeout = timeout;
// Constrain request attempts
if (requests >= MIN_REQ_ATTEMPTS)
{
mRequests = requests;
}
// Constrain frequency
if (frequency >= MIN_REQ_FREQUENCY)
{
mFrequency = frequency;
}
// Clone notifier?
if (pNotifier != 0)
{
mpNotifier = pNotifier->Clone();
}
}
/*===========================================================================
METHOD:
sProtocolRequest
DESCRIPTION:
Parameterized constructor (notification with defaults)
PARAMETERS:
pBuffer [ I ] - Shareable buffer representing the request (must be
valid)
pNotifier [ I ] - Status notification mechanism (may be 0)
RETURN VALUE:
None
===========================================================================*/
sProtocolRequest::sProtocolRequest(
sSharedBuffer * pBuffer,
cProtocolNotification * pNotifier )
: sProtocolBuffer( pBuffer ),
mSchedule( 0 ),
mTimeout( DEFAULT_REQ_TIMEOUT ),
mRequests( MIN_REQ_ATTEMPTS ),
mFrequency( DEFAULT_REQ_FREQUENCY ),
mpNotifier( pNotifier ),
mpAuxData( 0 ),
mAuxDataSize( 0 ),
mbTXOnly( false )
{
// Clone notifier?
if (pNotifier != 0)
{
mpNotifier = pNotifier->Clone();
}
Validate();
}
/*===========================================================================
METHOD:
sProtocolRequest
DESCRIPTION:
Copy constructor
PARAMETERS:
req [ I ] - Request to copy
RETURN VALUE:
None
===========================================================================*/
sProtocolRequest::sProtocolRequest( const sProtocolRequest & req )
: sProtocolBuffer( req ),
mSchedule( req.mSchedule ),
mTimeout( req.mTimeout ),
mRequests( req.mRequests ),
mFrequency( req.mFrequency ),
mpNotifier( 0 ),
mpAuxData( req.mpAuxData ),
mAuxDataSize( req.mAuxDataSize ),
mbTXOnly( req.mbTXOnly )
{
// Clone notifier?
if (req.mpNotifier != 0)
{
mpNotifier = req.mpNotifier->Clone();
}
Validate();
}
/*===========================================================================
METHOD:
~sProtocolRequest
DESCRIPTION:
Destructor
RETURN VALUE:
None
===========================================================================*/
sProtocolRequest::~sProtocolRequest()
{
// Delete cloned notifier?
if (mpNotifier != 0)
{
delete mpNotifier;
mpNotifier = 0;
}
}
|
