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

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.

Parameters:

[in]	self	UDP Transform instance that creates the transformation
[out]	context	Pointer to a transformation context
[in]	destination	Destination address for the transformation
[in]	user_data	The user_data the rule was asserted with
[in]	property	UDP transform specific properties
[out]	ec	User 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]	self	UDP Transform instance that creates the transformation
[out]	context	Pointer to a transformation context
[in]	source	Source address for the transformation
[in]	user_data	The user_data the rule was asserted with
[in]	property	UDP transform specific properties
[out]	ec	User 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]	self	UDP Transform instance that creates the transformation
[out]	context	Pointer to a transformation context
[in]	destination	Destination address for the transformation
[out]	ec	User 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]	self	UDP Transform instance that creates the transformation
[out]	context	Pointer to a transformation context
[in]	source	Source address for the transformation
[out]	ec	User 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]	self	UDP_Transform_T that performs the transformation
[in]	source	Source address for the transformation
[in]	context	Reference to context created by create_source_transform
[in]	packet_in	The NETIO packet to transform
[out]	packet_out	The transformed NETIO packet
[out]	ec	User 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]	self	UDP_Transform_T that performs the transformation
[in]	destination	Destination address for the transformation
[in]	context	Reference to context created by create_destination_transform
[in]	packet_in	The NETIO packet to transform
[out]	packet_out	The transformed NETIO packet
[out]	ec	User 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]	self	UDP Transform instance that creates the transformation
[out]	context	Pointer to a transformation context
[in]	destination	Destination address for the transformation
[in]	user_data	The user_data the rule was asserted with
[in]	property	UDP transform specific properties
[out]	ec	User 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]	self	UDP Transform instance that creates the transformation
[out]	context	Pointer to a transformation context
[in]	source	Source address for the transformation
[in]	user_data	The user_data the rule was asserted with
[in]	property	UDP transform specific properties
[out]	ec	User 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]	self	UDP_Transform_T that performs the transformation
[in]	source	Source address for the transformation
[in]	context	Reference to context created by create_source_transform
[in]	packet_in	The NETIO packet to transform
[out]	packet_out	The transformed NETIO packet
[out]	ec	User 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]	self	UDP_Transform_T that performs the transformation
[in]	destination	Destination address for the transformation
[in]	context	Reference to context created by create_destination_transform
[in]	packet_in	The NETIO packet to transform
[out]	packet_out	The transformed NETIO packet
[out]	ec	User 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]	self	UDP Transform instance that creates the transformation
[out]	context	Pointer to a transformation context
[in]	destination	Destination address for the transformation
[out]	ec	User 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]	self	UDP Transform instance that creates the transformation
[out]	context	Pointer to a transformation context
[in]	source	Source address for the transformation
[out]	ec	User 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.

Data Structures

Macros

Typedefs

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Variable Documentation