commrat::TimsWrapper Class Reference

#include <commrat/platform/tims_wrapper.hpp>

Public Member Functions
	TimsWrapper (const TimsConfig &config)
	~TimsWrapper ()
	TimsWrapper (const TimsWrapper &)=delete
TimsWrapper &	operator= (const TimsWrapper &)=delete
	TimsWrapper (TimsWrapper &&) noexcept
TimsWrapper &	operator= (TimsWrapper &&) noexcept
TimsResult	initialize ()
void	shutdown ()
template<typename T >
TimsResult	send (T &message, uint32_t dest_mailbox_id)
template<typename T >
std::optional< T >	receive (Milliseconds timeout=Milliseconds(0))
bool	has_message () const
uint32_t	get_mailbox_id () const
const std::string &	get_mailbox_name () const
bool	is_initialized () const
uint64_t	get_messages_sent () const
uint64_t	get_messages_received () const
ssize_t	receive_raw_bytes (std::span< std::byte > buffer, Milliseconds timeout)

Detailed Description

Definition at line 47 of file tims_wrapper.hpp.

Constructor & Destructor Documentation

TimsWrapper() [1/3]

commrat::TimsWrapper::TimsWrapper ( const TimsConfig &  config )

explicit

~TimsWrapper()

commrat::TimsWrapper::~TimsWrapper

(

)

TimsWrapper() [2/3]

commrat::TimsWrapper::TimsWrapper ( const TimsWrapper &  )

delete

TimsWrapper() [3/3]

commrat::TimsWrapper::TimsWrapper ( TimsWrapper &&  )

noexcept

Member Function Documentation

get_mailbox_id()

uint32_t commrat::TimsWrapper::get_mailbox_id ( ) const

inline

Definition at line 110 of file tims_wrapper.hpp.

References commrat::TimsConfig::mailbox_id.

get_mailbox_name()

const std::string & commrat::TimsWrapper::get_mailbox_name ( ) const

inline

Definition at line 111 of file tims_wrapper.hpp.

References commrat::TimsConfig::mailbox_name.

get_messages_received()

uint64_t commrat::TimsWrapper::get_messages_received ( ) const

inline

Definition at line 116 of file tims_wrapper.hpp.

Referenced by commrat::Mailbox< MessageDefs >::messages_received().

get_messages_sent()

uint64_t commrat::TimsWrapper::get_messages_sent ( ) const

inline

Definition at line 115 of file tims_wrapper.hpp.

Referenced by commrat::Mailbox< MessageDefs >::messages_sent().

has_message()

bool commrat::TimsWrapper::has_message

(

)

const

initialize()

TimsResult commrat::TimsWrapper::initialize

(

)

Referenced by commrat::Mailbox< MessageDefs >::start().

is_initialized()

bool commrat::TimsWrapper::is_initialized ( ) const

inline

Definition at line 112 of file tims_wrapper.hpp.

operator=() [1/2]

TimsWrapper & commrat::TimsWrapper::operator= ( const TimsWrapper &  )

delete

operator=() [2/2]

TimsWrapper & commrat::TimsWrapper::operator= ( TimsWrapper &&  )

noexcept

receive()

template<typename T >

std::optional< T > commrat::TimsWrapper::receive ( Milliseconds  timeout = Milliseconds(0) )

inline

Definition at line 83 of file tims_wrapper.hpp.

receive_raw_bytes()

ssize_t commrat::TimsWrapper::receive_raw_bytes ( std::span< std::byte >  buffer, Milliseconds  timeout  )

inline

Definition at line 120 of file tims_wrapper.hpp.

Referenced by commrat::Mailbox< MessageDefs >::clean(), commrat::Mailbox< MessageDefs >::receive(), commrat::Mailbox< MessageDefs >::receive_any(), and commrat::Mailbox< MessageDefs >::receive_for().

send()

template<typename T >

TimsResult commrat::TimsWrapper::send ( T &  message, uint32_t  dest_mailbox_id  )

inline

Definition at line 66 of file tims_wrapper.hpp.

References commrat::ERROR_NOT_INITIALIZED, and commrat::serialize_message().

Referenced by commrat::Mailbox< MessageDefs >::send().

shutdown()

void commrat::TimsWrapper::shutdown

(

)

Referenced by commrat::Mailbox< MessageDefs >::stop().

---

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

• commrat/platform/tims_wrapper.hpp