3. Domain Participant

namespace domain_participant

Functions

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

Parse XML file and print specific Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier. If empty every Domain Participant profile is printed.

Throws
Returns

std::string XML section containing the specific Domain Participant profile.

std::string print_default_profile()

Parse XML file and print the name of the Domain Participant default profile.

Throws
Returns

std::string Domain Participant default profile.

std::string print_domain_id(const std::string &profile_id)

Parse XML file and print the Domain Participant Domain ID.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the Domain ID has not been set in the profile.

Returns

std::string Domain Participant Domain ID.

std::string print_name(const std::string &profile_id)

Parse XML file and print the Domain Participant name.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the name has not been set in the profile.

Returns

std::string Domain Participant name.

std::string print_ignore_non_matching_locators(const std::string &profile_id)

Parse XML file and print the Domain Participant ignore non matching locators flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the ignore non matching locators flag has not been set in the profile.

Returns

std::string Domain Participant ignore non matching locators flag.

std::string print_send_socket_buffer_size(const std::string &profile_id)

Parse XML file and print the Domain Participant send socket buffer size.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the send socket buffer size has not been set in the profile.

Returns

std::string Domain Participant send socket buffer size.

std::string print_listen_socket_buffer_size(const std::string &profile_id)

Parse XML file and print the Domain Participant listen socket buffer size.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the listen socket buffer size has not been set in the profile.

Returns

std::string Domain Participant listen socket buffer size.

std::string print_participant_id(const std::string &profile_id)

Parse XML file and print the Domain Participant ID.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the Domain Participant ID has not been set in the profile.

Returns

std::string Domain Participant ID.

std::string print_user_transports(const std::string &profile_id, const std::string &index)

Parse XML file and print the Domain Participant specific user transport element.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
Returns

std::string Domain Participant specific user transport.

std::string print_use_builtin_transports(const std::string &profile_id)

Parse XML file and print the Domain Participant use builtin transports flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the use builtin transports flag has not been set in the profile.

Returns

std::string Domain Participant use builtin transports flag.

std::string print_user_data(const std::string &profile_id, const std::string &index)

Parse XML file and print the Domain Participant specific user data element.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
Returns

std::string Domain Participant specific user data.

std::string print_prefix(const std::string &profile_id)

Parse XML file and print the Domain Participant GUID prefix.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the GUID prefix has not been set in the profile.

Returns

std::string Domain Participant GUID prefix.

uint32_t size()

Number of Domain Participant profiles contained in the XML file.

Throws

ErrorException if the workspace was not initialized.

Returns

uint32_t Number of Domain Participant profiles in the XML file.

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

List of the identifiers for every Domain Participant profile in the XML file.

Throws

ErrorException if the workspace was not initialized.

Returns

std::vector<std::string> Identifier list. Empty list if there are no Domain Participant profiles.

uint32_t user_transports_size(const std::string &profile_id)

Number of user transports in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
Returns

uint32_t Number of user transports in the list.

uint32_t user_data_size(const std::string &profile_id)

Number of user data elements in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
Returns

uint32_t Number of user data elements in the list.

void clear(const std::string &profile_id)

Remove specific Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier. If empty, every Domain Participant profile is deleted.

Throws
void clear_default_profile()

Remove the is_default_profile attribute from the default Domain Participant profile.

Throws

ErrorException if the workspace was not initialized.

void clear_domain_id(const std::string &profile_id)

Remove Domain ID from specific Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_name(const std::string &profile_id)

Remove Domain Participant name from specific Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_ignore_non_matching_locators(const std::string &profile_id)

Remove ignore non matching locators flag from specific Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_send_socket_buffer_size(const std::string &profile_id)

Remove send socket buffer size from specific Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_listen_socket_buffer_size(const std::string &profile_id)

Remove listen socket buffer size from specific Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_participant_id(const std::string &profile_id)

Remove Domain Participant ID from specific Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_user_transports(const std::string &profile_id, const std::string &index)

Remove specific user transport from specific Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or if the element does not exist in the collection if an index is provided.

  • BadParameterException if the index is not an integer.

void clear_use_builtin_transports(const std::string &profile_id)

Remove use builtin transports flag from specific Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_user_data(const std::string &profile_id, const std::string &index)

Remove specific user data from specific Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or if the element does not exist in the collection if an index is provided.

  • BadParameterException if the index is not an integer.

void clear_prefix(const std::string &profile_id)

Remove GUID prefix from specific Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void set_default_profile(const std::string &profile_id)

Set the given Domain Participant profile as the default profile. As only one default profile is allowed, if another default profile exists, it is overridden and its is_default_profile attribute is set to false.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void set_domain_id(const std::string &profile_id, const std::string &domain_id)

Set the Domain Participant domain ID.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • domain_id[in] Domain Participant domain ID.

Throws
void set_name(const std::string &profile_id, const std::string &name)

Set the Domain Participant name.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • name[in] Domain Participant name.

Throws
void set_ignore_non_matching_locators(const std::string &profile_id, const std::string &ignore_non_matching_locators)

Set the Domain Participant ignore non matching locators flag.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • ignore_non_matching_locators[in] Ignore non matching locators flag.

Throws
void set_send_socket_buffer_size(const std::string &profile_id, const std::string &send_socket_buffer_size)

Set the Domain Participant send socket buffer size.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • send_socket_buffer_size[in] Size of the buffer in the socket used for sending data.

Throws
void set_listen_socket_buffer_size(const std::string &profile_id, const std::string &listen_socket_buffer_size)

Set the Domain Participant listen socket buffer size.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • listen_socket_buffer_size[in] Size of the buffer in the socket used for listening data.

Throws
void set_participant_id(const std::string &profile_id, const std::string &participant_id)

Set the Domain Participant ID.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • participant_id[in] Domain Participant ID.

Throws
void set_use_builtin_transports(const std::string &profile_id, const std::string &use_builtin_transports)

Set the Domain Participant use builtin transports flag.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • use_builtin_transports[in] Use builtin transports flag.

Throws
void set_prefix(const std::string &profile_id, const std::string &prefix)

