aboutsummaryrefslogtreecommitdiffstats
path: root/gobi-api/GobiAPI_2013-07-31-1347/Core/ProtocolBuffer.cpp
blob: b192cfa2b041dcfc3844ff92d3170f046d0a4651 (plain)
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
/*===========================================================================
FILE:
   ProtocolBuffer.cpp

DESCRIPTION:
   Generic protocol structures and affliated methods
   
PUBLIC CLASSES AND METHODS:
   sProtocolBuffer
      Simple struct to represent a protocol buffer using a reference counted
      (shared) buffer, this allows us to use in in several places without
      copying it once in each place.  A few base services are provided
      but the main purpose is to provide a class to inherit off of for
      specific protocols

Copyright (c) 2013, The Linux Foundation. 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 The Linux Foundation 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 "ProtocolBuffer.h"

//---------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------------

/*=========================================================================*/
// sProtocolBuffer Methods
/*=========================================================================*/

/*===========================================================================
METHOD:
   sProtocolBuffer (Public Method)

DESCRIPTION:
   Constructor (default)
  
RETURN VALUE:
   None
===========================================================================*/
sProtocolBuffer::sProtocolBuffer()
   :  mpData( 0 ),
      mbValid( false )
{
   // Object is currently invalid
   mTimestamp = EMPTY_TIME;
}

/*===========================================================================
METHOD:
   sProtocolBuffer (Public Method)

DESCRIPTION:
   Constructor (parameterized)

PARAMETERS:
   pBuffer     [ I ] - Shareable buffer that contains the DIAG data
  
RETURN VALUE:
   None
===========================================================================*/
sProtocolBuffer::sProtocolBuffer( sSharedBuffer * pBuffer )
   :  mpData( 0 ),
      mbValid( false )
{
   mTimestamp = EMPTY_TIME;
 
   time_t rawtime;
   time( &rawtime );
   tm * timestamp = localtime( &rawtime );
   if (timestamp != 0)
   {
      mTimestamp = *timestamp;
   }

   if (mpData != 0 && mpData->IsValid() == true)
   {
      mpData->Release();
      mpData = 0;
   }  

   mpData = pBuffer;
   if (mpData != 0 && mpData->IsValid() == true)
   {
      mpData->AddRef();
   }
   else
   {
      mpData = 0;
   }
    
   // NOTE: Derived classes need to call their own validation method
   // in their constructors since the override might try to access
   // data that is not yet in place
   sProtocolBuffer::Validate();
}

/*===========================================================================
METHOD:
   sProtocolBuffer (Public Method)

DESCRIPTION:
   Copy constructor

PARAMETERS:
   copyThis    [ I ] - sProtocolBuffer to base the new one on
  
RETURN VALUE:
   None
===========================================================================*/
sProtocolBuffer::sProtocolBuffer( const sProtocolBuffer & copyThis )
   :  mpData( copyThis.mpData ),
      mTimestamp( copyThis.mTimestamp ),
      mbValid( copyThis.mbValid )
{
   // Bump reference count for shared buffer
   if (mpData != 0 && mpData->IsValid() == true)
   {
      mpData->AddRef();
   }
   else
   {
      mpData = 0;
      mbValid = false;
   }   
}

/*===========================================================================
METHOD:
   operator = (Public Method)

DESCRIPTION:
   Assignment operator

PARAMETERS:
   copyThis    [ I ] - sProtocolBuffer to base the new one on

RETURN VALUE:
   sProtocolBuffer &
===========================================================================*/
sProtocolBuffer & sProtocolBuffer::operator = ( const sProtocolBuffer & copyThis )
{
   // Do we already have data?
   if (mpData != 0)
   {
      // Is it different than what we are duplicating?
      if (mpData != copyThis.mpData)
      {
         // Yes, release our current buffer
         mpData->Release();
      }
   }

   mpData     = copyThis.mpData;
   mTimestamp = copyThis.mTimestamp;
   mbValid    = copyThis.mbValid;

   // Bump reference count for shared buffer
   if (mpData != 0 && mpData->IsValid() == true)
   {
      mpData->AddRef();
   }
   else
   {
      mpData = 0;
      mbValid = false;
   }

   return *this;
}

/*===========================================================================
METHOD:
   ~sProtocolBuffer (Public Method)

DESCRIPTION:
   Destructor
  
RETURN VALUE:
   None
===========================================================================*/
sProtocolBuffer::~sProtocolBuffer() 
{
   if (mpData != 0 && mpData->IsValid() == true)
   {
      mpData->Release();
      mpData = 0;
   }  
   else if (mpData != 0)
   {
      ASSERT( 0 );
   }

   mbValid = false;
}