RTPS Transport API

Data Structures
union	RTPS_Checksum
	<<eXtension>> <<cert>> RTPS checksum type More...
struct	RTPS_ChecksumClass
	<<eXtension>> <<cert>> Definition of a checksum function More...
struct	RTPS_ChecksumProperty
	<<eXtension>> <<cert>> Checksum properties for the RTPS plugin More...
struct	RTPS_InterfaceFactoryProperty
	<<eXtension>> <<cert>> Properties for the RTPS Transport. More...

Typedefs
typedef union RTPS_Checksum	RTPS_Checksum_T
	<<eXtension>> <<cert>> RTPS checksum type
typedef RTI_BOOL(*	RTPS_ChecksumCalculate_T )(void *context, const struct REDA_Buffer *buf, RTI_UINT32 buf_length, RTPS_Checksum_T *checksum)
	<<eXtension>> <<cert>> The checksum calculation function
typedef struct RTPS_ChecksumClass	RTPS_ChecksumClass_T
	<<eXtension>> <<cert>> Definition of a checksum function
typedef struct RTPS_InterfaceFactoryProperty	RTPS_InterfaceFactoryProperty_T
	<<eXtension>> <<cert>> Properties for the RTPS Transport.

Enumerations
enum	RTPS_ChecksumTxMode_T { RTPS_CHECKSUM_TXMODE_RTICRC32, RTPS_CHECKSUM_TXMODE_OMG }
	<<eXtension>> <<cert>> Transmit mode for checksums More...

Functions
struct RT_ComponentFactoryI *	RTPS_InterfaceFactory_get_interface (void)
	Gets the singleton instance of the RTPS interface factory.

Variables
RTI_UINT32	RTPS_Checksum::checksum32
	A 32-bit unsigned checksum in host endianess order.
RTI_UINT64	RTPS_Checksum::checksum64
	A 64-bit unsigned integer checksum in host endianess order.
RTI_UINT8	RTPS_Checksum::checksum128 [16]
	A 128-bit checksum as a 16-byte array.
RTPS_ChecksumClassId_T	RTPS_ChecksumClass::class_id
	The checksum class ID.
void *	RTPS_ChecksumClass::context
	User defined context.
RTPS_ChecksumCalculate_T	RTPS_ChecksumClass::checksum_calculate
	User defined function to calculate a checksum.
RTPS_ChecksumClass_T	RTPS_ChecksumProperty::builtin_checksum32_class
	The builtin 32-bit checksum class.
RTPS_ChecksumClass_T	RTPS_ChecksumProperty::builtin_checksum64_class
	The builtin 64-bit checksum class.
RTPS_ChecksumClass_T	RTPS_ChecksumProperty::builtin_checksum128_class
	The builtin 128-bit checksum class.
RTPS_ChecksumTxMode_T	RTPS_ChecksumProperty::checksum_tx_mode
	The transmit mode for checksums.
RTI_BOOL	RTPS_ChecksumProperty::allow_builtin_override
	If TRUE, allow overriding the builtin checksum functions.
struct RTPS_ChecksumProperty	RTPS_InterfaceFactoryProperty::checksum
	The checksum properties for RTPS.
struct RTPS_InterfaceFactoryProperty	RTPS_INTERFACE_FACTORY_DEFAULT
	<<eXtension>> <<cert>> Default properties for the RTPS Transport.

---

Detailed Description

<<eXtension>> <<cert>> The RTPS Plugin implements the RTI Connext Micro RTPS protocol as an RTI Connext Micro NETIO interface.

---

Typedef Documentation

typedef union RTPS_Checksum RTPS_Checksum_T

<<eXtension>> <<cert>> RTPS checksum type

typedef RTI_BOOL(* RTPS_ChecksumCalculate_T)(void *context, const struct REDA_Buffer *buf, RTI_UINT32 buf_length, RTPS_Checksum_T *checksum)

<<eXtension>> <<cert>> The checksum calculation function

Parameters:

[in]	context	Context passed as property
[in]	buf	Vector of buffers to calculate the checksum over
[in]	buf_length	Number of elements in buf
[out]	checksum	Calculated checksum

Returns:

RTI_TRUE on success, RTI_FALSE on failure

typedef struct RTPS_ChecksumClass RTPS_ChecksumClass_T

<<eXtension>> <<cert>> Definition of a checksum function

typedef struct RTPS_InterfaceFactoryProperty RTPS_InterfaceFactoryProperty_T

<<eXtension>> <<cert>> Properties for the RTPS Transport.

---

Enumeration Type Documentation

enum RTPS_ChecksumTxMode_T

<<eXtension>> <<cert>> Transmit mode for checksums

Enumerator:

RTPS_CHECKSUM_TXMODE_RTICRC32	Always use CRC32, fail if not possible.
RTPS_CHECKSUM_TXMODE_OMG	Always use OMG's header extension [Default].

---

Function Documentation

struct RT_ComponentFactoryI* RTPS_InterfaceFactory_get_interface ( void  )

read

Gets the singleton instance of the RTPS interface factory.

This function gets the singleton instance of the RTPS factory that is used by the middleware to create an RTPS transport instance.

Returns:

Pointer to RTPS factory instance

MT Safety:

This operation is thread safe.

---

Variable Documentation

RTI_UINT32 RTPS_Checksum::checksum32

A 32-bit unsigned checksum in host endianess order.

RTI_UINT64 RTPS_Checksum::checksum64

A 64-bit unsigned integer checksum in host endianess order.

RTI_UINT8 RTPS_Checksum::checksum128[16]

A 128-bit checksum as a 16-byte array.

RTPS_ChecksumClassId_T RTPS_ChecksumClass::class_id

The checksum class ID.

void* RTPS_ChecksumClass::context

User defined context.

RTPS_ChecksumCalculate_T RTPS_ChecksumClass::checksum_calculate

User defined function to calculate a checksum.

RTPS_ChecksumClass_T RTPS_ChecksumProperty::builtin_checksum32_class

The builtin 32-bit checksum class.

RTPS_ChecksumClass_T RTPS_ChecksumProperty::builtin_checksum64_class

The builtin 64-bit checksum class.

RTPS_ChecksumClass_T RTPS_ChecksumProperty::builtin_checksum128_class

The builtin 128-bit checksum class.

RTPS_ChecksumTxMode_T RTPS_ChecksumProperty::checksum_tx_mode

The transmit mode for checksums.

RTI_BOOL RTPS_ChecksumProperty::allow_builtin_override

If TRUE, allow overriding the builtin checksum functions.

struct RTPS_ChecksumProperty RTPS_InterfaceFactoryProperty::checksum

The checksum properties for RTPS.

struct RTPS_InterfaceFactoryProperty RTPS_INTERFACE_FACTORY_DEFAULT

<<eXtension>> <<cert>> Default properties for the RTPS Transport.