Set the Domain Participant GUID prefix.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Domain Participant GUID prefix.

Throws
void set_user_transports(const std::string &profile_id, const std::string &transport_id, const std::string &index)

Append a user transport to the collection or update user transport element in the collection.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • transport_id[in] Transport descriptor profile identifier.

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

Throws
  • ElementInvalidException if the provided Transport descriptor profile identifier is not valid.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • ErrorException if the workspace was not initialized.

  • BadParameterException if the index is not an integer.

void set_user_data(const std::string &profile_id, const std::string &user_data, const std::string &index)

Append user data or update specific user data.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • user_data[in] User data to be updated.

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

Throws
namespace allocations

Functions

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

Parse XML file and print specific Domain Participant allocations configuration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the allocations configuration does not exist.

Returns

std::string XML section containing the allocations configuration.

std::string print_remote_locators(const std::string &profile_id)

Parse XML file and print specific Domain Participant remote locators limit.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the remote locators configuration does not exist.

Returns

std::string XML section with the remote locators limit configuration.

std::string print_remote_locators_max_unicast(const std::string &profile_id)

Parse XML file and print specific Domain Participant remote unicast locators limit.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the remote unicast locators limit does not exist.

Returns

std::string Remote unicast locators limit.

std::string print_remote_locators_max_multicast(const std::string &profile_id)

Parse XML file and print specific Domain Participant remote multicast locators limit.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the remote multicast locators limit does not exist.

Returns

std::string Remote multicast locators limit.

std::string print_total_participants(const std::string &profile_id)

Parse XML file and print specific Domain Participant total participants limit.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the total participants configuration does not exist.

Returns

std::string XML section with the total participants allocation configuration.

std::string print_total_participants_initial(const std::string &profile_id)

Parse XML file and print specific Domain Participant initial participants (preallocated).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the initial participants configuration does not exist.

Returns

std::string Initial number of preallocated participants.

std::string print_total_participants_maximum(const std::string &profile_id)

Parse XML file and print specific Domain Participant maximum number of participants allowed.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the maximum participants configuration does not exist.

Returns

std::string Maximum number of participants.

std::string print_total_participants_increment(const std::string &profile_id)

Parse XML file and print specific Domain Participant number of allocated participants when the allocated memory is consumed.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the increment participants configuration does not exist.

Returns

std::string Increment of participants.

std::string print_total_readers(const std::string &profile_id)

Parse XML file and print specific Domain Participant total readers limit.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the total readers configuration does not exist.

Returns

std::string XML section with the total readers allocation configuration.

std::string print_total_readers_initial(const std::string &profile_id)

Parse XML file and print specific Domain Participant initial readers (preallocated).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the initial readers configuration does not exist.

Returns

std::string Initial number of preallocated readers.

std::string print_total_readers_maximum(const std::string &profile_id)

Parse XML file and print specific Domain Participant maximum number of readers allowed.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the maximum readers configuration does not exist.

Returns

std::string Maximum number of readers.

std::string print_total_readers_increment(const std::string &profile_id)

Parse XML file and print specific Domain Participant number of allocated readers when the allocated memory is consumed.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the increment readers configuration does not exist.

Returns

std::string Increment of readers.

std::string print_total_writers(const std::string &profile_id)

Parse XML file and print specific Domain Participant total writers limit.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the total writers configuration does not exist.

Returns

std::string XML section with the total writers allocation configuration.

std::string print_total_writers_initial(const std::string &profile_id)

Parse XML file and print specific Domain Participant initial writers (preallocated).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the initial writers configuration does not exist.

Returns

std::string Initial number of preallocated writers.

std::string print_total_writers_maximum(const std::string &profile_id)

Parse XML file and print specific Domain Participant maximum number of writers allowed.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the maximum writers configuration does not exist.

Returns

std::string Maximum number of writers.

std::string print_total_writers_increment(const std::string &profile_id)

Parse XML file and print specific Domain Participant number of allocated writers when the allocated memory is consumed.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the increment writers configuration does not exist.

Returns

std::string Increment of writers.

std::string print_max_partitions(const std::string &profile_id)

Parse XML file and print specific Domain Participant maximum number of partitions.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the maximum number of partitions is not set.

Returns

std::string Maximum number of partitions allowed in the Domain Participant.

std::string print_max_user_data(const std::string &profile_id)

Parse XML file and print specific Domain Participant maximum size of user data message.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the maximum size is not set.

Returns

std::string Maximum allowed size for user data message in the Domain Participant.

std::string print_max_properties(const std::string &profile_id)

Parse XML file and print specific Domain Participant maximum number of properties.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the maximum property number is not set.

Returns

std::string Maximum allowed number of properties in the Domain Participant.

std::string print_send_buffers(const std::string &profile_id)

Parse XML file and print specific Domain Participant send buffers allocations configuration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the send buffers configuration does not exist.

Returns

std::string XML section with the send buffers allocation configuration.

std::string print_send_buffers_preallocated_number(const std::string &profile_id)

Parse XML file and print specific Domain Participant initially preallocated send buffers.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the send buffers preallocations are not set.

Returns

std::string Number of send buffers preallocated.

std::string print_send_buffers_dynamic(const std::string &profile_id)

Parse XML file and print specific Domain Participant send buffers dynamic flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the send buffers configuration flag is not set.

Returns

std::string Send buffers dynamic flag.

void clear(const std::string &profile_id)

Remove allocations configuration in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_remote_locators(const std::string &profile_id)

Remove remote locators limit in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_remote_locators_max_unicast(const std::string &profile_id)

Remove remote unicast locators limit in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_remote_locators_max_multicast(const std::string &profile_id)

Remove remote multicast locators limit in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_participants(const std::string &profile_id)

Remove total participants limit in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_participants_initial(const std::string &profile_id)

Remove initial participants (preallocated) in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_participants_maximum(const std::string &profile_id)

Remove maximum number of participants allowed in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_participants_increment(const std::string &profile_id)

Remove participant increment configuration in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_readers(const std::string &profile_id)

Remove total readers limit in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_readers_initial(const std::string &profile_id)

