Quick Links:

bmqa | bmqpi | bmqt

Public Member Functions

bmqa::MessageIterator Class Reference

#include <bmqa_messageiterator.h>

List of all members.

Public Member Functions

 MessageIterator ()
 MessageIterator (const MessageIterator &)
 ~MessageIterator ()
MessageIteratoroperator= (const MessageIterator &)
bool nextMessage ()
const Messagemessage () const

Detailed Description

An iterator providing read-only sequential access to messages contained into a MesssageEvent.

See Component bmqa_messageiterator


Constructor & Destructor Documentation

bmqa::MessageIterator::MessageIterator (  )  [explicit]

Default constructor

bmqa::MessageIterator::MessageIterator ( const MessageIterator  ) 
bmqa::MessageIterator::~MessageIterator (  ) 

Member Function Documentation

MessageIterator& bmqa::MessageIterator::operator= ( const MessageIterator  ) 
bool bmqa::MessageIterator::nextMessage (  ) 

Advance the position of the iterator to the next message in the event. Return true if there is a next message and false otherwise. Note that advancing to the next message will invalidate any previously returned bmqa::Message retrieved from the message() call.

const Message& bmqa::MessageIterator::message (  )  const

Return the message to which the iterator is pointing, if any; otherwise return an invalid message. Note that nextMessage must be called before message in order to advance the iterators position to the first message in the event.


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