OnixS C++ CME MDP Conflated UDP Handler  1.1.2
API documentation
BinaryMessageIterator Class Reference

#include <OnixS/CME/ConflatedUDP/Packet.h>

Public Types

typedef std::forward_iterator_tag iterator_category
 
typedef ptrdiff_t difference_type
 
typedef const BinaryMessage value_type
 
typedef value_typepointer
 
typedef value_typereference
 

Public Member Functions

 BinaryMessageIterator (const void *dataBegin, const void *dataEnd)
 
const void * nextMessageData () const
 
MessageSize nextMessageSize () const
 
BinaryMessage message () const
 
BinaryMessage operator* () const
 
BinaryMessageIteratoroperator++ ()
 
bool operator== (const BinaryMessageIterator &other) const
 
bool operator!= (const BinaryMessageIterator &other) const
 

Detailed Description

Definition at line 38 of file Packet.h.

Member Typedef Documentation

typedef ptrdiff_t difference_type

Establishes instance difference type.

Definition at line 79 of file Packet.h.

typedef std::forward_iterator_tag iterator_category

Definition at line 74 of file Packet.h.

typedef value_type* pointer

Defines pointer to a value type.

Definition at line 87 of file Packet.h.

Defines reference to a value type.

Definition at line 90 of file Packet.h.

typedef const BinaryMessage value_type

Defines value type.

Definition at line 84 of file Packet.h.

Constructor & Destructor Documentation

BinaryMessageIterator ( const void *  dataBegin,
const void *  dataEnd 
)
inline

Constructs encoded message iterator from raw data pointers.

Exceptions
runtime_errorin case when raw data pointers cannot be casted to valid encoded message iterator.

Definition at line 96 of file Packet.h.

Member Function Documentation

BinaryMessage message ( ) const
inline

Gets reference to encoded message.

Warning
Behavior is undefined in case when iterator points to the packet end.

Definition at line 127 of file Packet.h.

const void* nextMessageData ( ) const
inline

Definition at line 111 of file Packet.h.

MessageSize nextMessageSize ( ) const
inline

Definition at line 117 of file Packet.h.

bool operator!= ( const BinaryMessageIterator other) const
inline

Checks whether two iterators are not equal.

Definition at line 168 of file Packet.h.

BinaryMessage operator* ( ) const
inline

Dereferences encoded message.

Definition at line 138 of file Packet.h.

BinaryMessageIterator& operator++ ( )
inline

Advances iterator to next message.

Exceptions
runtime_errorin case when iteration is not possible.

Definition at line 146 of file Packet.h.

bool operator== ( const BinaryMessageIterator other) const
inline

Checks whether two iterators are equal.

Definition at line 160 of file Packet.h.


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