#include <bmqa_messageproperties.h>
List of all members.
Detailed Description
Provide a mechanism to iterator over all the properties in an instance of bmqa::MessageProperties. The order of the iteration is implementation defined. An iterator is valid if it is associated with a property , otherwise it is invalid. Behavior is undefined if the underlying instance of bmqa::MessageProperties is modified during the lifetime of this iterator.
See Component bmqa_messageproperties
Constructor & Destructor Documentation
| bmqa::MessagePropertiesIterator::MessagePropertiesIterator |
( |
|
) |
|
Create an empty iterator instance. The only valid operations that can be invoked on an empty instance are copying, assignment and destruction.
| bmqa::MessagePropertiesIterator::MessagePropertiesIterator |
( |
const MessageProperties * |
properties |
) |
[explicit] |
Create an iterator for the specified properties. Behavior is undefined unless properties is not null.
Copy constructor from the specified other.
| bmqa::MessagePropertiesIterator::~MessagePropertiesIterator |
( |
|
) |
|
Member Function Documentation
Assignment operator from the specified rhs.
| bool bmqa::MessagePropertiesIterator::hasNext |
( |
|
) |
|
Advance this iterator to refer to the next property of the associated MessageProperties instance, if there is one and return true, return false otherwise. Behavior is undefined unless this method is being invoked for the first time on this object or previous call to hasNext returned true. Note that the order of the iteration is not specified.
| const bsl::string& bmqa::MessagePropertiesIterator::name |
( |
|
) |
const |
Return a reference offering non-modifiable access to the name of the property being pointed by the iterator. Behavior is undefined unless last call to hasNext returned true.
Return the data type of property being pointed by the iterator. Behavior is undefined unless last call to hasNext returned true;
| bool bmqa::MessagePropertiesIterator::getAsBool |
( |
|
) |
const |
| char bmqa::MessagePropertiesIterator::getAsChar |
( |
|
) |
const |
| short bmqa::MessagePropertiesIterator::getAsShort |
( |
|
) |
const |
| bsl::int32_t bmqa::MessagePropertiesIterator::getAsInt32 |
( |
|
) |
const |
| bsls::Types::Int64 bmqa::MessagePropertiesIterator::getAsInt64 |
( |
|
) |
const |
| const bsl::string& bmqa::MessagePropertiesIterator::getAsString |
( |
|
) |
const |
| const bsl::vector<char>& bmqa::MessagePropertiesIterator::getAsBinary |
( |
|
) |
const |
Return property value having the corresponding type being currently being pointed by this iterator instance. Behavior is undefined unless last call to hasNext returned true. Behavior is also undefined unless property's data type matches the requested type.
The documentation for this class was generated from the following file:
