RTI Connext Micro C API  2.4.14.2
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
UDP Transform API

Data Structures

struct  UDP_Transform
 Base-class for instances of a transform library. More...
struct  UDP_TransformProperty
 Base-class for instances of a transform library. More...
struct  UDP_TransformRule
 Transformstion Rule. More...

Macros

#define UDP_TransformProperty_INITIALIZER
 UDP_TransformProperty initializer.
#define UDP_TransformRuleSeq_INITIALIZER   REDA_DEFINE_SEQUENCE_INITIALIZER(struct UDP_TransformRule)
 UDP_TransformRuleSeq initializer.

Typedefs

typedef struct UDP_Transform UDP_Transform_T
 Base-class for instances of a transform library.
typedef RTI_BOOL(* UDP_TransformI_create_destination_transform )(UDP_Transform_T *const self, void **const context, const struct NETIO_Address *const destination, const struct NETIO_Netmask *const netmask, void *user_data, const struct UDP_TransformProperty *const property, RTI_INT32 *const ec)
 Method to create a new destination transform.
typedef RTI_BOOL(* UDP_TransformI_create_source_transform )(UDP_Transform_T *const self, void **const context, const struct NETIO_Address *const source, const struct NETIO_Netmask *const netmask, void *user_data, const struct UDP_TransformProperty *const property, RTI_INT32 *const ec)
 Method to create a new source transform.
typedef RTI_BOOL(* UDP_TransformI_delete_destination_transform )(UDP_Transform_T *const self, void *context, const struct NETIO_Address *const destination, const struct NETIO_Netmask *const netmask, RTI_INT32 *const ec)
 Method to delete a destination transform.
typedef RTI_BOOL(* UDP_TransformI_delete_source_transform )(UDP_Transform_T *const self, void *context, const struct NETIO_Address *const source, const struct NETIO_Netmask *const netmask, RTI_INT32 *const ec)
 Method to delete a source transform.
typedef RTI_BOOL(* UDP_TransformI_transform_source )(UDP_Transform_T *const self, void *context, const struct NETIO_Address *const source, const NETIO_Packet_T *const in_packet, NETIO_Packet_T **out_packet, RTI_INT32 *const ec)
 Method to transform a payload from a source.
typedef RTI_BOOL(* UDP_TransformI_transform_destination )(UDP_Transform_T *const self, void *context, const struct NETIO_Address *const destination, const NETIO_Packet_T *const in_packet, NETIO_Packet_T **out_packet, RTI_INT32 *const ec)
 Method to transform a payload to a destination.

Variables

RTI_INT32 UDP_TransformProperty::max_send_message_size
 Max message size that will be sent.
RTI_INT32 UDP_TransformProperty::max_receive_message_size
 Max message size that will be received.
UDP_TransformI_create_destination_transform UDP_TransformI::create_destination_transform
 Method to create a new destination transform.
UDP_TransformI_create_source_transform UDP_TransformI::create_source_transform
 Method to create a new source transform.
UDP_TransformI_transform_source UDP_TransformI::transform_source
 Method to transform a payload from a source.
UDP_TransformI_transform_destination UDP_TransformI::transform_destination
 Method to transform a payload to a destination.
UDP_TransformI_delete_destination_transform UDP_TransformI::delete_destination_transform
 Method to delete a destination transform.
UDP_TransformI_delete_source_transform UDP_TransformI::delete_source_transform
 Method to delete a source transform.
struct NETIO_Address UDP_TransformRule::address
 The address the rule applices to.
struct NETIO_Netmask UDP_TransformRule::netmask
 The netmask to apply to the address.
RT_ComponentFactoryId_T UDP_TransformRule::transformation
 The transformation to apply to a matching address after the netmask has been applied.
void * UDP_TransformRule::user_data
 An opaque user_data pointer passed to the transformation function.

Detailed Description

<<eXtension>> <<cert>> The UDP transform API enables custom transformation of UDP incoming and outgoing UDP datagrams. Please refer to User Manual for the User Manual and how to use the UDP transforms.


Macro Definition Documentation

#define UDP_TransformProperty_INITIALIZER
Value:
{ \
RT_ComponentProperty_INITIALIZER,\
-1,\
-1 \
}

UDP_TransformProperty initializer.

#define UDP_TransformRuleSeq_INITIALIZER   REDA_DEFINE_SEQUENCE_INITIALIZER(struct UDP_TransformRule)

UDP_TransformRuleSeq initializer.


Typedef Documentation

Base-class for instances of a transform library.

typedef RTI_BOOL(* UDP_TransformI_create_destination_transform)(UDP_Transform_T *const self, void **const context, const struct NETIO_Address *const destination, const struct NETIO_Netmask *const netmask, void *user_data, const struct UDP_TransformProperty *const property, RTI_INT32 *const ec)

Method to create a new destination transform.

Parameters:
[in]selfUDP Transform instance that creates the transformation
[out]contextPointer to a transformation context
[in]destinationDestination address for the transformation
[in]user_dataThe user_data the rule was asserted with
[in]propertyUDP transform specific properties
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
typedef RTI_BOOL(* UDP_TransformI_create_source_transform)(UDP_Transform_T *const self, void **const context, const struct NETIO_Address *const source, const struct NETIO_Netmask *const netmask, void *user_data, const struct UDP_TransformProperty *const property, RTI_INT32 *const ec)

