|
RTI Connext C API
Version 5.1.0
|
Base structure that must be inherited by derived Transport Plugin classes. More...
Data Fields | |
| NDDS_Transport_ClassId_t | classid |
| The Transport-Plugin Class ID. | |
| RTI_INT32 | address_bit_count |
| Number of bits in a 16-byte address that are used by the transport. Should be between 0 and 128. | |
| RTI_INT32 | properties_bitmap |
| A bitmap that defines various properties of the transport to the RTI Connext core. | |
| RTI_INT32 | gather_send_buffer_count_max |
Specifies the maximum number of buffers that RTI Connext can pass to the send() function of a transport plugin. | |
| RTI_INT32 | message_size_max |
| The maximum size of an RTPS message in bytes that can be sent or received by the transport plugin. | |
| char ** | allow_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., allow_interfaces_list_length > 0), allow the use of only these interfaces. If the list is empty, allow the use of all interfaces. | |
| RTI_INT32 | allow_interfaces_list_length |
Number of elements in the allow_interfaces_list. | |
| char ** | deny_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., deny_interfaces_list_length > 0), deny the use of these interfaces. | |
| RTI_INT32 | deny_interfaces_list_length |
Number of elements in the deny_interfaces_list. | |
| char ** | allow_multicast_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., allow_multicast_interfaces_list_length > 0), allow the use of multicast only on these interfaces; otherwise allow the use of all the allowed interfaces. | |
| RTI_INT32 | allow_multicast_interfaces_list_length |
Number of elements in the allow_multicast_interfaces_list. | |
| char ** | deny_multicast_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., deny_multicast_interfaces_list_length > 0), deny the use of those interfaces for multicast. | |
| RTI_INT32 | deny_multicast_interfaces_list_length |
Number of elements in deny_multicast_interfaces_list. | |
Base structure that must be inherited by derived Transport Plugin classes.
This structure contains properties that must be set before registration of any transport plugin with RTI Connext. The RTI Connext core will configure itself to use the plugin based on the properties set within this structure.
A transport plugin may extend from this structure to add transport-specific properties.
In the C-language, this can be done by creating a custom plugin property structure whose first member is a NDDS_Transport_Property_t structure.
For example,
WARNING: The transport properties of an instance of a Transport Plugin should be considered immutable after the plugin has been created. That means the values contained in the property structure stored as a part of the transport plugin itself should not be changed. If those values are modified, the results are undefined.
| NDDS_Transport_ClassId_t NDDS_Transport_Property_t::classid |
The Transport-Plugin Class ID.
Assigned by the implementor of the transport plugin, Class ID's below NDDS_TRANSPORT_CLASSID_RESERVED_RANGE are reserved for RTI (Real-Time Innovations) usage.
User-defined transports should set an ID above this range.
The ID should be globally unique for each Transport-Plugin class. Transport-Plugin implementors should ensure that the class IDs do not conflict with each other amongst different Transport-Plugin classes.
classid is invariant for the lifecycle of a transport plugin. | RTI_INT32 NDDS_Transport_Property_t::address_bit_count |
Number of bits in a 16-byte address that are used by the transport. Should be between 0 and 128.
A transport plugin should define the range of addresses (starting from 0x0) that are meaningful to the plugin. It does this by setting the number of bits of an IPv6 address that will be used to designate an address in the network to which the transport plugin is connected.
For example, for an address range of 0-255, the address_bit_count should be set to 8. For the range of addresses used by IPv4 (4 bytes), it should be set to 32.
| RTI_INT32 NDDS_Transport_Property_t::properties_bitmap |
A bitmap that defines various properties of the transport to the RTI Connext core.
Currently, the only property supported is whether or not the transport plugin will always loan a buffer when RTI Connext tries to receive a message using the plugin. This is in support of a zero-copy interface.
| RTI_INT32 NDDS_Transport_Property_t::gather_send_buffer_count_max |
Specifies the maximum number of buffers that RTI Connext can pass to the send() function of a transport plugin.
The transport plugin send() API supports a gather-send concept, where the send() call can take several discontiguous buffers, assemble and send them in a single message. This enables RTI Connext to send a message from parts obtained from different sources without first having to copy the parts into a single contiguous buffer.
However, most transports that support a gather-send concept have an upper limit on the number of buffers that can be gathered and sent. Setting this value will prevent RTI Connext from trying to gather too many buffers into a send call for the transport plugin.
RTI Connext requires all transport-plugin implementations to support a gather-send of least a minimum number of buffers. This minimum number is defined to be NDDS_TRANSPORT_PROPERTY_GATHER_SEND_BUFFER_COUNT_MIN.
If the underlying transport does not support a gather-send concept directly, then the transport plugin itself must copy the separate buffers passed into the send() call into a single buffer for sending or otherwise send each buffer individually. However this is done by the transport plugin, the receive_rEA() call of the destination application should assemble, if needed, all of the pieces of the message into a single buffer before the message is passed to the RTI Connext layer.
| RTI_INT32 NDDS_Transport_Property_t::message_size_max |
The maximum size of an RTPS message in bytes that can be sent or received by the transport plugin.
If the maximum size of a message that can be sent by a transport plugin is user configurable, the transport plugin should provide a default value for this property. In any case, this value must be set before the transport plugin is registered, so that RTI Connext can properly use the plugin.
| char** NDDS_Transport_Property_t::allow_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., allow_interfaces_list_length > 0), allow the use of only these interfaces. If the list is empty, allow the use of all interfaces.
The "white" list restricts reception to a particular set of interfaces for unicast UDP.
Multicast output will be sent and may be received over the interfaces in the list.
It is up to the transport plugin to interpret the list of strings passed in.
For example, the following are acceptable strings in IPv4 format: 192.168.1.1, 192.168.1.*, 192.168.*, 192.*, ether0
This property is not interpreted by the RTI Connext core; it is provided merely as a convenient and standardized way to specify the interfaces for the benefit of the transport plugin developer and user.
The caller (user) must manage the memory of the list. The memory may be freed after the DDS_DomainParticipant is deleted.
| RTI_INT32 NDDS_Transport_Property_t::allow_interfaces_list_length |
Number of elements in the allow_interfaces_list.
By default, allow_interfaces_list_length = 0, i.e. an empty list.
This property is not interpreted by the RTI Connext core; it is provided merely as a convenient and standardized way to specify the interfaces for the benefit of the transport plugin developer and user.
| char** NDDS_Transport_Property_t::deny_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., deny_interfaces_list_length > 0), deny the use of these interfaces.
This "black" list is applied after the allow_interfaces_list and filters out the interfaces that should not be used.
The resulting list restricts reception to a particular set of interfaces for unicast UDP. Multicast output will be sent and may be received over the interfaces in the list.
It is up to the transport plugin to interpret the list of strings passed in.
For example, the following are acceptable strings in IPv4 format: 192.168.1.1, 192.168.1.*, 192.168.*, 192.*, ether0
This property is not interpreted by the RTI Connext core; it is provided merely as a convenient and standardized way to specify the interfaces for the benefit of the transport plugin developer and user.
The caller (user) must manage the memory of the list. The memory may be freed after the DDS_DomainParticipant is deleted.
| RTI_INT32 NDDS_Transport_Property_t::deny_interfaces_list_length |
Number of elements in the deny_interfaces_list.
By default, deny_interfaces_list_length = 0 (i.e., an empty list).
This property is not interpreted by the RTI Connext core; it is provided merely as a convenient and standardized way to specify the interfaces for the benefit of the transport plugin developer and user.
| char** NDDS_Transport_Property_t::allow_multicast_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., allow_multicast_interfaces_list_length > 0), allow the use of multicast only on these interfaces; otherwise allow the use of all the allowed interfaces.
This "white" list sub-selects from the allowed interfaces obtained after applying the allow_interfaces_list "white" list and the deny_interfaces_list "black" list.
After allow_multicast_interfaces_list, the deny_multicast_interfaces_list is applied. Multicast output will be sent and may be received over the interfaces in the resulting list.
If this list is empty, all the allowed interfaces will be potentially used for multicast. It is up to the transport plugin to interpret the list of strings passed in.
This property is not interpreted by the RTI Connext core; it is provided merely as a convenient and standardized way to specify the interfaces for the benefit of the transport plugin developer and user.
The caller (user) must manage the memory of the list. The memory may be freed after the DDS_DomainParticipant is deleted.
| RTI_INT32 NDDS_Transport_Property_t::allow_multicast_interfaces_list_length |
Number of elements in the allow_multicast_interfaces_list.
By default, allow_multicast_interfaces_list_length = 0 (i.e., an empty list).
This property is not interpreted by the RTI Connext core; it is provided merely as a convenient and standardized way to specify the interfaces for the benefit of the transport plugin developer and user.
| char** NDDS_Transport_Property_t::deny_multicast_interfaces_list |
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., deny_multicast_interfaces_list_length > 0), deny the use of those interfaces for multicast.
This "black" list is applied after allow_multicast_interfaces_list and filters out interfaces that should not be used for multicast.
Multicast output will be sent and may be received over the interfaces in the resulting list.
It is up to the transport plugin to interpret the list of strings passed in.
This property is not interpreted by the RTI Connext core; it is provided merely as a convenient and standardized way to specify the interfaces for the benefit of the transport plugin developer and user.
The caller (user) must manage the memory of the list. The memory may be freed after the DDS_DomainParticipant is deleted.
| RTI_INT32 NDDS_Transport_Property_t::deny_multicast_interfaces_list_length |
Number of elements in deny_multicast_interfaces_list.
By default, deny_multicast_interfaces_list_length = 0 (i.e., an empty list).
This property is not interpreted by the RTI Connext core; it is provided merely as a convenient and standardized way to specify the interfaces for the benefit of the transport plugin developer and user.
RTI Connext C API Version 5.1.0
Copyright © Mon Feb 3 2014
Real-Time Innovations, Inc