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
|
/*===========================================================================
FILE:
ProtocolLog.h
DESCRIPTION:
Simple protocol 'log' class definition
PUBLIC CLASSES AND METHODS:
cProtocolLog
This class stores protocol buffers in to a flat array (actually a
double-ended queue) so that they can be accessed by other objects
during the flow of normal processing. Note that the storage is
in-memory and therefore finite
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 "ProtocolLog.h"
//---------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------------
// The maximum number of in-memory buffers we allow
const ULONG MAX_PROTOCOL_BUFFERS = 1024 * 16;
/*=========================================================================*/
// cProtocolLog Methods
/*=========================================================================*/
/*===========================================================================
METHOD:
cProtocolLog (Public Method)
DESCRIPTION:
Constructor
PARAMETERS:
maxBuffers [ I ] - Maximum number of buffers to store in the log
RETURN VALUE:
None
===========================================================================*/
cProtocolLog::cProtocolLog( ULONG maxBuffers )
: mLog( maxBuffers > MAX_PROTOCOL_BUFFERS ? MAX_PROTOCOL_BUFFERS : maxBuffers,
true )
{
// Nothing to do
}
/*===========================================================================
METHOD:
~cProtocolLog (Public Method)
DESCRIPTION:
Destructor
RETURN VALUE:
None
===========================================================================*/
cProtocolLog::~cProtocolLog()
{
// Empty out the log
Clear();
}
/*===========================================================================
METHOD:
AddBuffer (Public Method)
DESCRIPTION:
Add an protocol buffer to the end of the log
PARAMETERS:
buff [ I ] - Protocol buffer to add
RETURN VALUE:
ULONG - Index of newly added buffer (INVALID_LOG_INDEX upon failure)
===========================================================================*/
ULONG cProtocolLog::AddBuffer( sProtocolBuffer & buf )
{
ULONG idx = INVALID_LOG_INDEX;
if (buf.IsValid() == false)
{
return idx;
}
bool bRC = mLog.AddElement( buf, idx );
if (bRC == false)
{
idx = INVALID_LOG_INDEX;
}
return idx;
}
/*===========================================================================
METHOD:
GetBuffer (Public Method)
DESCRIPTION:
Return the protocol buffer at the given index from the log
PARAMETERS:
idx [ I ] - Index of protocol buffer to obtain
RETURN VALUE:
sProtocolBuffer - Protocol buffer
===========================================================================*/
sProtocolBuffer cProtocolLog::GetBuffer( ULONG idx ) const
{
sProtocolBuffer buf;
mLog.GetElement( idx, buf );
return buf;
}
/*===========================================================================
METHOD:
GetSignalEvent (Public Method)
DESCRIPTION:
Return the underlying signal event, which will be set when
the log is updated.
RETURN VALUE:
cEvent - Signal event
===========================================================================*/
cEvent & cProtocolLog::GetSignalEvent() const
{
return mLog.GetSignalEvent();
}
/*===========================================================================
METHOD:
GetCount (Public Method)
DESCRIPTION:
Return the total number of buffers added to the log
RETURN VALUE:
ULONG
===========================================================================*/
ULONG cProtocolLog::GetCount() const
{
return mLog.GetTotalCount();
}
/*===========================================================================
METHOD:
Clear (Public Method)
DESCRIPTION:
Clear the log
RETURN VALUE:
None
===========================================================================*/
void cProtocolLog::Clear()
{
mLog.EmptyQueue();
}
|