Remove initial readers (preallocated) in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_readers_maximum(const std::string &profile_id)

Remove maximum number of readers allowed in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_readers_increment(const std::string &profile_id)

Remove readers increment configuration in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_writers(const std::string &profile_id)

Remove total writers limit in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_writers_initial(const std::string &profile_id)

Remove initial writers (preallocated) in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_writers_maximum(const std::string &profile_id)

Remove maximum number of writers allowed in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_total_writers_increment(const std::string &profile_id)

Remove writers increment configuration in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_max_partitions(const std::string &profile_id)

Remove maximum number of partitions in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_max_user_data(const std::string &profile_id)

Remove maximum size of user data message in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_max_properties(const std::string &profile_id)

Remove maximum number of properties in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_send_buffers(const std::string &profile_id)

Remove send buffers allocations configuration in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_send_buffers_preallocated_number(const std::string &profile_id)

Remove initially preallocated send buffers configuration in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_send_buffers_preallocated_dynamic(const std::string &profile_id)

Remove send buffers dynamic flag in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void set_remote_locators_max_unicast(const std::string &profile_id, const std::string &max_unicast)

Set the remote unicast locators limit in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • max_unicast[in] Maximum number of allowed remote unicast locators.

Throws
void set_remote_locators_max_multicast(const std::string &profile_id, const std::string &max_multicast)

Set the remote multicast locators limit in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • max_multicast[in] Maximum number of allowed remote multicast locators.

Throws
void set_total_participants_initial(const std::string &profile_id, const std::string &initial)

Set the initial participants (preallocated) in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • initial[in] Initial number of preallocated participants.

Throws
void set_total_participants_maximum(const std::string &profile_id, const std::string &maximum)

Set the maximum number of participants allowed in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • maximum[in] Maximum number of participants.

Throws
void set_total_participants_increment(const std::string &profile_id, const std::string &increment)

Set the number of allocated participants when the allocated memory is consumed in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • increment[in] Increment of participants.

Throws
void set_total_readers_initial(const std::string &profile_id, const std::string &initial)

Set the initial readers (preallocated) in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • initial[in] Initial number of preallocated readers.

Throws
void set_total_readers_maximum(const std::string &profile_id, const std::string &maximum)

Set the maximum number of readers allowed in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • maximum[in] Maximum number of readers.

Throws
void set_total_readers_increment(const std::string &profile_id, const std::string &increment)

Set the number of allocated readers when the allocated memory is consumed in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • increment[in] Increment of readers.

Throws
void set_total_writers_initial(const std::string &profile_id, const std::string &initial)

Set the initial writers (preallocated) in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • initial[in] Initial number of preallocated writers.

Throws
void set_total_writers_maximum(const std::string &profile_id, const std::string &maximum)

Set the maximum number of writers allowed in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • maximum[in] Maximum number of writers.

Throws
void set_total_writers_increment(const std::string &profile_id, const std::string &increment)

Set the number of allocated writers when the allocated memory is consumed in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • increment[in] Increment of writers.

Throws
void set_max_partitions(const std::string &profile_id, const std::string &max_partitions)

Set the maximum number of partitions in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • max_partitions[in] Maximum number of partitions allowed in the Domain Participant.

Throws
void set_max_user_data(const std::string &profile_id, const std::string &max_user_data)

Set the maximum size of user data message in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • max_user_data[in] Maximum allowed size for user data message in the Domain Participant.

Throws
void set_max_properties(const std::string &profile_id, const std::string &max_properties)

Set the maximum number of properties in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • max_properties[in] Maximum allowed number of properties in the Domain Participant.

Throws
void set_send_buffers_preallocated_number(const std::string &profile_id, const std::string &send_buffers_preallocated_number)

Set the initially preallocated send buffers in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • send_buffers_preallocated_number[in] Number of send buffers preallocated.

Throws
void set_send_buffers_dynamic(const std::string &profile_id, const std::string &send_buffers_dynamic)

Set the send buffers dynamic flag in the Domain Participant profile.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • send_buffers_dynamic[in] Send buffers dynamic flag.

Throws
namespace builtin

Functions

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

Parse XML file and print specific Domain Participant builtin configuration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin element does not exist.

Returns

std::string XML section containing the specific Domain Participant builtin configuration.

