eprosima::safedds::protocol::IMessageSink Class Reference

IMessageSink interface. More...

#include <IMessageSink.hpp>

Public Member Functions
virtual void	commit_message (memory::IList< MessageElement > &view_list, const GUID &origin_guid, const GUID &receiver_guid, const execution::TimePoint &timepoint) noexcept=0
	Commit message to the wire protocol message sink. More...
virtual void	commit_message_to_group (memory::IList< MessageElement > &view_list, const GUID &origin_guid, const protocol::EndpointGroup &group, const execution::TimePoint &timepoint) noexcept=0
	Commit message to a group of wire protocol message sinks. More...
virtual uint32_t	get_message_max_size () const noexcept=0
	Returns the maximum transfer unit of the wire protocol message sink. More...

Protected Member Functions
	~IMessageSink () noexcept=default
	Protected destructor ownership defined on creation. More...
	IMessageSink () noexcept=default
	Default creation. More...
	IMessageSink (const IMessageSink &) noexcept=delete
	Copy deleted. More...
	IMessageSink (IMessageSink &&) noexcept=delete
	Movement deleted. More...
IMessageSink &	operator= (const IMessageSink &) noexcept=delete
	Copy operator deleted. More...
IMessageSink &	operator= (IMessageSink &&) noexcept=delete
	Movement operator deleted. More...

Detailed Description

IMessageSink interface.

Constructor & Destructor Documentation

~IMessageSink()

eprosima::safedds::protocol::IMessageSink::~IMessageSink ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

IMessageSink() [1/3]

eprosima::safedds::protocol::IMessageSink::IMessageSink ( )

protecteddefaultnoexcept

Default creation.

IMessageSink() [2/3]

eprosima::safedds::protocol::IMessageSink::IMessageSink ( const IMessageSink &  )

protecteddeletenoexcept

Copy deleted.

IMessageSink() [3/3]

eprosima::safedds::protocol::IMessageSink::IMessageSink ( IMessageSink &&  )

protecteddeletenoexcept

Movement deleted.

Member Function Documentation

commit_message()

virtual void eprosima::safedds::protocol::IMessageSink::commit_message ( memory::IList< MessageElement > &  view_list, const GUID &  origin_guid, const GUID &  receiver_guid, const execution::TimePoint &  timepoint  )

pure virtualnoexcept

Commit message to the wire protocol message sink.

Parameters

view_list	view list with the data buffer and related metadata
origin_guid	origin GUID
receiver_guid	GUID of the destination
timepoint	maximum timepoint until this method will block

commit_message_to_group()

virtual void eprosima::safedds::protocol::IMessageSink::commit_message_to_group ( memory::IList< MessageElement > &  view_list, const GUID &  origin_guid, const protocol::EndpointGroup &  group, const execution::TimePoint &  timepoint  )

pure virtualnoexcept

Commit message to a group of wire protocol message sinks.

Parameters

view_list	view list with the data buffer and related metadata
origin_guid	origin GUID
group	Endpoint group
timepoint	maximum timepoint until this method will block

get_message_max_size()

virtual uint32_t eprosima::safedds::protocol::IMessageSink::get_message_max_size ( ) const

pure virtualnoexcept

Returns the maximum transfer unit of the wire protocol message sink.

Returns

message max size.

Implemented in eprosima::safedds::transport::posix::UDPv4.

operator=() [1/2]

IMessageSink& eprosima::safedds::protocol::IMessageSink::operator= ( const IMessageSink &  )

protecteddeletenoexcept

Copy operator deleted.

operator=() [2/2]

IMessageSink& eprosima::safedds::protocol::IMessageSink::operator= ( IMessageSink &&  )

protecteddeletenoexcept

Movement operator deleted.

---

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

• build/docs/user_manual/v3.0.0/tmp/include/safedds/protocol/IMessageSink.hpp