Processor implementation. More...

#include <Processor.hpp>

Public Member Functions
	Processor (IProcessData data_processor, IProcessDataFrag datafrag_processor, IProcessHeartbeat heartbeat_processor, IProcessAckNack acknack_processor, IProcessNackFrag nackfrag_processor, IProcessGap gap_processor, IProcessUnknown *unknown_processor) noexcept
	Processor constructor. More...

	Processor (IProcessData data_processor, IProcessDataFrag datafrag_processor, IProcessHeartbeat heartbeat_processor, IProcessAckNack acknack_processor, IProcessNackFrag nackfrag_processor, IProcessGap gap_processor, IProcessUnknown *unknown_processor, ProcessorProperties processor_properties) noexcept
	Overload of processor constructor with configured properties. More...

	Processor (Reader &reader) noexcept
	Processor constructor with rtps::Reader. More...

	Processor (Writer &writer) noexcept
	Processor constructor with rtps::Writer. More...

virtual	~Processor () noexcept=default
	Virtual destructor. More...

	Processor (const Processor &) noexcept=delete
	Copy deleted. More...

	Processor (Processor &&) noexcept=delete
	Movement deleted. More...

Processor &	operator= (const Processor &) noexcept=delete
	Copy operator deleted. More...

Processor &	operator= (Processor &&) noexcept=delete
	Movement operator deleted. More...

ReturnCode	process_message (const memory::IConstByteArrayView &message) noexcept override
	Process the wire protocol message. More...

Protected Member Functions
ReturnCode	process_next_submessage (serialization::IDeserializer &dser, const memory::IConstByteArrayView &message, ProcessorState &processor_state) noexcept
	Process next submessage in deserializer. More...

ReturnCode	handle_submessage (const SubmessageHeader &subheader, const memory::IConstByteArrayView &payload, const memory::IConstByteArrayView &message, ProcessorState &processor_state) noexcept
	Handle a deserialized submessage. More...

ReturnCode	process_data_submessage (const SubmessageHeader &subheader, serialization::IDeserializer &dser, const ProcessorState &processor_state) noexcept
	Deserialize and process DATA submessage. More...

ReturnCode	process_datafrag_submessage (const SubmessageHeader &subheader, serialization::IDeserializer &dser, const ProcessorState &processor_state) noexcept
	Deserialize and process DATAFRAG submessage. More...

ReturnCode	process_heartbeat_submessage (const SubmessageHeader &subheader, serialization::IDeserializer &dser, const ProcessorState &processor_state) noexcept
	Deserialize and process HEARTBEAT submessage. More...

ReturnCode	process_gap_submessage (const SubmessageHeader &subheader, serialization::IDeserializer &dser, const ProcessorState &processor_state) noexcept
	Deserialize and process GAP submessage. More...

ReturnCode	process_acknack_submessage (const SubmessageHeader &subheader, serialization::IDeserializer &dser, const ProcessorState &processor_state) noexcept
	Deserialize and process ACKNACK submessage. More...

ReturnCode	process_nackfrag_submessage (const SubmessageHeader &subheader, serialization::IDeserializer &dser, const ProcessorState &processor_state) noexcept
	Deserialize and process NACKFRAG submessage. More...

ReturnCode	process_unknown_submessage (const memory::IConstByteArrayView &submessage, ProcessorState &processor_state) noexcept

Protected Member Functions inherited from eprosima::safedds::protocol::IProcessor
	~IProcessor () noexcept=default
	Protected destructor ownership defined on creation. More...

	IProcessor () noexcept=default
	Default creation. More...

	IProcessor (const IProcessor &) noexcept=delete
	Copy deleted. More...

	IProcessor (IProcessor &&) noexcept=delete
	Movement deleted. More...

IProcessor &	operator= (const IProcessor &) noexcept=delete
	Copy operator deleted. More...

IProcessor &	operator= (IProcessor &&) noexcept=delete
	Movement operator deleted. More...

Static Protected Member Functions
static ReturnCode	process_submessage_header (serialization::IDeserializer &dser, SubmessageHeader &submessage_header) noexcept
	Deserialize and process SubmessageHeader. More...

