WOscBundleParser Class Reference

#include <WOscBundle.h>

List of all members.

Public Member Functions
void	ResetStateMachine ()
void	Clone (char **buffer, unsigned int *bufferLen) const
void	Parse (const char *data, unsigned int len)
WOscTimeTag	GetTimeTag () const
unsigned int	GetItemCount () const
bool	GetNextItem (const char **buffer, unsigned int *length)
Classes
class	WOscBundleRaw

---

Detailed Description

Raw bundle parsing. Allows analysis of bundles directly from a binary stream. If a data packet has been received the buffer can be casted to this class and the resulting object can be analyzed, e.g.

WOscBundleRaw* bundle = reinterpret_cast<WOscBundleRaw*>(data);

Examples:

WOscClient.cpp.

Definition at line 72 of file WOscBundle.h.

---

Member Function Documentation

unsigned int WOscBundleParser::GetItemCount (   )  const [inline]

Return the number of items in the bundle. Examples: WOscClient.cpp. Definition at line 162 of file WOscBundle.h. { return m_nItems; }

bool WOscBundleParser::GetNextItem (  const char **  buffer, unsigned int *  length )  [inline]

Get the next item in the bundle. Parameters: buffer  Pointer which receives a pointer to the internal data of the next item. length  Pointer which receives the length of the next item in bytes. Returns: True if there was an item left, false if no items left. Definition at line 171 of file WOscBundle.h. { unsigned int dataLen = m_bundleLen - WOSC_BUNDLE_HEADER_SIZE; if ( m_nextItem >= m_nItems || m_offset >= dataLen ) return false; *length = WOscUtil::BufferTo<int32_t>(m_bundle->m_bundleData + m_offset); *buffer = m_bundle->m_bundleData + m_offset + sizeof(uint32_t); m_offset += *length + sizeof(uint32_t); m_nextItem++; return true; }

WOscTimeTag WOscBundleParser::GetTimeTag (   )  const [inline]

Get the time tag. Bundle must have been parsed successfully before. Examples: WOscClient.cpp. Definition at line 155 of file WOscBundle.h. References WOscTimeTag::GetImmediateTime(). { if ( m_bundle == NULL ) return WOscTimeTag::GetImmediateTime(); return WOscTimeTag(reinterpret_cast<const char*>(&m_bundle->m_timeTag)); }

void WOscBundleParser::Parse (  const char *  data, unsigned int  len )  [inline]

Check if bundle layout correct and extract information required to iterate through all bundle items. Examples: WOscClient.cpp. Definition at line 125 of file WOscBundle.h. References WOSC_BUNDLE_TAG. { // reset all members to zero (0) memset(this, 0, sizeof(WOscBundleParser)); const WOscBundleRaw* bundle = reinterpret_cast<const WOscBundleRaw*>(data); unsigned int dataLen = len - WOSC_BUNDLE_HEADER_SIZE; if ( dataLen > len ) // if wrapped throw WOscException(ERR_TOO_SHORT, __FILE__, __LINE__); if ( dataLen == 0 ) throw WOscException(ERR_EMPTY_BUNDLE, __FILE__, __LINE__); if ( strncmp(bundle->m_tag, WOSC_BUNDLE_TAG, sizeof(bundle->m_tag)) != 0 ) throw WOscException(ERR_INVALID_TAG, __FILE__, __LINE__); // check if layout valid by stepping through bundle unsigned int offset = 0; for ( ; offset + sizeof(int32_t) < dataLen; m_nItems++ ) { int itemLen = WOscUtil::BufferTo<int32_t>(bundle->m_bundleData+offset); offset += itemLen + sizeof(uint32_t); } if ( offset != dataLen ) { throw WOscException(ERR_CURRUPT_BUNDLE_LAYOUT, __FILE__, __LINE__); } if ( m_nItems == 0 ) throw WOscException(ERR_NO_ITEMS_IN_BUNDLE, __FILE__, __LINE__); m_bundle = bundle; m_bundleLen = len; }

---

The documentation for this class was generated from the following file:

• WOscBundle.h

---