enso::PeekPktIterator Class Reference

Packet iterator that does not consume the packets from the pipe. More...

#include <pipe.h>

Inheritance diagram for enso::PeekPktIterator:

Public Member Functions
	PeekPktIterator (uint8_t *addr, int32_t message_limit, RxPipe::MessageBatch< PeekPktIterator > *batch)
_enso_always_inline uint8_t *	GetNextMessage (uint8_t *current_message)
	Computes the next message address based on the current message.
constexpr void	OnAdvanceMessage (uint32_t nb_bytes)
	Called when the iterator is done processing a message.
Public Member Functions inherited from enso::MessageIteratorBase< PeekPktIterator >
constexpr uint8_t *	operator* ()
constexpr bool	operator!= (const MessageIteratorBase &other) const
constexpr PeekPktIterator &	operator++ ()

Additional Inherited Members
Protected Member Functions inherited from enso::MessageIteratorBase< PeekPktIterator >
	MessageIteratorBase (const MessageIteratorBase &)=default
	MessageIteratorBase (MessageIteratorBase &&)=default
	MessageIteratorBase (uint8_t *addr, int32_t message_limit, RxPipe::MessageBatch< PeekPktIterator > *batch)
MessageIteratorBase &	operator= (const MessageIteratorBase &)=default
MessageIteratorBase &	operator= (MessageIteratorBase &&)=default
Protected Attributes inherited from enso::MessageIteratorBase< PeekPktIterator >
uint8_t *	addr_
int32_t	missing_messages_
RxPipe::MessageBatch< PeekPktIterator > *	batch_
uint8_t *	next_addr_

Detailed Description

Packet iterator that does not consume the packets from the pipe.

See also

RxPipe::PeekPkts

RxTxPipe::PeekPkts

PktIterator

Definition at line 1393 of file pipe.h.

Constructor & Destructor Documentation

PeekPktIterator()

enso::PeekPktIterator::PeekPktIterator ( uint8_t *  addr, int32_t  message_limit, RxPipe::MessageBatch< PeekPktIterator > *  batch  )

inline

Definition at line 1398 of file pipe.h.

Member Function Documentation

GetNextMessage()

_enso_always_inline uint8_t * enso::PeekPktIterator::GetNextMessage ( uint8_t *  current_message )

inline

Computes the next message address based on the current message.

Parameters

current_message

The current message.

Returns

The next message.

Definition at line 1405 of file pipe.h.

OnAdvanceMessage()

constexpr void enso::PeekPktIterator::OnAdvanceMessage ( uint32_t  nb_bytes )

inlineconstexpr

Called when the iterator is done processing a message.

Parameters

nb_bytes

The number of bytes processed.

Definition at line 1412 of file pipe.h.

---

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

• pipe.h