std::string print_avoid_builtin_multicast(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin avoid_builtin_multicast flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the corresponding builtin flag does not exist.

Returns

std::string Domain Participant specific avoid_builtin_multicast flag.

std::string print_use_writer_liveliness_protocol(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin use writer liveliness protocol flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the corresponding builtin flag does not exist.

Returns

std::string Domain Participant specific use writer liveliness protocol flag.

std::string print_reader_history_memory_policy(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin DataReaders History Memory Policy.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the corresponding builtin History Memory Policy does not exist.

Returns

std::string Domain Participant builtin DataReaders History Memory Policy.

std::string print_writer_history_memory_policy(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin DataWriters History Memory Policy.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the corresponding builtin History Memory Policy does not exist.

Returns

std::string Domain Participant builtin DataWriters History Memory Policy.

std::string print_reader_payload_size(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin DataReaders payload size.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the corresponding builtin payload size element does not exist.

Returns

std::string Domain Participant builtin DataReaders payload size.

std::string print_writer_payload_size(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin DataWriters payload size.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the corresponding builtin payload size element does not exist.

Returns

std::string Domain Participant builtin DataWriters payload size.

std::string print_mutation_tries(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin number of physical ports to try if configured port is already in use (mutation tries).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin mutation tries element does not exist.

Returns

std::string Domain Participant builtin mutation tries.

void clear(const std::string &profile_id)

Remove specific Domain Participant builtin configuration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_avoid_builtin_multicast(const std::string &profile_id)

Remove specific Domain Participant builtin avoid_builtin_multicast flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_use_writer_liveliness_protocol(const std::string &profile_id)

Remove specific Domain Participant builtin use writer liveliness protocol flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_reader_history_memory_policy(const std::string &profile_id)

Remove specific Domain Participant builtin DataReaders History Memory Policy.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_writer_history_memory_policy(const std::string &profile_id)

Remove specific Domain Participant builtin DataWriters History Memory Policy.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_reader_payload_size(const std::string &profile_id)

Remove specific Domain Participant builtin DataReaders payload size.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_witer_payload_size(const std::string &profile_id)

Remove specific Domain Participant builtin DataWriters payload size.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_mutation_tries(const std::string &profile_id)

Remove specific Domain Participant builtin DataWriters mutation tries.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void set_avoid_builtin_multicast(const std::string &profile_id, const std::string &avoid_builtin_multicast)

Set the Domain Participant builtin avoid_builtin_multicast flag.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • avoid_builtin_multicast[in] Builtin avoid_builtin_multicast flag.

Throws
void set_use_writer_liveliness_protocol(const std::string &profile_id, const std::string &use_writer_liveliness_protocol)

Set the Domain Participant builtin use writer liveliness protocol flag.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • use_writer_liveliness_protocol[in] Builtin use writer liveliness protocol flag.

Throws
void set_reader_history_memory_policy(const std::string &profile_id, const std::string &reader_history_memory_policy)

Set the Domain Participant builtin DataReaders History Memory Policy.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • reader_history_memory_policy[in] Builtin DataReaders History Memory Policy.

Throws
void set_writer_history_memory_policy(const std::string &profile_id, const std::string &writer_history_memory_policy)

Set the Domain Participant builtin DataWriters History Memory Policy.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • writer_history_memory_policy[in] Builtin DataWriters History Memory Policy.

Throws
void set_reader_payload_size(const std::string &profile_id, const std::string &reader_payload_size)

Set the Domain Participant builtin DataReaders payload size.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • reader_payload_size[in] Builtin DataReaders payload size.

Throws
void set_writer_payload_size(const std::string &profile_id, const std::string &writer_payload_size)

Set the Domain Participant builtin DataWriters payload size.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • writer_payload_size[in] Builtin DataWriters payload size.

Throws
void set_mutation_tries(const std::string &profile_id, const std::string &mutation_tries)

Set the Domain Participant builtin mutation tries.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • mutation_tries[in] Builtin mutation tries.

Throws
namespace discovery_config

Functions

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

Parse XML file and print specific Domain Participant builtin discovery configuration section.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery configuration section does not exist.

Returns

std::string XML section containing the specific Domain Participant builtin discovery configuration.

std::string print_discovery_protocol(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery protocol.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery protocol element does not exist.

Returns

std::string Domain Participant specific builtin discovery protocol.

std::string print_ignore_participant_flags(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery ignore participant flags.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery flag does not exist.

Returns

std::string Domain Participant specific builtin discovery ignore participant flags.

std::string print_edp(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery EDP flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery flag does not exist.

Returns

std::string Domain Participant specific builtin discovery EDP flag.

std::string print_simple_edp(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery simple EDP configuration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery simple EDP configuration does not exist.

Returns

std::string Domain Participant specific builtin discovery simple EDP configuration.

std::string print_simple_edp_pubwriter_subreader(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery simple EDP configuration flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery simple EDP configuration flag does not exist.

Returns

std::string Domain Participant specific builtin discovery simple EDP pubwriter_subreader flag configuration.

std::string print_simple_edp_pubreader_subwriter(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery simple EDP configuration flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery simple EDP configuration flag does not exist.

Returns

std::string Domain Participant specific builtin discovery simple EDP pubreader_subwriter flag configuration.

std::string print_lease_duration(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery lease duration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery lease duration element does not exist.

Returns

std::string Domain Participant specific builtin discovery lease duration.

std::string print_lease_duration_sec(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery lease duration (seconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery lease duration seconds element does not exist.

Returns

std::string Domain Participant specific builtin discovery lease duration (seconds member).

std::string print_lease_duration_nanosec(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery lease duration (nanoseconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery lease duration nanoseconds element does not exist.

Returns

std::string Domain Participant specific builtin discovery lease duration (nanoseconds member).

std::string print_lease_announcement(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery lease announcement.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery lease announcement element does not exist.

Returns

std::string Domain Participant specific builtin discovery lease announcement.

std::string print_lease_announcement_sec(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery lease announcement (seconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery lease announcement seconds element does not exist.

Returns

std::string Domain Participant specific builtin discovery lease announcement (seconds member).

std::string print_lease_announcement_nanosec(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery lease announcement (nanoseconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery lease announcement nanoseconds element does not exist.

Returns

std::string Domain Participant specific builtin discovery lease announcement (nanoseconds member).

std::string print_initial_announcements(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery initial announcements configuration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery initial announcements element does not exist.

Returns

std::string Domain Participant specific builtin discovery initial announcements configuration.

std::string print_initial_announcements_count(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery number of initial announcements.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery initial announcements count element does not exist.

Returns

std::string Domain Participant specific builtin discovery number of initial announcements.

std::string print_initial_announcements_period(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery initial announcements duration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery initial announcements duration element does not exist.

Returns

std::string Domain Participant specific builtin discovery initial announcements duration.

std::string print_initial_announcements_period_sec(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery initial announcement duration (seconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery initial announcement duration seconds element does not exist.

Returns

std::string Domain Participant specific builtin discovery initial announcement duration (seconds member).

std::string print_initial_announcements_period_nanosec(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery lease announcement duration (nanoseconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery lease announcement duration nanoseconds element does not exist.

Returns

std::string Domain Participant specific builtin discovery lease announcement duration (nanoseconds member).

std::string print_client_announcement_period(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery client announcement period. Discovery Server configuration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery client announcement period element does not exist.

Returns

std::string Domain Participant specific builtin discovery client announcement period.

std::string print_client_announcement_period_sec(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery client announcement period (seconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery client announcement period seconds element does not exist.

Returns

std::string Domain Participant specific builtin discovery client announcement period (seconds member).

std::string print_client_announcement_period_nanosec(const std::string &profile_id)

Parse XML file and print specific Domain Participant builtin discovery client announcement period (nanoseconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin discovery client announcement period nanoseconds element does not exist.

Returns

std::string Domain Participant specific builtin discovery client announcement period (nanoseconds member).

std::string print_static_edp_xml_config(const std::string &profile_id, const std::string &index)

Parse XML file and print specific Domain Participant builtin discovery specific Static EDP XML configuration file.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the Static EDP XML configuration files element is not defined, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin discovery specific Static EDP XML configuration file.

uint32_t static_edp_xml_config_size(const std::string &profile_id)

Number of builtin discovery Static EDP XML configuration files in the Domain Participant.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or there are no Static EDP XML files configured.

Returns

uint32_t Number of builtin discovery Static EDP XML configuration files.

void clear(const std::string &profile_id)

Remove specific Domain Participant builtin discovery configuration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_discovery_protocol(const std::string &profile_id)

Remove specific Domain Participant builtin discovery protocol.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_ignore_participant_flags(const std::string &profile_id)

Remove specific Domain Participant builtin discovery ignore participant flags.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_edp(const std::string &profile_id)

Remove specific Domain Participant builtin discovery EDP flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_simple_edp(const std::string &profile_id)

Remove specific Domain Participant builtin discovery simple EDP configuration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_simple_edp_pubwriter_subreader(const std::string &profile_id)

Remove specific Domain Participant builtin discovery simple EDP configuration flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_simple_edp_edp_pubreader_subwriter(const std::string &profile_id)

Remove specific Domain Participant builtin discovery simple EDP configuration flag.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_lease_duration(const std::string &profile_id)

Remove specific Domain Participant builtin discovery lease duration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_lease_duration_sec(const std::string &profile_id)

Remove specific Domain Participant builtin discovery lease duration (seconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_lease_duration_nanosec(const std::string &profile_id)

Remove specific Domain Participant builtin discovery lease duration (nanoseconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_lease_announcement(const std::string &profile_id)

Remove specific Domain Participant builtin discovery lease announcement.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_lease_announcement_sec(const std::string &profile_id)

Remove specific Domain Participant builtin discovery lease announcement (seconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_lease_announcement_nanosec(const std::string &profile_id)

Remove specific Domain Participant builtin discovery lease announcement (nanoseconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_initial_announcements(const std::string &profile_id)

Remove specific Domain Participant builtin discovery initial announcements configuration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_initial_announcements_count(const std::string &profile_id)

Remove specific Domain Participant builtin discovery number of initial announcements.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_initial_announcements_period(const std::string &profile_id)

Remove specific Domain Participant builtin discovery initial announcements duration.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_initial_announcements_period_sec(const std::string &profile_id)

Remove specific Domain Participant builtin discovery initial announcements duration (seconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_initial_announcements_period_nanosec(const std::string &profile_id)

Remove specific Domain Participant builtin discovery initial announcements duration (nanoseconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_client_announcement_period(const std::string &profile_id)

Remove specific Domain Participant builtin discovery client announcement period (Discovery Server specific).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_client_announcement_period_sec(const std::string &profile_id)

Remove specific Domain Participant builtin discovery client announcement period (seconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_client_announcement_period_nanosec(const std::string &profile_id)

Remove specific Domain Participant builtin discovery client announcement period (nanoseconds).

Parameters

profile_id[in] Domain participant profile identifier.

Throws
void clear_static_edp_xml_config(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin discovery specific Static EDP XML configuration file.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or if the element does not exist in the collection if an index is provided..

  • BadParameterException if the index is not an integer.

void set_discovery_protocol(const std::string &profile_id, const std::string &discovery_protocol)

Set the Domain Participant builtin discovery protocol.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • discovery_protocol[in] Builtin discovery protocol.

Throws
void set_ignore_participant_flags(const std::string &profile_id, const std::string &ignore_participant_flags)

Set the Domain Participant builtin discovery ignore participant flags.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • ignore_participant_flags[in] Builtin discovery ignore participant flags.

Throws
void set_edp(const std::string &profile_id, const std::string &edp)

Set the Domain Participant builtin discovery EDP flag.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • edp[in] Builtin discovery EDP flag.

Throws
void set_simple_edp_pubwriter_subreader(const std::string &profile_id, const std::string &simple_edp_pubwriter_subreader)

Set the Domain Participant builtin discovery simple EDP configuration flag.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • simple_edp_pubwriter_subreader[in] Builtin discovery simple EDP configuration flag.

Throws
void set_simple_edp_pubreader_subwriter(const std::string &profile_id, const std::string &simple_edp_pubreader_subwriter)

Set the Domain Participant builtin discovery simple EDP configuration flag.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • simple_edp_pubreader_subwriter[in] Builtin discovery simple EDP configuration flag.

Throws
void set_lease_duration_sec(const std::string &profile_id, const std::string &duration_sec)

Set the Domain Participant builtin discovery lease duration (seconds).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • duration_sec[in] Builtin discovery lease duration seconds.

Throws
void set_lease_duration_nanosec(const std::string &profile_id, const std::string &duration_nanosec)

Set the Domain Participant builtin discovery lease duration (nanoseconds).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • duration_nanosec[in] Builtin discovery lease duration nanoseconds.

Throws
void set_lease_announcement_sec(const std::string &profile_id, const std::string &announcement_sec)

Set the Domain Participant builtin discovery lease announcement (seconds).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • announcement_sec[in] Builtin discovery lease announcement seconds.

Throws
void set_lease_announcement_nanosec(const std::string &profile_id, const std::string &announcement_nanosec)

Set the Domain Participant builtin discovery lease announcement (nanoseconds).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • announcement_nanosec[in] Builtin discovery lease announcement nanoseconds.

Throws
void set_initial_announcements_count(const std::string &profile_id, const std::string &count)

Set the Domain Participant builtin discovery number of initial announcements.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • count[in] Builtin discovery number of initial announcements.

Throws
void set_initial_announcements_period_sec(const std::string &profile_id, const std::string &period_sec)

Set the Domain Participant builtin discovery initial announcements duration (seconds).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • period_sec[in] Builtin discovery initial announcements duration seconds.

Throws
void set_initial_announcements_period_nanosec(const std::string &profile_id, const std::string &period_nanosec)

Set the Domain Participant builtin discovery initial announcements duration (nanoseconds).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • period_nanosec[in] Builtin discovery initial announcements duration nanoseconds.

Throws
void set_client_announcement_period_sec(const std::string &profile_id, const std::string &period_sec)

Set the Domain Participant builtin discovery client announcement period (seconds).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • period_sec[in] Builtin discovery client announcement period seconds.

Throws
void set_client_announcement_period_nanosec(const std::string &profile_id, const std::string &period_nanosec)

Set the Domain Participant builtin discovery client announcement period (nanoseconds).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • period_nanosec[in] Builtin discovery client announcement period nanoseconds.

Throws
void set_static_edp_xml_config(const std::string &profile_id, const std::string &static_edp_xml_config, const std::string &index)

Append a builtin discovery Static EDP XML configuration file or update a builtin discovery Static EDP XML configuration file.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • static_edp_xml_config[in] Builtin discovery Static EDP XML configuration file.

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

Throws
namespace discovery_servers

Functions

std::string print(const std::string &profile_id, const std::string &prefix)

Parse XML file and print specific Domain Participant builtin remote discovery server (Discovery Server specific).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] GUID prefix of the remote server to be printed. If empty, the complete list is printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the builtin remote discovery servers list does not exist, or the list does not contain any element with the provided GUID prefix.

Returns

std::string Specific Domain Participant builtin remote discovery server.

uint32_t size(const std::string &profile_id)

Number of builtin remote discovery servers in the Domain Participant list.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or there are no remote discovery servers configured.

Returns

uint32_t Number of builtin remote discovery servers.

std::vector<std::string> keys(const std::string &profile_id)

List of the identifiers for every remote server included in the Domain Participant profile.

Parameters

profile_id[in] Domain participant profile identifier.

Throws

ErrorException if the workspace was not initialized.

Returns

std::vector<std::string> Identifier list. Empty list if there are no remote servers.

void clear(const std::string &profile_id, const std::string &prefix)

Remove specific Domain Participant discovery remote server from the list.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] GUID prefix of the remote server to be removed. If empty, the complete list is removed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or if the specified GUID prefix does not exist either.

namespace metatraffic_multicast_locators

Functions

std::string print(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic multicast locator.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

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

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string XML section containing the Domain Participant specific remote server metatraffic multicast locator.

std::string print_kind(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic multicast locator kind.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic multicast locator kind.

std::string print_port(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic multicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic multicast locator port.

std::string print_physical_port(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic multicast locator physical port. TCP only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic multicast locator TCP physical port.

std::string print_address(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic multicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic multicast locator IP address.

std::string print_unique_lan_id(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic multicast locator unique LAN ID. TCPv4 only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic multicast locator TCPv4 unique LAN ID.

std::string print_wan_address(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic multicast locator WAN IPv4 address. TCPv4 only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic multicast locator TCPv4 WAN IP address.

uint32_t size(const std::string &profile_id, const std::string &prefix)

Number of metatraffic multicast locators in the specific remote server of the specified Domain Participant.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file or the list has not been set.

Returns

uint32_t Number of metatraffic multicast locators in the remote server list.

void clear(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic multicast locator.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

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

Throws
void clear_port(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic multicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be modified.

Throws
void clear_physical_port(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic multicast locator physical port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be modified.

Throws
void clear_address(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic multicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be modified.

Throws
void clear_unique_lan_id(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic multicast locator unique LAN ID.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be modified.

Throws
void clear_wan_address(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic multicast locator WAN IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be modified.

Throws
void set_kind(const std::string &profile_id, const std::string &prefix, const std::string &kind, const std::string &index)

Append a remote server metatraffic multicast locator with specified kind or update the remote server metatraffic multicast locator kind.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • kind[in] Metatraffic multicast locator kind.

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

Throws
void set_port(const std::string &profile_id, const std::string &prefix, const std::string &port, const std::string &index)

Append a remote server metatraffic multicast locator with specified port or update the remote server metatraffic multicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • port[in] Metatraffic multicast locator port.

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

Throws
void set_physical_port(const std::string &profile_id, const std::string &prefix, const std::string &physical_port, const std::string &index)

Append a remote server metatraffic multicast locator with specified physical port or update the remote server metatraffic multicast locator physical port (TCP only).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • physical_port[in] Metatraffic multicast locator TCP physical port.

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

Throws
void set_address(const std::string &profile_id, const std::string &prefix, const std::string &address, const std::string &index)

Append a remote server metatraffic multicast locator with specified IP address or update the remote server metatraffic multicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • address[in] Metatraffic multicast locator IP address.

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

Throws
void set_unique_lan_id(const std::string &profile_id, const std::string &prefix, const std::string &unique_lan_id, const std::string &index)

Append a remote server metatraffic multicast TCPv4 locator with specified unique LAN ID or update the remote server metatraffic multicast TCPv4 locator unique LAN ID.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • unique_lan_id[in] Metatraffic multicast TCPv4 locator unique LAN ID.

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

Throws
void set_wan_address(const std::string &profile_id, const std::string &prefix, const std::string &wan_address, const std::string &index)

Append a remote server metatraffic multicast TCPv4 locator with specified WAN address or update the remote server metatraffic multicast TCPv4 locator WAN address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • wan_address[in] Metatraffic multicast TCPv4 locator WAN address.

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

Throws
namespace metatraffic_unicast_locators

Functions

std::string print(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic unicast locator.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

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

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string XML section containing the Domain Participant specific remote server metatraffic unicast locator.

std::string print_kind(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic unicast locator kind.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic unicast locator kind.

std::string print_port(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic unicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic unicast locator port.

std::string print_physical_port(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic unicast locator physical port. TCP only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic unicast locator TCP physical port.

std::string print_address(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic unicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic unicast locator IP address.

std::string print_unique_lan_id(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic unicast locator unique LAN ID. TCPv4 only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic unicast locator TCPv4 unique LAN ID.

std::string print_wan_address(const std::string &profile_id, const std::string &prefix, const std::string &index)

Parse XML file and print the specific Domain Participant specific remote server metatraffic unicast locator WAN IPv4 address. TCPv4 only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific remote server metatraffic unicast locator TCPv4 WAN IP address.

uint32_t size(const std::string &profile_id, const std::string &prefix)

Number of metatraffic unicast locators in the specific remote server of the specified Domain Participant.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile/GUID prefix is not found in the XML file or the list has not been set.

Returns

uint32_t Number of metatraffic unicast locators in the remote server list.

void clear(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic unicast locator.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

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

Throws
void clear_port(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic unicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be modified.

Throws
void clear_physical_port(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic unicast locator physical port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be modified.

Throws
void clear_address(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic unicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be modified.

Throws
void clear_unique_lan_id(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic unicast locator unique LAN ID.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be modified.

Throws
void clear_wan_address(const std::string &profile_id, const std::string &prefix, const std::string &index)

Remove specific Domain Participant remote server metatraffic unicast locator WAN IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • index[in] Collection element to be modified.

Throws
void set_kind(const std::string &profile_id, const std::string &prefix, const std::string &kind, const std::string &index)

Append a remote server metatraffic unicast locator with specified kind or update the remote server metatraffic unicast locator kind.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • kind[in] Metatraffic unicast locator kind.

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

Throws
void set_port(const std::string &profile_id, const std::string &prefix, const std::string &port, const std::string &index)

Append a remote server metatraffic unicast locator with specified port or update the remote server metatraffic unicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • port[in] Metatraffic unicast locator port.

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

Throws
void set_physical_port(const std::string &profile_id, const std::string &prefix, const std::string &physical_port, const std::string &index)

Append a remote server metatraffic unicast locator with specified physical port or update the remote server metatraffic unicast locator physical port (TCP only).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • physical_port[in] Metatraffic unicast locator TCP physical port.

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

Throws
void set_address(const std::string &profile_id, const std::string &prefix, const std::string &address, const std::string &index)

Append a remote server metatraffic unicast locator with specified IP address or update the remote server metatraffic unicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • address[in] Metatraffic unicast locator IP address.

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

Throws
void set_unique_lan_id(const std::string &profile_id, const std::string &prefix, const std::string &unique_lan_id, const std::string &index)

Append a remote server metatraffic unicast TCPv4 locator with specified unique LAN ID or update the remote server metatraffic unicast TCPv4 locator unique LAN ID.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • unique_lan_id[in] Metatraffic unicast TCPv4 locator unique LAN ID.

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

Throws
void set_wan_address(const std::string &profile_id, const std::string &prefix, const std::string &wan_address, const std::string &index)

Append a remote server metatraffic unicast TCPv4 locator with specified WAN address or update the remote server metatraffic unicast TCPv4 locator WAN address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • prefix[in] Remote server GUID prefix.

  • wan_address[in] Metatraffic unicast TCPv4 locator WAN address.

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

Throws
namespace initial_peers

Functions

std::string print(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin initial peers.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string XML section containing the Domain Participant specific builtin initial peers.

std::string print_kind(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin initial peers kind.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin initial peers kind.

std::string print_port(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin initial peers port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin initial peers port.

std::string print_physical_port(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin initial peers physical port. TCP only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin initial peers TCP physical port.

std::string print_address(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin initial peers IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin initial peers IP address.

std::string print_unique_lan_id(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin initial peers unique LAN ID. TCPv4 only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin initial peers TCPv4 unique LAN ID.

std::string print_wan_address(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin initial peers WAN IPv4 address. TCPv4 only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin initial peers TCPv4 WAN IP address.

uint32_t size(const std::string &profile_id)

Number of builtin initial peers in the Domain Participant.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the list has not been set.

Returns

uint32_t Number of builtin initial peers in the list.

void clear(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin initial peers.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
void clear_port(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin initial peers port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_physical_port(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin initial peers physical port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_address(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin initial peers IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_unique_lan_id(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin initial peers unique LAN ID.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_wan_address(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin initial peers WAN IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

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

Append a builtin initial peers with specified kind or update the builtin initial peers kind.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • kind[in] Initial peers kind.

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

Throws
void set_port(const std::string &profile_id, const std::string &port, const std::string &index)

Append a builtin initial peers with specified port or update the builtin initial peers port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • port[in] Initial peers port.

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

Throws
void set_physical_port(const std::string &profile_id, const std::string &physical_port, const std::string &index)

Append a builtin initial peers with specified physical port or update the builtin initial peers physical port (TCP only).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • physical_port[in] Initial peers TCP physical port.

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

Throws
void set_address(const std::string &profile_id, const std::string &address, const std::string &index)

Append a builtin initial peers with specified IP address or update the builtin initial peers IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • address[in] Initial peers IP address.

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

Throws
void set_unique_lan_id(const std::string &profile_id, const std::string &unique_lan_id, const std::string &index)

Append a builtin initial peers TCPv4 locator with specified unique LAN ID or update the builtin initial peers TCPv4 locator unique LAN ID.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • unique_lan_id[in] Initial peers TCPv4 locator unique LAN ID.

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

Throws
void set_wan_address(const std::string &profile_id, const std::string &wan_address, const std::string &index)

Append a builtin initial peers TCPv4 locator with specified WAN address or update the builtin initial peers TCPv4 locator WAN address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • wan_address[in] Initial peers TCPv4 locator WAN address.

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

Throws
namespace metatraffic_external_unicast_locators

Functions

std::string print(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific metatraffic external unicast locator.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string XML section containing the Domain Participant specific metatraffic external unicast locator.

std::string print_kind(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific metatraffic external unicast locator kind.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific metatraffic external unicast locator kind.

std::string print_port(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific metatraffic external unicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific metatraffic external unicast locator port.

std::string print_address(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific metatraffic external unicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific metatraffic external unicast locator IP address.

std::string print_externality(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific metatraffic external unicast locator externality.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific metatraffic external unicast locator externality.

std::string print_cost(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific metatraffic external unicast locator cost.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific metatraffic external unicast locator cost.

std::string print_mask(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific metatraffic external unicast locator mask.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific metatraffic external unicast locator mask.

uint32_t size(const std::string &profile_id)

Number of metatraffic external unicast locators in the Domain Participant.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the list has not been set.

Returns

uint32_t Number of metatraffic external unicast locators in the list.

void clear(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant metatraffic external unicast locator.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
void clear_port(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant metatraffic external unicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_address(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant metatraffic external unicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_externality(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant metatraffic external unicast locator externality.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_cost(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant metatraffic external unicast locator cost.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_mask(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant metatraffic external unicast locator mask.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

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

Append a metatraffic external unicast locator with specified kind or update the metatraffic external unicast locator kind.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • kind[in] Metatraffic unicast locator kind.

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

Throws
void set_port(const std::string &profile_id, const std::string &port, const std::string &index)

Append a metatraffic external unicast locator with specified port or update the metatraffic external unicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • port[in] Metatraffic unicast locator port.

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

Throws
void set_address(const std::string &profile_id, const std::string &address, const std::string &index)

Append a metatraffic external unicast locator with specified IP address or update the metatraffic external unicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • address[in] Metatraffic unicast locator IP address.

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

Throws
void set_externality(const std::string &profile_id, const std::string &externality, const std::string &index)

Append a metatraffic external unicast locator with specified externality or update the metatraffic external unicast locator externality.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • externality[in] Metatraffic unicast locator externality.

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

Throws
void set_cost(const std::string &profile_id, const std::string &cost, const std::string &index)

Append a metatraffic external unicast locator with specified cost or update the metatraffic external unicast locator cost.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • cost[in] Metatraffic unicast locator cost.

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

Throws
void set_mask(const std::string &profile_id, const std::string &mask, const std::string &index)

Append a metatraffic external unicast locator with specified mask or update the metatraffic external unicast locator mask.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • mask[in] Metatraffic unicast locator mask.

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

Throws
namespace metatraffic_multicast_locators

Functions

std::string print(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin metatraffic multicast locator.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string XML section containing the Domain Participant specific builtin metatraffic multicast locator.

std::string print_kind(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin metatraffic multicast locator kind.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin metatraffic multicast locator kind.

std::string print_port(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin metatraffic multicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin metatraffic multicast locator port.

std::string print_physical_port(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin metatraffic multicast locator physical port. TCP only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin metatraffic multicast locator TCP physical port.

std::string print_address(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin metatraffic multicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin metatraffic multicast locator IP address.

std::string print_unique_lan_id(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin metatraffic multicast locator unique LAN ID. TCPv4 only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin metatraffic multicast locator TCPv4 unique LAN ID.

std::string print_wan_address(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin metatraffic multicast locator WAN IPv4 address. TCPv4 only.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be printed.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string Domain Participant specific builtin metatraffic multicast locator TCPv4 WAN IP address.

uint32_t size(const std::string &profile_id)

Number of builtin metatraffic multicast locators in the Domain Participant.

Parameters

profile_id[in] Domain participant profile identifier.

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file or the list has not been set.

Returns

uint32_t Number of builtin metatraffic multicast locators in the list.

void clear(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin metatraffic multicast locator.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
void clear_port(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin metatraffic multicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_physical_port(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin metatraffic multicast locator physical port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_address(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin metatraffic multicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_unique_lan_id(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin metatraffic multicast locator unique LAN ID.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

Throws
void clear_wan_address(const std::string &profile_id, const std::string &index)

Remove specific Domain Participant builtin metatraffic multicast locator WAN IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • index[in] Collection element to be modified.

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

Append a builtin metatraffic multicast locator with specified kind or update the builtin metatraffic multicast locator kind.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • kind[in] Metatraffic multicast locator kind.

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

Throws
void set_port(const std::string &profile_id, const std::string &port, const std::string &index)

Append a builtin metatraffic multicast locator with specified port or update the builtin metatraffic multicast locator port.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • port[in] Metatraffic multicast locator port.

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

Throws
void set_physical_port(const std::string &profile_id, const std::string &physical_port, const std::string &index)

Append a builtin metatraffic multicast locator with specified physical port or update the builtin metatraffic multicast locator physical port (TCP only).

Parameters
  • profile_id[in] Domain participant profile identifier.

  • physical_port[in] Metatraffic multicast locator TCP physical port.

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

Throws
void set_address(const std::string &profile_id, const std::string &address, const std::string &index)

Append a builtin metatraffic multicast locator with specified IP address or update the builtin metatraffic multicast locator IP address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • address[in] Metatraffic multicast locator IP address.

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

Throws
void set_unique_lan_id(const std::string &profile_id, const std::string &unique_lan_id, const std::string &index)

Append a builtin metatraffic multicast TCPv4 locator with specified unique LAN ID or update the builtin metatraffic multicast TCPv4 locator unique LAN ID.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • unique_lan_id[in] Metatraffic multicast TCPv4 locator unique LAN ID.

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

Throws
void set_wan_address(const std::string &profile_id, const std::string &wan_address, const std::string &index)

Append a builtin metatraffic multicast TCPv4 locator with specified WAN address or update the builtin metatraffic multicast TCPv4 locator WAN address.

Parameters
  • profile_id[in] Domain participant profile identifier.

  • wan_address[in] Metatraffic multicast TCPv4 locator WAN address.

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

Throws
namespace metatraffic_unicast_locators

Functions

std::string print(const std::string &profile_id, const std::string &index)

Parse XML file and print the specific Domain Participant specific builtin metatraffic unicast locator.

Parameters
  • profile_id[in] Domain participant profile identifier.

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

Throws
  • ErrorException if the workspace was not initialized.

  • ElementNotFoundException if the specified Domain Participant profile is not found in the XML file, the list element does not exist, or the list does not contain any element in index position.

  • BadParameterException if the index is not an integer.

Returns

std::string XML section containing the Domain Participant specific builtin metatraffic unicast locator.

std::string print_kind(const std::string &profile_id, const std::string &index