6. Transport Descriptor

namespace transport_descriptor

Functions

std::string print(const std::string &transport_descriptor_id)

Parse XML file and print specific transport descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier. If empty, every transport descriptor profile is printed.

Throws
Returns

std::string XML section containing the specific transport descriptor profile.

std::string print_kind(const std::string &transport_descriptor_id)

Parse XML file and print the specific Transport Descriptor kind.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
Returns

std::string Transport Descriptor kind

std::string print_send_buffer_size(const std::string &transport_descriptor_id)

Parse XML file and print the specific Transport Descriptor send buffer size.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the send buffer size element has not been set in the profile.

Returns

std::string Transport descriptor send buffer size.

std::string print_receive_buffer_size(const std::string &transport_descriptor_id)

Parse XML file and print the specific Transport Descriptor receive buffer size.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the receive buffer size element has not been set in the profile.

Returns

std::string Transport descriptor receive buffer size.

std::string print_max_message_size(const std::string &transport_descriptor_id)

Parse XML file and print the specific Transport Descriptor maximum message size.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the maximum message size element has not been set in the profile.

Returns

std::string Transport descriptor maximum message size.

std::string print_max_initial_peers_range(const std::string &transport_descriptor_id)

Parse XML file and print the specific Transport Descriptor maximum initial peers range.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the maximum initial peers range element has not been set in the profile.

Returns

std::string Transport descriptor maximum initial peers range.

std::string print_interface_whitelist(const std::string &transport_descriptor_id, const std::string &index)

Parse XML file and print the Transport Descriptor specific whitelisted network interface element.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • index – [in] Collection element to be printed. If empty, the complete collection is printed.

Throws
Returns

std::string Transport descriptor specific network interface whitelisted.

std::string print_ttl(const std::string &transport_descriptor_id)

Parse XML file and print the specific Transport Descriptor TTL (Time to live).

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TTL element has not been set in the profile.

Returns

std::string Transport descriptor TTL in number of hops.

std::string print_non_blocking_send(const std::string &transport_descriptor_id)

Parse XML file and print the specific UDP Transport Descriptor non blocking send flag.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the non blocking send flag has not been set in the profile.

Returns

std::string Transport descriptor non blocking send flag.

std::string print_output_port(const std::string &transport_descriptor_id)

Parse XML file and print the specific UDP Transport Descriptor output port.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the output port has not been set in the profile.

Returns

std::string UDP Transport descriptor output port.