static ReturnCode	process_infodst_submessage (const SubmessageHeader &subheader, serialization::IDeserializer &dser, ProcessorState &processor_state) noexcept
	Deserialize and process INFO_DST submessage. More...

static ReturnCode	process_infosrc_submessage (const SubmessageHeader &subheader, serialization::IDeserializer &dser, ProcessorState &processor_state) noexcept
	Deserialize and process INFO_SCR submessage. More...

static ReturnCode	process_infots_submessage (const SubmessageHeader &subheader, serialization::IDeserializer &dser, ProcessorState &processor_state) noexcept
	Deserialize and process INFO_TS submessage. More...

static ReturnCode	process_header_extension_submessage (const SubmessageHeader &subheader, const memory::IConstByteArrayView &message, serialization::IDeserializer &submsg_dser, ProcessorState &processor_state) noexcept
	Deserialize and process HEADER_HE submessage. More...

static ReturnCode	validate_processor_state (const ProcessorState &processor_state) noexcept
	Checks current processor state. More...

static ReturnCode	validate_rtps_message (Submessage< HeaderExtension > &header_extension, const memory::IConstByteArrayView &message, serialization::IDeserializer &submsg_dser, ProcessorState &processor_state) noexcept
	Validate a RTPS message using a header extension submessage. More...

Protected Attributes
IProcessData *	data_processor_
	Pointer to data processor. More...

IProcessDataFrag *	datafrag_processor_
	Pointer to datafrag processor. More...

IProcessHeartbeat *	heartbeat_processor_
	Pointer to heartbeat processor. More...

IProcessAckNack *	acknack_processor_
	Pointer to acknack processor. More...

IProcessNackFrag *	nackfrag_processor_
	Pointer to nackfrag processor. More...

IProcessGap *	gap_processor_
	Pointer to gap processor. More...

IProcessUnknown *	unknown_processor_
	Pointer to unknown processor. More...

ProcessorProperties	processor_properties_
	Configured processor properties. More...

Detailed Description

Processor implementation.

Constructor & Destructor Documentation

◆ Processor() [1/6]

eprosima::safedds::protocol::rtps::Processor::Processor	(	IProcessData *	data_processor,
		IProcessDataFrag *	datafrag_processor,
		IProcessHeartbeat *	heartbeat_processor,
		IProcessAckNack *	acknack_processor,
		IProcessNackFrag *	nackfrag_processor,
		IProcessGap *	gap_processor,
		IProcessUnknown *	unknown_processor
	)

noexcept

Processor constructor.

Parameters

[in,out]	data_processor	pointer to data processor. Ownership is not taken.
[in,out]	datafrag_processor	pointer to datafrag processor. Ownership is not taken.
[in,out]	heartbeat_processor	pointer to heartbeat processor. Ownership is not taken.
[in,out]	acknack_processor	pointer to acknack processor. Ownership is not taken.
[in,out]	nackfrag_processor	pointer to nackfrag processor. Ownership is not taken.
[in,out]	gap_processor	pointer to gap processor. Ownership is not taken.
[in,out]	unknown_processor	pointer to unknown processor. Ownership is not taken.

◆ Processor() [2/6]

eprosima::safedds::protocol::rtps::Processor::Processor	(	IProcessData *	data_processor,
		IProcessDataFrag *	datafrag_processor,
		IProcessHeartbeat *	heartbeat_processor,
		IProcessAckNack *	acknack_processor,
		IProcessNackFrag *	nackfrag_processor,
		IProcessGap *	gap_processor,
		IProcessUnknown *	unknown_processor,
		ProcessorProperties	processor_properties
	)

noexcept

Overload of processor constructor with configured properties.

Parameters

