Struct MessagesStreamingIter

Nested Relationships

Nested Types

Struct Documentation

struct MessagesStreamingIter

Iterator over all messages in Streaming Layout order for specified timestamp range.

Public Types

using iterator_category = std::forward_iterator_tag

Iterator category for forward iteration.

using value_type = const MessageRef

Type of value pointed to by the iterator.

using difference_type = std::ptrdiff_t

Difference type between iterators.

using pointer = const std::unique_ptr<MessageRef>

Pointer type returned by operator->.

using reference = const MessageRef&

Reference type returned by operator*.

using opened_chunk_type = std::pair<ChunkRef, uint64_t>

Pair of ChunkRef and timestamp used for chunk queuing.

typedef GreaterChunkType greater_chunk_type

Deprecated:

Use GreaterChunkType instead. This is a deprecated alias for the GreaterChunkType struct.

Public Functions

MessagesStreamingIter()

Default MessagesStreamingIter constructor that just zeros the internal fields.

MessagesStreamingIter(const MessagesStreamingIter &other)

Initialize the MessagesStreamingIter from another MessagesStreamingIter object.

Parameters:

other[in] – The other MessagesStreamingIter to initalize from.

MessagesStreamingIter &operator=(const MessagesStreamingIter &other) = default

Default assignment operation.

Parameters:

other[in] – The other MessagesStreamingIter to assign to.

const MessageRef operator*() const

Gets the current MessageRef via value.

Returns:

The current MessageRef value.

std::unique_ptr<const MessageRef> operator->() const

Gets the current MessageRef via smart pointer.

Returns:

The current MessageRef smart pointer.

MessagesStreamingIter &operator++()

Advance to the next message.

Returns:

*this

MessagesStreamingIter operator++(int)

Advance to the next message.

Returns:

*this

bool operator==(const MessagesStreamingIter &other) const

Check if two MessagesStreamingIter are equal.

Parameters:

other[in] – The other MessagesStreamingIter to check against.

Returns:

If the two MessagesStreamingIter are equal.

bool operator!=(const MessagesStreamingIter &other) const

Check if two MessagesStreamingIter are not equal.

Parameters:

other[in] – The other MessagesStreamingIter to check against.

Returns:

If the two MessagesStreamingIter are not equal.

std::string to_string() const

Debug string representation.

Returns:

The string representation of a MessagesStreamingIter.

struct GreaterChunkType

Comparison struct used for determining which chunk is greater.

Public Functions

bool operator()(const opened_chunk_type &a, const opened_chunk_type &b)

Comparison operator used for determining if the first is greater than the second.

The comparison is based on the timestamps.

Parameters:

  • a[in] – The first chunk to compare.

  • b[in] – The second chunk to compare.

Returns:

If the first chunk is greater than the second chunk.