TransportSupport Class Reference
[Using Transport Plugins]

<<interface>> The utility class used to configure RTI Connext pluggable transports. More...

List of all members.

Static Public Member Functions
static void	get_builtin_transport_property (DomainParticipant participant_in, Transport.Property_t builtin_transport_property_inout)
	Get the properties used to create a builtin transport plugin.
static void	set_builtin_transport_property (DomainParticipant participant_in, Transport.Property_t builtin_transport_property_in)
	Set the properties used to create a builtin transport plugin.

---

Detailed Description

<<interface>> The utility class used to configure RTI Connext pluggable transports.

---

Member Function Documentation

static void get_builtin_transport_property	(	DomainParticipant	participant_in,
		Transport.Property_t	builtin_transport_property_inout
	)			[static]

Get the properties used to create a builtin transport plugin.

Retrieves the properties that will be used to create a builtin transport plugin.

Precondition:

The builtin_transport_property_inout parameter must be of the type specified by the builtin_transport_kind_in.

Parameters:

participant_in

<<in>> A valid non-null com.rti.dds.domain.DomainParticipant

Parameters:

builtin_transport_property_inout

<<inout>> The storage area where the retrieved property will be output. The specific type required by the builtin_transport_kind_in must be used.

Returns:

One of the Standard Return Codes, or RETCODE_PRECONDITION_NOT_MET.

See also:

TransportSupport.set_builtin_transport_property()

static void set_builtin_transport_property	(	DomainParticipant	participant_in,
		Transport.Property_t	builtin_transport_property_in
	)			[static]

Set the properties used to create a builtin transport plugin.

Specifies the properties that will be used to create a builtin transport plugin.

If the builtin transport is already registered when this operation is called, these property changes will not have any effect. Builtin transport properties should always be set before the transport is registered. See Built-in Transport Plugins for details on when a builtin transport is registered.

Precondition:

A disabled com.rti.dds.domain.DomainParticipant. The builtin_transport_property_inout parameter must be of the type specified by the builtin_transport_kind_in.

Parameters:

participant_in

<<in>> A valid non-null com.rti.dds.domain.DomainParticipant that has not been enabled.

Parameters:

builtin_transport_property_in

<<inout>> The new transport property that will be used to the create the builtin transport plugin. The specific type required by the builtin_transport_kind_in must be used.

Returns:

One of the Standard Return Codes, or RETCODE_PRECONDITION_NOT_MET.

See also:

TransportSupport.get_builtin_transport_property()