[in,out]	data_processor	pointer to data processor. Ownership is not taken.
[in,out]	datafrag_processor	pointer to datafrag processor. Ownership is not taken.
[in,out]	heartbeat_processor	pointer to heartbeat processor. Ownership is not taken.
[in,out]	acknack_processor	pointer to acknack processor. Ownership is not taken.
[in,out]	nackfrag_processor	pointer to nackfrag processor. Ownership is not taken.
[in,out]	gap_processor	pointer to gap processor. Ownership is not taken.
[in,out]	unknown_processor	pointer to unknown processor. Ownership is not taken.
	processor_properties	properties.

◆ Processor() [3/6]

eprosima::safedds::protocol::rtps::Processor::Processor ( Reader & reader )

explicitnoexcept

Processor constructor with rtps::Reader.

Parameters

[in,out] reader reference to Reader. Ownership is not taken.

◆ Processor() [4/6]

eprosima::safedds::protocol::rtps::Processor::Processor ( Writer & writer )

explicitnoexcept

Processor constructor with rtps::Writer.

Parameters

[in,out] writer reference to Writer. Ownership is not taken.

◆ ~Processor()

virtual eprosima::safedds::protocol::rtps::Processor::~Processor ( )

virtualdefaultnoexcept

Virtual destructor.

◆ Processor() [5/6]

eprosima::safedds::protocol::rtps::Processor::Processor ( const Processor & )

deletenoexcept

Copy deleted.

◆ Processor() [6/6]

eprosima::safedds::protocol::rtps::Processor::Processor ( Processor && )

deletenoexcept

Movement deleted.

Member Function Documentation

◆ handle_submessage()

ReturnCode eprosima::safedds::protocol::rtps::Processor::handle_submessage	(	const SubmessageHeader &	subheader,
		const memory::IConstByteArrayView &	payload,
		const memory::IConstByteArrayView &	message,
		ProcessorState &	processor_state
	)

protectednoexcept

Handle a deserialized submessage.

Parameters

	subheader	Deserializer interface
	payload	Payload of the submessage
	message	Complete RTPS message view
[in,out]	processor_state	Processor state

Returns: ReturnCode

◆ operator=() [1/2]

Processor& eprosima::safedds::protocol::rtps::Processor::operator= ( const Processor & )

deletenoexcept

Copy operator deleted.

◆ operator=() [2/2]

Processor& eprosima::safedds::protocol::rtps::Processor::operator= ( Processor && )

deletenoexcept

Movement operator deleted.

◆ process_acknack_submessage()

ReturnCode eprosima::safedds::protocol::rtps::Processor::process_acknack_submessage	(	const SubmessageHeader &	subheader,
		serialization::IDeserializer &	dser,
		const ProcessorState &	processor_state
	)

protectednoexcept

Deserialize and process ACKNACK submessage.

Parameters

subheader	Already deserialized subheader
dser	Deserializer
processor_state	Processor state

Returns: ReturnCode with processing status

◆ process_data_submessage()

ReturnCode eprosima::safedds::protocol::rtps::Processor::process_data_submessage	(	const SubmessageHeader &	subheader,
		serialization::IDeserializer &	dser,
		const ProcessorState &	processor_state
	)

protectednoexcept

Deserialize and process DATA submessage.

Parameters

subheader	Already deserialized subheader
dser	Deserializer
processor_state	Processor state

Returns: ReturnCode with processing status

◆ process_datafrag_submessage()

ReturnCode eprosima::safedds::protocol::rtps::Processor::process_datafrag_submessage	(	const SubmessageHeader &	subheader,
		serialization::IDeserializer &	dser,
		const ProcessorState &	processor_state
	)

protectednoexcept

Deserialize and process DATAFRAG submessage.

Parameters

subheader	Already deserialized subheader
dser	Deserializer
processor_state	Processor state

Returns: ReturnCode with processing status

◆ process_gap_submessage()

ReturnCode eprosima::safedds::protocol::rtps::Processor::process_gap_submessage	(	const SubmessageHeader &	subheader,
		serialization::IDeserializer &	dser,
		const ProcessorState &	processor_state
	)

protectednoexcept

Deserialize and process GAP submessage.

Parameters

subheader	Already deserialized subheader
dser	Deserializer
processor_state	Processor state

Returns: ReturnCode with processing status

◆ process_header_extension_submessage()