Method to create a new source transform.

Parameters:
[in]selfUDP Transform instance that creates the transformation
[out]contextPointer to a transformation context
[in]sourceSource address for the transformation
[in]user_dataThe user_data the rule was asserted with
[in]propertyUDP transform specific properties
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
typedef RTI_BOOL(* UDP_TransformI_delete_destination_transform)(UDP_Transform_T *const self, void *context, const struct NETIO_Address *const destination, const struct NETIO_Netmask *const netmask, RTI_INT32 *const ec)

Method to delete a destination transform.

Parameters:
[in]selfUDP Transform instance that creates the transformation
[out]contextPointer to a transformation context
[in]destinationDestination address for the transformation
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
typedef RTI_BOOL(* UDP_TransformI_delete_source_transform)(UDP_Transform_T *const self, void *context, const struct NETIO_Address *const source, const struct NETIO_Netmask *const netmask, RTI_INT32 *const ec)

Method to delete a source transform.

Parameters:
[in]selfUDP Transform instance that creates the transformation
[out]contextPointer to a transformation context
[in]sourceSource address for the transformation
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
typedef RTI_BOOL(* UDP_TransformI_transform_source)(UDP_Transform_T *const self, void *context, const struct NETIO_Address *const source, const NETIO_Packet_T *const in_packet, NETIO_Packet_T **out_packet, RTI_INT32 *const ec)

Method to transform a payload from a source.

Parameters:
[in]selfUDP_Transform_T that performs the transformation
[in]sourceSource address for the transformation
[in]contextReference to context created by create_source_transform
[in]packet_inThe NETIO packet to transform
[out]packet_outThe transformed NETIO packet
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
typedef RTI_BOOL(* UDP_TransformI_transform_destination)(UDP_Transform_T *const self, void *context, const struct NETIO_Address *const destination, const NETIO_Packet_T *const in_packet, NETIO_Packet_T **out_packet, RTI_INT32 *const ec)

Method to transform a payload to a destination.

Parameters:
[in]selfUDP_Transform_T that performs the transformation
[in]destinationDestination address for the transformation
[in]contextReference to context created by create_destination_transform
[in]packet_inThe NETIO packet to transform
[out]packet_outThe transformed NETIO packet
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure

Variable Documentation

RTI_INT32 UDP_TransformProperty::max_send_message_size

Max message size that will be sent.

RTI_INT32 UDP_TransformProperty::max_receive_message_size

Max message size that will be received.

UDP_TransformI_create_destination_transform UDP_TransformI::create_destination_transform

Method to create a new destination transform.

Parameters:
[in]selfUDP Transform instance that creates the transformation
[out]contextPointer to a transformation context
[in]destinationDestination address for the transformation
[in]user_dataThe user_data the rule was asserted with
[in]propertyUDP transform specific properties
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
UDP_TransformI_create_source_transform UDP_TransformI::create_source_transform

Method to create a new source transform.

Parameters:
[in]selfUDP Transform instance that creates the transformation
[out]contextPointer to a transformation context
[in]sourceSource address for the transformation
[in]user_dataThe user_data the rule was asserted with
[in]propertyUDP transform specific properties
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
UDP_TransformI_transform_source UDP_TransformI::transform_source

Method to transform a payload from a source.

Parameters:
[in]selfUDP_Transform_T that performs the transformation
[in]sourceSource address for the transformation
[in]contextReference to context created by create_source_transform
[in]packet_inThe NETIO packet to transform
[out]packet_outThe transformed NETIO packet
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
UDP_TransformI_transform_destination UDP_TransformI::transform_destination

Method to transform a payload to a destination.

Parameters:
[in]selfUDP_Transform_T that performs the transformation
[in]destinationDestination address for the transformation
[in]contextReference to context created by create_destination_transform
[in]packet_inThe NETIO packet to transform
[out]packet_outThe transformed NETIO packet
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
UDP_TransformI_delete_destination_transform UDP_TransformI::delete_destination_transform

Method to delete a destination transform.

Parameters:
[in]selfUDP Transform instance that creates the transformation
[out]contextPointer to a transformation context
[in]destinationDestination address for the transformation
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
UDP_TransformI_delete_source_transform UDP_TransformI::delete_source_transform

Method to delete a source transform.

Parameters:
[in]selfUDP Transform instance that creates the transformation
[out]contextPointer to a transformation context
[in]sourceSource address for the transformation
[out]ecUser defined error code
Returns:
RTI_TRUE on success, RTI_FALSE on failure
struct NETIO_Address UDP_TransformRule::address

The address the rule applices to.

struct NETIO_Netmask UDP_TransformRule::netmask

The netmask to apply to the address.

RT_ComponentFactoryId_T UDP_TransformRule::transformation

The transformation to apply to a matching address after the netmask has been applied.

void* UDP_TransformRule::user_data

An opaque user_data pointer passed to the transformation function.


RTI Connext Micro C API 2.4.14.2 Copyright © Mon May 20 2024 Real-Time Innovations, Inc