Safe DDS
eprosima::safedds::dds::TypeSupport Interface Referenceabstract

Type support interface. More...

#include <TypeSupport.hpp>

Public Member Functions

virtual ReturnCode register_type (DomainParticipant &participant, const memory::IStringView &type_name) noexcept=0
 Register type on participant. More...
 
virtual const memory::IStringViewget_type_name () const noexcept=0
 Get type name. More...
 
virtual bool has_keys () const noexcept=0
 Get if type is keyed. More...
 
virtual protocol::KeyHash compute_key_hash (const memory::IConstByteArrayView &buffer, const protocol::PayloadKind &payload_kind) const noexcept=0
 Get the key hash value from an incoming payload. More...
 
virtual size_t max_serialized_size () const noexcept=0
 Get the maximum serialized size of the type. More...
 

Protected Member Functions

 ~TypeSupport () noexcept=default
 Protected destructor ownership defined on creation.
 
 TypeSupport () noexcept=default
 Default creation.
 
 TypeSupport (const TypeSupport &) noexcept=delete
 Copy deleted.
 
 TypeSupport (TypeSupport &&) noexcept=delete
 Movement deleted.
 
TypeSupportoperator= (const TypeSupport &) noexcept=delete
 Copy operator deleted.
 
TypeSupportoperator= (TypeSupport &&) noexcept=delete
 Movement operator deleted.
 

Detailed Description

Type support interface.

Member Function Documentation

◆ compute_key_hash()

virtual protocol::KeyHash eprosima::safedds::dds::TypeSupport::compute_key_hash ( const memory::IConstByteArrayView buffer,
const protocol::PayloadKind &  payload_kind 
) const
pure virtualnoexcept

Get the key hash value from an incoming payload.

Parameters
bufferconst view.
payload_kindpayload kind.
Returns
KeyHash.

◆ get_type_name()

virtual const memory::IStringView& eprosima::safedds::dds::TypeSupport::get_type_name ( ) const
pure virtualnoexcept

Get type name.

Returns
const memory::IStringView &.

◆ has_keys()

virtual bool eprosima::safedds::dds::TypeSupport::has_keys ( ) const
pure virtualnoexcept

Get if type is keyed.

Returns
true if type is keyed, false otherwise.

◆ max_serialized_size()

virtual size_t eprosima::safedds::dds::TypeSupport::max_serialized_size ( ) const
pure virtualnoexcept

Get the maximum serialized size of the type.

Returns
size_t.

◆ register_type()

virtual ReturnCode eprosima::safedds::dds::TypeSupport::register_type ( DomainParticipant participant,
const memory::IStringView type_name 
)
pure virtualnoexcept

Register type on participant.

Parameters
[in,out]participantparticipant where register type.
[in]type_nametype id.
Returns
ReturnCode.

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