static ReturnCode eprosima::safedds::protocol::rtps::Processor::process_header_extension_submessage	(	const SubmessageHeader &	subheader,
		const memory::IConstByteArrayView &	message,
		serialization::IDeserializer &	submsg_dser,
		ProcessorState &	processor_state
	)

staticprotectednoexcept

Deserialize and process HEADER_HE submessage.

Parameters

	subheader	Already deserialized subheader
	message	Complete RTPS message view
	submsg_dser	Deserializer with encapsulated RTPS submessage
[in,out]	processor_state	Processor state to modify

Returns: ReturnCode with processing status

◆ process_heartbeat_submessage()

ReturnCode eprosima::safedds::protocol::rtps::Processor::process_heartbeat_submessage	(	const SubmessageHeader &	subheader,
		serialization::IDeserializer &	dser,
		const ProcessorState &	processor_state
	)

protectednoexcept

Deserialize and process HEARTBEAT submessage.

Parameters

subheader	Already deserialized subheader
dser	Deserializer
processor_state	Processor state

Returns: ReturnCode with processing status

◆ process_infodst_submessage()

static ReturnCode eprosima::safedds::protocol::rtps::Processor::process_infodst_submessage	(	const SubmessageHeader &	subheader,
		serialization::IDeserializer &	dser,
		ProcessorState &	processor_state
	)

staticprotectednoexcept

Deserialize and process INFO_DST submessage.

Parameters

	subheader	Already deserialized subheader
	dser	Deserializer
[in,out]	processor_state	Processor state to modify

Returns: ReturnCode with processing status

◆ process_infosrc_submessage()

static ReturnCode eprosima::safedds::protocol::rtps::Processor::process_infosrc_submessage	(	const SubmessageHeader &	subheader,
		serialization::IDeserializer &	dser,
		ProcessorState &	processor_state
	)

staticprotectednoexcept

Deserialize and process INFO_SCR submessage.

Parameters

	subheader	Already deserialized subheader
	dser	Deserializer
[in,out]	processor_state	Processor state to modify

Returns: ReturnCode with processing status

◆ process_infots_submessage()

static ReturnCode eprosima::safedds::protocol::rtps::Processor::process_infots_submessage	(	const SubmessageHeader &	subheader,
		serialization::IDeserializer &	dser,
		ProcessorState &	processor_state
	)

staticprotectednoexcept

Deserialize and process INFO_TS submessage.

Parameters

	subheader	Already deserialized subheader
	dser	Deserializer
[in,out]	processor_state	Processor state to modify

Returns: ReturnCode with processing status

◆ process_message()

ReturnCode eprosima::safedds::protocol::rtps::Processor::process_message ( const memory::IConstByteArrayView & message )

overridevirtualnoexcept

Process the wire protocol message.

Parameters

message view list with the message buffer, size shall be adjusted to message payload

Returns: ReturnCode

Implements eprosima::safedds::protocol::IProcessor.

◆ process_nackfrag_submessage()

ReturnCode eprosima::safedds::protocol::rtps::Processor::process_nackfrag_submessage	(	const SubmessageHeader &	subheader,
		serialization::IDeserializer &	dser,
		const ProcessorState &	processor_state
	)

protectednoexcept

Deserialize and process NACKFRAG submessage.

Parameters

subheader	Already deserialized subheader
dser	Deserializer
processor_state	Processor state

Returns: ReturnCode with processing status

◆ process_next_submessage()

ReturnCode eprosima::safedds::protocol::rtps::Processor::process_next_submessage	(	serialization::IDeserializer &	dser,
		const memory::IConstByteArrayView &	message,
		ProcessorState &	processor_state
	)

protectednoexcept

Process next submessage in deserializer.

Parameters

	dser	Deserializer interface
	message	Complete RTPS message view
[in,out]	processor_state	Processor state

Returns: ReturnCode with processing status

◆ process_submessage_header()

static ReturnCode eprosima::safedds::protocol::rtps::Processor::process_submessage_header	(	serialization::IDeserializer &	dser,
		SubmessageHeader &	submessage_header
	)

