MessageInput< TMessageSpec > Class Template Reference

Space-ng SDK: sol3::core::MessageInput< TMessageSpec > Class Template Reference

Space-ng SDK

#include <sol3/core/message_input.h>

Inheritance diagram for sol3::core::MessageInput< TMessageSpec >:

Public Types
using	TableType = typename TMessageSpec::TableType
	FlatBuffers table types derived from the message spec. More...

using	NativeTableType = typename TableType::NativeTableType

Public Member Functions
	MessageInput (IBufferExchange &exchange, uint32_t component_id)

	MessageInput (IBufferExchange &exchange, IBufferExchange::Endpoint endpoint, uint32_t component_id)

	MessageInput (MessageInput &&rhs)=delete

MessageInput &	operator= (MessageInput &&rhs)=delete

	MessageInput (MessageInput const &)=delete

MessageInput &	operator= (MessageInput const &rhs)=delete

	~MessageInput ()=default

MessageView< TMessageSpec >	read (uint64_t seq, std::chrono::steady_clock::duration time_out={})

MessageView< TMessageSpec >	readHead (std::chrono::steady_clock::duration time_out={})

Public Member Functions inherited from sol3::core::AnyMessageInput
	AnyMessageInput (IBufferExchange &exchange, IBufferExchange::Endpoint endpoint, MessagePort port, MessageSchema expected_schema=MessageSchema())

	AnyMessageInput (IBufferExchange &exchange, MessagePort port, MessageSchema expected_schema)

	AnyMessageInput (AnyMessageInput &&rhs)=delete

AnyMessageInput &	operator= (AnyMessageInput &&rhs)=delete

	AnyMessageInput (AnyMessageInput const &)=delete

AnyMessageInput &	operator= (AnyMessageInput const &rhs)=delete

	~AnyMessageInput ()=default

bool	pollForBufferUpdate ()
	Return true if the underlying buffer has been updated and is valid. More...

size_t	slotCount () const
	Number of slots in the underlying sequence ring. More...

size_t	slotSize () const
	Maximum slot size in bytes in the underlying sequence ring. More...

void	reset ()
	Resets the reader and clears cached message views. More...

AnyMessageView	read (uint64_t seq, std::chrono::steady_clock::duration time_out={})

size_t	readInto (uint64_t seq, flatbuffers::span< uint8_t > dest, std::chrono::steady_clock::duration time_out={})

size_t	readInto (uint64_t seq, IStreamWriter &stream, std::chrono::steady_clock::duration time_out={})

AnyMessageView	readHead (std::chrono::steady_clock::duration time_out={})

uint64_t	head () const
	The current latest sequence number, or 0 if no messages. More...

MessagePort	port () const
	The message port associated with this input. More...

IBufferExchange::Endpoint const &	endpoint () const

MessageSchema const &	schema () const

void	updateSchema (MessageSchema const &schema)

Detailed Description

template<typename TMessageSpec>
class sol3::core::MessageInput< TMessageSpec >

Typed input for reading a stream of messages defined by TMessageSpec from an IBufferExchange.

This class discovers and tracks the underlying shared buffer for the computed message port, swaps in new buffers when the provider updates its UUID, and exposes MessageReader-style accessors to read the latest (head) or a specific sequence number.