std::string print_wan_addr(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCPv4 Transport Descriptor WAN address.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the WAN address has not been set in the profile.

Returns

std::String TCPv4 Transport descriptor WAN address.

std::string print_keep_alive_frequency_ms(const std::string &transport_descriptor_id)

Parse XML file and print the specific frequency of TCP Transport Descriptor keep alive requests.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the keep alive frequency has not been set in the profile.

Returns

std::string Frequency of TCP keep alive requests (in milliseconds).

std::string print_keep_alive_timeout_ms(const std::string &transport_descriptor_id)

Parse XML file and print the specific timeout (in milliseconds) to consider a TCP connection broken if no keep alive is received.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the keep alive timeout has not been set in the profile.

Returns

std::string TCP keep alive timeout (in milliseconds).

std::string print_max_logical_port(const std::string &transport_descriptor_id)

Parse XML file and print the specific maximum number of logical ports to try during TCP negotiation.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the maximum number of logical ports has not been set in the profile.

Returns

std::string Maximum number of logical ports to try during TCP negotiation.

std::string print_logical_port_range(const std::string &transport_descriptor_id)

Parse XML file and print the specific maximum number of logical ports per request to try during TCP negotiation.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the maximum number of logical ports per request has not been set in the profile.

Returns

std::string Maximum number of logical ports per request to try during TCP negotiation.

std::string print_logical_port_increment(const std::string &transport_descriptor_id)

Parse XML file and print the specific increment between logical ports to try during TCP negotiation.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the logical port increment has not been set in the profile.

Returns

std::string Increment between logical ports to try during TCP negotiation.

std::string print_listening_ports(const std::string &transport_descriptor_id, const std::string &index)

Parse XML file and print the TCP Transport Descriptor specific listening port element.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • index – [in] Collection element to be printed. If empty, the complete collection is printed.

Throws
Returns

std::string TCP Transport descriptor specific listening port.

std::string print_tls(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS configuration.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS configuration element has not been set in the profile.

Returns

std::string XML section containing the specific TCP Transport Descriptor TLS configuration.

std::string print_tls_password(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS password.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS password element has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor TLS password.

std::string print_tls_private_key_file(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS private key certificate path.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS private key certificate path element has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor path to the TLS private key certificate file.

std::string print_tls_rsa_private_key_file(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS private key RSA certificate path.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS private key RSA certificate path element has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor path to the TLS private key RSA certificate file.

std::string print_tls_cert_chain_file(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS public certificate chain file path.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS public certificate chain file path element has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor path to the TLS public certificate chain file.

std::string print_tls_tmp_dh_file(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS Diffie-Hellman parameters file path.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS Diffie-Hellman parameters file path element has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor path to the TLS Diffie-Hellman parameters file.

std::string print_tls_verify_file(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS CA (Certification Authority) file path.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS CA file path element has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor path to the CA file.

std::string print_tls_verify_mode(const std::string &transport_descriptor_id, const std::string &index)

Parse XML file and print the TCP Transport Descriptor specific TLS verification mode element.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • index – [in] Collection element to be printed. If empty, the complete collection is printed.

Throws
Returns

std::string TCP Transport descriptor specific TLS verification mode.

std::string print_tls_options(const std::string &transport_descriptor_id, const std::string &index)

Parse XML file and print the TCP Transport Descriptor specific TLS supported feature.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • index – [in] Collection element to be printed. If empty, the complete collection is printed.

Throws
Returns

std::string TCP Transport descriptor specific TLS supported feature.

std::string print_tls_verify_paths(const std::string &transport_descriptor_id, const std::string &index)

Parse XML file and print the TCP Transport Descriptor specific TLS path to verification files.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • index – [in] Collection element to be printed. If empty, the complete collection is printed.

Throws
Returns

std::string TCP Transport descriptor specific TLS verification path.

std::string print_tls_verify_depth(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS maximum verification depth.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS verify depth element has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor maximum allowed depth for verifying intermediate certificates.

std::string print_tls_default_verify_path(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS verify default paths flag.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS verify default paths flag has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor verify default paths flag.

std::string print_tls_handshake_role(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS handshake role.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS handshake role has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor handshake role.

std::string print_tls_server_name(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TLS SNI server name.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TLS SNI server name has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor SNI server name.

std::string print_calculate_crc(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor calculate CRC flag.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the calculate CRC flag has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor calculate CRC flag.

std::string print_check_crc(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor check CRC flag.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the check CRC flag has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor check CRC flag.

std::string print_enable_tcp_nodelay(const std::string &transport_descriptor_id)

Parse XML file and print the specific TCP Transport Descriptor TCP_NODELAY socket option flag.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the TCP_NODELAY socket option flag has not been set in the profile.

Returns

std::string Specific TCP Transport Descriptor TCP_NODELAY socket option flag.

std::string print_segment_size(const std::string &transport_descriptor_id)

Parse XML file and print the specific SHM Transport Descriptor shared memory segment size.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the shared memory segment size has not been set in the profile.

Returns

std::string Specific SHM Transport Descriptor shared memory segment size.

std::string print_port_queue_capacity(const std::string &transport_descriptor_id)

Parse XML file and print the specific SHM Transport Descriptor listening port capacity.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the listening port capacity has not been set in the profile.

Returns

std::string Specific SHM Transport Descriptor listening port capacity in number of messages.

std::string print_healthy_check_timeout_ms(const std::string &transport_descriptor_id)

Parse XML file and print the specific SHM Transport Descriptor listening port liveliness timeout.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the listening port liveliness timeout has not been set in the profile.

Returns

std::string Specific SHM Transport Descriptor listening port liveliness timeout (in milliseconds).

std::string print_rtps_dump_file(const std::string &transport_descriptor_id)

Parse XML file and print the specific SHM Transport Descriptor debugging file path.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or the debugging file path has not been set in the profile.

Returns

std::string Specific SHM Transport Descriptor debugging file path.

uint32_t size()

Number of transport descriptor profiles contained in the XML file.

Throws

Error – Exception if the workspace was not initialized.

Returns

uint32_t Number of transport descriptor profiles in the XML file.

std::vector<std::string> keys()

List of the identifiers for every transport descriptor profile in the XML file.

Throws

Error – Exception if the workspace was not initialized.

Returns

std::vector<std::string> Identifier list. Empty list if there are no transport descriptor profiles.

uint32_t interface_whitelist_size(const std::string &transport_descriptor_id)

Number of whitelisted network interfaces in the Transport Descriptor list.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
Returns

uint32_t Number of network interfaces whitelisted in the list.

uint32_t listening_ports_size(const std::string &transport_descriptor_id)

Number of listening ports in the TCP Transport Descriptor list.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
Returns

uint32_t Number of listening ports in the list.

uint32_t tls_verify_mode_size(const std::string &transport_descriptor_id)

Number of TLS verification modes enabled in the mask in the TCP Transport Descriptor.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
Returns

uint32_t Number of TLS verification modes enabled in the mask.

uint32_t tls_options_size(const std::string &transport_descriptor_id)

Number of TLS supported features enabled in the mask in the TCP Transport Descriptor.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
Returns

uint32_t Number of TLS supported features enabled in the mask.

uint32_t tls_verify_paths_size(const std::string &transport_descriptor_id)

Number of TLS verification paths included in the TCP Transport Descriptor.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
Returns

uint32_t Number of TLS paths to look for verification files.

void clear(const std::string &transport_descriptor_id)

Remove specific transport descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier. If empty, every transport descriptor profile is deleted.

Throws
void clear_kind(const std::string &transport_descriptor_id)

Remove transport descriptor profile kind.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_send_buffer_size(const std::string &transport_descriptor_id)

Remove send buffer size element from specific Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_receive_buffer_size(const std::string &transport_descriptor_id)

Remove receive buffer size element from specific Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_max_message_size(const std::string &transport_descriptor_id)

Remove maximum message size element from specific Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_max_initial_peers_range(const std::string &transport_descriptor_id)

Remove maximum initial peers range element from specific Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_interface_whitelist(const std::string &transport_descriptor_id, const std::string &index)

Remove specific whitelisted network interface from specific Transport Descriptor profile.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • index – [in] Collection element to be removed. If empty, the complete collection is erased.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or if the element does not exist in the collection if an index is provided.

  • BadParameter – Exception if the index is not an integer.

void clear_ttl(const std::string &transport_descriptor_id)

Remove TTL (Time to live) element from specific Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_non_blocking_send(const std::string &transport_descriptor_id)

Remove non blocking send flag from specific Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_output_port(const std::string &transport_descriptor_id)

Remove output port from specific Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_wan_addr(const std::string &transport_descriptor_id)

Remove WAN address from specific Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_keep_alive_frequency_ms(const std::string &transport_descriptor_id)

Remove TCP keep alive frequency from specific Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_keep_alive_timeout_ms(const std::string &transport_descriptor_id)

Remove TCP keep alive timeout from specific Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_max_logical_port(const std::string &transport_descriptor_id)

Remove maximum number of logical ports from specific TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_logical_port_range(const std::string &transport_descriptor_id)

Remove maximum number of logical ports per request from specific TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_logical_port_increment(const std::string &transport_descriptor_id)

Remove logical port increment element from specific TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_listening_ports(const std::string &transport_descriptor_id, const std::string &index)

Remove specific listening port from specific Transport Descriptor profile.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • index – [in] Collection element to be removed. If empty, the complete collection is erased.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or if the element does not exist in the collection if an index is provided.

  • BadParameter – Exception if the index is not an integer.

void clear_tls(const std::string &transport_descriptor_id)

Remove TLS configuration from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_tls_password(const std::string &transport_descriptor_id)

Remove TLS password from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_tls_private_key_file(const std::string &transport_descriptor_id)

Remove TLS private key certificate path from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_tls_rsa_private_key_file(const std::string &transport_descriptor_id)

Remove TLS private key RSA certificate path from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_tls_cert_chain_file(const std::string &transport_descriptor_id)

Remove TLS public certificate chain file path from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_tls_tmp_dh_file(const std::string &transport_descriptor_id)

Remove TLS Diffie-Hellman parameters file path from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_tls_verify_file(const std::string &transport_descriptor_id)

Remove TLS CA (Certification Authority) file path from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_tls_verify_mode(const std::string &transport_descriptor_id, const std::string &index)

Remove specific TLS verification mode from specific Transport Descriptor profile mask.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • index – [in] Collection element to be removed. If empty, the complete collection is erased.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or if the element does not exist in the collection if an index is provided.

  • BadParameter – Exception if the index is not an integer.

void clear_tls_options(const std::string &transport_descriptor_id, const std::string &index)

Remove specific TLS supported feature from specific Transport Descriptor profile mask.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • index – [in] Collection element to be removed. If empty, the complete collection is erased.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or if the element does not exist in the collection if an index is provided.

  • BadParameter – Exception if the index is not an integer.

void clear_tls_verify_paths(const std::string &transport_descriptor_id, const std::string &index)

Remove specific TLS verification path from specific Transport Descriptor profile mask.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • index – [in] Collection element to be removed. If empty, the complete collection is erased.

Throws

  • Error – Exception if the workspace was not initialized.

  • ElementNotFound – Exception if the specified transport descriptor profile is not found in the XML file or if the element does not exist in the collection if an index is provided.

  • BadParameter – Exception if the index is not an integer.

void clear_tls_verify_depth(const std::string &transport_descriptor_id)

Remove TLS maximum verification depth from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_tls_default_verify_path(const std::string &transport_descriptor_id)

Remove TLS verify default paths flag from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_tls_handshake_role(const std::string &transport_descriptor_id)

Remove TLS handshake role from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_tls_server_name(const std::string &transport_descriptor_id)

Remove TLS SNI server name from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_calculate_crc(const std::string &transport_descriptor_id)

Remove calculate CRC flag from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_check_crc(const std::string &transport_descriptor_id)

Remove check CRC flag from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_enable_tcp_nodelay(const std::string &transport_descriptor_id)

Remove TCP_NODELAY socket option flag from TCP Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_segment_size(const std::string &transport_descriptor_id)

Remove shared memory segment size from SHM Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_port_queue_capacity(const std::string &transport_descriptor_id)

Remove shared memory listening port capacity from SHM Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_healthy_check_timeout_ms(const std::string &transport_descriptor_id)

Remove shared memory listening port liveliness timeout from SHM Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void clear_rtps_dump_file(const std::string &transport_descriptor_id)

Remove shared memory debugging file path from SHM Transport Descriptor profile.

Parameters

transport_descriptor_id – [in] Transport descriptor profile identifier.

Throws
void set_kind(const std::string &transport_descriptor_id, const std::string &kind)

Set the Transport Descriptor kind.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • kind – [in] Transport descriptor kind.

Throws
void set_send_buffer_size(const std::string &transport_descriptor_id, const std::string &send_buffer_size)

Set the Transport Descriptor send buffer size.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • send_buffer_size – [in] Transport descriptor send buffer size.

Throws
void set_receive_buffer_size(const std::string &transport_descriptor_id, const std::string &receive_buffer_size)

Set the Transport Descriptor receive buffer size.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • receive_buffer_size – [in] Transport descriptor receive buffer size.

Throws
void set_max_message_size(const std::string &transport_descriptor_id, const std::string &max_message_size)

Set the Transport Descriptor maximum message size.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • max_message_size – [in] Transport descriptor maximum message size.

Throws
void set_max_initial_peers_range(const std::string &transport_descriptor_id, const std::string &max_initial_peers_range)

Set the Transport Descriptor maximum initial peers range.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • max_initial_peers_range – [in] Transport descriptor maximum initial peers range.

Throws
void set_ttl(const std::string &transport_descriptor_id, const std::string &ttl)

Set the Transport Descriptor TTL (Time to live).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • ttl – [in] Transport descriptor TTL (Time to live) in number of hops.

Throws
void set_non_blocking_send(const std::string &transport_descriptor_id, const std::string &non_blocking_send)

Set the Transport Descriptor non blocking send flag (UDP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • non_blocking_send – [in] Enable/disable this flag in the Transport Descriptor.

Throws
void set_output_port(const std::string &transport_descriptor_id, const std::string &output_port)

Set the Transport Descriptor output port (UDP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • output_port – [in] UDP Transport output port.

Throws
void set_wan_addr(const std::string &transport_descriptor_id, const std::string &wan_addr)

Set the Transport Descriptor WAN address (TCPv4 Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • wan_addr – [in] TCPv4 Transport WAN address.

Throws
void set_keep_alive_frequency_ms(const std::string &transport_descriptor_id, const std::string &keep_alive_frequency_ms)

Set the TCP Transport Descriptor frequency for keep alive requests in milliseconds (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • keep_alive_frequency_ms – [in] Frequency of TCP keep alive requests (in ms).

Throws
void set_keep_alive_timeout_ms(const std::string &transport_descriptor_id, const std::string &keep_alive_timeout_ms)

Set the TCP Transport Descriptor timeout to consider a connection broken if no keep alive request is received in milliseconds (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • keep_alive_timeout_ms – [in] Time since the last keep alive request to consider the connection broken (in ms).

Throws
void set_max_logical_port(const std::string &transport_descriptor_id, const std::string &max_logical_port)

Set the TCP Transport Descriptor maximum number of logical ports to try during TCP negotiation (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • max_logical_port – [in] Maximum number of logical ports to try during TCP negotiation.

Throws
void set_logical_port_range(const std::string &transport_descriptor_id, const std::string &logical_port_range)

Set the TCP Transport Descriptor maximum number of logical ports per request to try during TCP negotiation (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • logical_port_range – [in] Maximum number of logical ports per request to try during TCP negotiation.

Throws
void set_logical_port_increment(const std::string &transport_descriptor_id, const std::string &logical_port_increment)

Set the TCP Transport Descriptor increment between logical ports to try during TCP negotiation (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • logical_port_increment – [in] Increment between logical ports to try during TCP negotiation.

Throws
void set_tls_password(const std::string &transport_descriptor_id, const std::string &tls_password)

Set the TCP Transport Descriptor TLS password (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_password – [in] TCP Transport Descriptor TLS password.

Throws
void set_tls_private_key_file(const std::string &transport_descriptor_id, const std::string &tls_private_key_file)

Set the TCP Transport Descriptor TLS private key certificate path (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_private_key_file – [in] Path to the private key certificate file.

Throws
void set_tls_rsa_private_key_file(const std::string &transport_descriptor_id, const std::string &tls_rsa_private_key_file)

Set the TCP Transport Descriptor TLS private key RSA certificate path (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_rsa_private_key_file – [in] Path to the private key RSA certificate file.

Throws
void set_tls_cert_chain_file(const std::string &transport_descriptor_id, const std::string &tls_cert_chain_file)

Set the TCP Transport Descriptor TLS public certificate chain file path (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_cert_chain_file – [in] Path to the public certificate chain file.

Throws
void set_tls_tmp_dh_file(const std::string &transport_descriptor_id, const std::string &tls_tmp_dh_file)

Set the TCP Transport Descriptor TLS Diffie-Hellman parameters file path (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_tmp_dh_file – [in] Path to the Diffie-Hellman parameters file.

Throws
void set_tls_verify_file(const std::string &transport_descriptor_id, const std::string &tls_verify_file)

Set the TCP Transport Descriptor TLS CA (Certification Authority) file path (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_verify_file – [in] Path to the CA file.

Throws
void set_tls_verify_depth(const std::string &transport_descriptor_id, const std::string &tls_verify_depth)

Set the TCP Transport Descriptor TLS maximum allowed depth for verifying intermediate certificates (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_verify_depth – [in] Maximum allowed depth for verifying intermediate certificates.

Throws
void set_tls_default_verify_path(const std::string &transport_descriptor_id, const std::string &tls_default_verify_path)

Set the TCP Transport Descriptor TLS verify default paths flag (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_default_verify_path – [in] Flag that enables looking for verification files on the default paths.

Throws
void set_tls_handshake_role(const std::string &transport_descriptor_id, const std::string &tls_handshake_role)

Set the TCP Transport Descriptor TLS handshake role (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_handshake_role – [in] Role that the Transport will take on handshaking.

Throws
void set_tls_server_name(const std::string &transport_descriptor_id, const std::string &tls_server_name)

Set the TCP Transport Descriptor TLS SNI server name (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_server_name – [in] SNI (Server Name Indication) server name.

Throws
void set_calculate_crc(const std::string &transport_descriptor_id, const std::string &calculate_crc)

Set the TCP Transport Descriptor calculate CRC flag (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • calculate_crc – [in] Flag to enable CRC calculation and sending.

Throws
void set_check_crc(const std::string &transport_descriptor_id, const std::string &check_crc)

Set the TCP Transport Descriptor check CRC flag (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • check_crc – [in] Flag to enable CRC checking of incoming messages.

Throws
void set_enable_tcp_nodelay(const std::string &transport_descriptor_id, const std::string &enable_tcp_nodelay)

Enable the TCP Transport Descriptor TCP_NODELAY socket option (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • enable_tcp_nodelay – [in] Flag to enable TCP_NODELAY socket option.

Throws
void set_segment_size(const std::string &transport_descriptor_id, const std::string &segment_size)

Set the SHM Transport Descriptor shared memory segment size (SHM Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • segment_size – [in] Shared memory segment size.

Throws
void set_port_queue_capacity(const std::string &transport_descriptor_id, const std::string &port_queue_capacity)

Set the SHM Transport Descriptor listening port capacity (SHM Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • port_queue_capacity – [in] Listening port capacity in number of messages.

Throws
void set_healthy_check_timeout_ms(const std::string &transport_descriptor_id, const std::string &healthy_check_timeout_ms)

Set the SHM Transport Descriptor listening port liveliness timeout (SHM Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • healthy_check_timeout_ms – [in] Listening port liveliness timeout in milliseconds.

Throws
void set_rtps_dump_file(const std::string &transport_descriptor_id, const std::string &rtps_dump_file)

Set the SHM Transport Descriptor path to the debug file (SHM Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • rtps_dump_file – [in] Path to the file where RTPS messages will be stored for debugging purposes.

Throws
void set_interface_whitelist(const std::string &transport_descriptor_id, const std::string &ip_address, const std::string &index)

Append an IP address to the whitelisted network interfaces collection or update IP address in the whitelisted network interfaces collection.

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • ip_address – [in] IP address to be updated in the whitelist collection.

  • index – [in] Collection element to be changed. If empty, a new element is added to the list.

Throws
void set_listening_ports(const std::string &transport_descriptor_id, const std::string &port, const std::string &index)

Append a listening port to the TCP Transport Descriptor collection or update a listening port to the TCP Transport Descriptor collection (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • port – [in] Updated port to listen as server.

  • index – [in] Collection element to be changed. If empty, a new element is added to the list.

Throws
void set_tls_verify_mode(const std::string &transport_descriptor_id, const std::string &tls_verify_mode, const std::string &index)

Append a TLS verification mode to the TCP Transport Descriptor mask or update a TLS verification mode to the TCP Transport Descriptor mask (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_verify_mode – [in] TLS verification mode to update in the mask.

  • index – [in] Collection element to be changed. If empty, a new element is added to the list.

Throws
void set_tls_options(const std::string &transport_descriptor_id, const std::string &tls_options, const std::string &index)

Append TLS supported features to the TCP Transport Descriptor mask or update a TLS supported feature to the TCP Transport Descriptor mask (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_options – [in] TLS supported feature to update in the mask.

  • index – [in] Collection element to be changed. If empty, a new element is added to the list.

Throws
void set_tls_verify_path(const std::string &transport_descriptor_id, const std::string &tls_verify_path, const std::string &index)

Append TLS verification path to the TCP Transport Descriptor or update a TLS verification path to the TCP Transport Descriptor (TCP Transport specific).

Parameters

  • transport_descriptor_id – [in] Transport descriptor profile identifier.

  • tls_verify_path – [in] TLS verification path to be updated in the list.

  • index – [in] Collection element to be changed. If empty, a new element is added to the list.

Throws