staticprotectednoexcept

Deserialize and process SubmessageHeader.

Parameters

	dser	Deserializer interface
[in,out]	submessage_header	SubmessageHeader to fill

Returns: ReturnCode with processing status

◆ process_unknown_submessage()

ReturnCode eprosima::safedds::protocol::rtps::Processor::process_unknown_submessage	(	const memory::IConstByteArrayView &	submessage,
		ProcessorState &	processor_state
	)

protectednoexcept

Deserialize and process unknown RTPS submessage

Parameters

	submessage	Complete RTPS submessage view
[in,out]	processor_state	Processor state to modify

Returns: ReturnCode with processing status

◆ validate_processor_state()

static ReturnCode eprosima::safedds::protocol::rtps::Processor::validate_processor_state ( const ProcessorState & processor_state )

staticprotectednoexcept

Checks current processor state.

Parameters

processor_state Current processor state

Returns: ReturnCode

◆ validate_rtps_message()

static ReturnCode eprosima::safedds::protocol::rtps::Processor::validate_rtps_message	(	Submessage< HeaderExtension > &	header_extension,
		const memory::IConstByteArrayView &	message,
		serialization::IDeserializer &	submsg_dser,
		ProcessorState &	processor_state
	)

staticprotectednoexcept

Validate a RTPS message using a header extension submessage.

Parameters

	header_extension	Processed HeaderExtension sub message
	message	Complete RTPS message view
	submsg_dser	Submessage deserializer at start of header extension checksum
[in,out]	processor_state	Current processor state to modify

Returns: ReturnCode

Member Data Documentation

◆ acknack_processor_

IProcessAckNack* eprosima::safedds::protocol::rtps::Processor::acknack_processor_

protected

Pointer to acknack processor.

◆ data_processor_

IProcessData* eprosima::safedds::protocol::rtps::Processor::data_processor_

protected

Pointer to data processor.

◆ datafrag_processor_

IProcessDataFrag* eprosima::safedds::protocol::rtps::Processor::datafrag_processor_

protected

Pointer to datafrag processor.

◆ gap_processor_

IProcessGap* eprosima::safedds::protocol::rtps::Processor::gap_processor_

protected

Pointer to gap processor.

◆ heartbeat_processor_

IProcessHeartbeat* eprosima::safedds::protocol::rtps::Processor::heartbeat_processor_

protected

Pointer to heartbeat processor.

◆ nackfrag_processor_

IProcessNackFrag* eprosima::safedds::protocol::rtps::Processor::nackfrag_processor_

protected

Pointer to nackfrag processor.

◆ processor_properties_

ProcessorProperties eprosima::safedds::protocol::rtps::Processor::processor_properties_

protected

Configured processor properties.

◆ unknown_processor_

IProcessUnknown* eprosima::safedds::protocol::rtps::Processor::unknown_processor_

protected

Pointer to unknown processor.

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

build/docs/user_manual/main/tmp/include/safedds/protocol/rtps/Processor.hpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Processor() [1/6]

◆ Processor() [2/6]

◆ Processor() [3/6]

◆ Processor() [4/6]

◆ ~Processor()

◆ Processor() [5/6]

◆ Processor() [6/6]

Member Function Documentation

◆ handle_submessage()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ process_acknack_submessage()

◆ process_data_submessage()

◆ process_datafrag_submessage()

◆ process_gap_submessage()

◆ process_header_extension_submessage()

◆ process_heartbeat_submessage()

◆ process_infodst_submessage()

◆ process_infosrc_submessage()

◆ process_infots_submessage()

◆ process_message()

◆ process_nackfrag_submessage()

◆ process_next_submessage()

◆ process_submessage_header()

◆ process_unknown_submessage()

◆ validate_processor_state()

◆ validate_rtps_message()

Member Data Documentation

◆ acknack_processor_

◆ data_processor_

◆ datafrag_processor_

◆ gap_processor_

◆ heartbeat_processor_

◆ nackfrag_processor_

◆ processor_properties_

◆ unknown_processor_