RTI Connext DDS Micro  Version 2.4.11
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Typedefs | Variables
UDP Transform API
Reference Manuals

Data Structures

struct  UDP_TransformI
 UDP Transformation interface. More...

Typedefs

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)
 Add a destination transformation.
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)
 Add a source transformation.
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)
 Delete a destination transformation.
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)
 Delete a source transformation.
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)
 Add a source address rule for incoming payloads.
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)
 Add an source address rule for incoming payloads.

Variables

UDP_TransformI_create_destination_transform UDP_TransformI::create_destination_transform
 Add a destination transformation.
UDP_TransformI_create_source_transform UDP_TransformI::create_source_transform
 Add a source transformation.
UDP_TransformI_transform_source UDP_TransformI::transform_source
 Add a source address rule for incoming payloads.
UDP_TransformI_transform_destination UDP_TransformI::transform_destination
 Add an source address rule for incoming payloads.
UDP_TransformI_delete_destination_transform UDP_TransformI::delete_destination_transform
 Delete a destination transformation.
UDP_TransformI_delete_source_transform UDP_TransformI::delete_source_transform
 Delete a source transformation.

Detailed Description

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

Typedef Documentation

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)

Add a destination transformation.

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)

Add a source transformation.

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)

Delete a destination transformation.

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)

Delete a source transformation.

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)

Add a source address rule for incoming payloads.

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)

Add an source address rule for incoming payloads.

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

UDP_TransformI_create_destination_transform UDP_TransformI::create_destination_transform

Add a destination transformation.

Method to create a new destination transform

UDP_TransformI_create_source_transform UDP_TransformI::create_source_transform

Add a source transformation.

Method to create a new source transform

UDP_TransformI_transform_source UDP_TransformI::transform_source

Add a source address rule for incoming payloads.

Method to transform a payload from a source

UDP_TransformI_transform_destination UDP_TransformI::transform_destination

Add an source address rule for incoming payloads.

Method to transform a payload to a destination

UDP_TransformI_delete_destination_transform UDP_TransformI::delete_destination_transform

Delete a destination transformation.

Method to delete a destination transform

UDP_TransformI_delete_source_transform UDP_TransformI::delete_source_transform

Delete a source transformation.

Method to delete a source transform

RTI Connext DDS Micro Version 2.4.11 Copyright © Mon Jul 23 2018 Real-Time Innovations, Inc