nano-client API Reference
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Macros | Typedefs | Functions
XRCE Client
nano-client API

Macros

#define NANO_XRCE_CLIENT_INITIALIZER
 TODO.
 

Typedefs

typedef struct NANO_XRCE_ClientI NANO_XRCE_Client
 An object used to establish a session on a remote XRCE Agent and access its services. More...
 

Functions

NANO_MessageBuffer * NANO_XRCE_Client_allocate_message_buffer (NANO_XRCE_Client *const self, const NANO_XRCE_StreamId stream_id, const NANO_u8 *const payload, const NANO_u16 payload_len)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_announce (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_RequestArgs *const args)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_connect (NANO_XRCE_Client *const self, const NANO_Timeout timeout_ms)
 TODO. More...
 
NANO_bool NANO_XRCE_Client_connected (const NANO_XRCE_Client *const self)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_application_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_xml_repr)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_datareader_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_xml_repr, const NANO_u16 subscriber_id)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_datawriter_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_xml_repr, const NANO_u16 publisher_id)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_domain_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_xml_repr)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_object_w_args (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_CreateArgs *const args)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_object_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_XRCE_ObjectKind object_kind, const NANO_u16 object_id, const NANO_u16 parent_id, const char *const object_xml_repr)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_participant_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_xml_repr)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_publisher_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_xml_repr, const NANO_u16 participant_id)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_qosprofile_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_xml_repr)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_subscriber_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_xml_repr, const NANO_u16 participant_id)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_topic_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_xml_repr, const NANO_u16 participant_id)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_create_type_xml (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_xml_repr)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_delete_object_w_args (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_RequestArgs *const args)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_disconnect (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_disconnect_w_args (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_RequestArgs *const args)
 TODO. More...
 
NANO_bool NANO_XRCE_Client_discovering (const NANO_XRCE_Client *const self)
 TODO. More...
 
void NANO_XRCE_Client_dismiss_request (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token)
 TODO. More...
 
void NANO_XRCE_Client_drop_requests (NANO_XRCE_Client *const self)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_enable_stream (NANO_XRCE_Client *const self, const NANO_XRCE_StreamId stream_id, NANO_XRCE_ClientStorage *const storage)
 TODO. More...
 
void NANO_XRCE_Client_finalize (NANO_XRCE_Client *const self)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_fragment_reconstruction_buffer (NANO_XRCE_Client *const self, const NANO_XRCE_StreamId stream_id, NANO_u8 *const buffer, const NANO_usize buffer_size)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_initialize (NANO_XRCE_Client *const self, const NANO_XRCE_ClientProperties *const properties)
 TODO. More...
 
void NANO_XRCE_Client_liveliness_assertion_period (NANO_XRCE_Client *const self, const NANO_u64 period)
 TODO. More...
 
void NANO_XRCE_Client_mark_connected (NANO_XRCE_Client *const self)
 TODO. More...
 
void NANO_XRCE_Client_mark_disconnected (NANO_XRCE_Client *const self)
 TODO. More...
 
void NANO_XRCE_Client_on_data (NANO_XRCE_Client *const self, NANO_XRCE_ClientListener_OnDataFn on_data, void *const listener_ctx)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_read_data (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 reader_id, const NANO_XRCE_StreamId read_stream, const NANO_XRCE_DataDeliveryControl *const data_delivery_ctrl, const char *const content_filter)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_read_w_args (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_ReadArgs *const args)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_register_datareader (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_ref)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_register_datawriter (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_ref)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_register_object (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_XRCE_ObjectKind object_kind, const NANO_u16 object_id, const NANO_u16 parent_id, const char *const object_ref)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_register_participant (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_ref)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_register_publisher (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_ref)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_register_subscriber (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_ref)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_register_topic (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 object_id, const char *const object_ref)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_release_message_buffer (NANO_XRCE_Client *const self, const NANO_XRCE_StreamId stream_id, NANO_MessageBuffer *const mbuf)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_run_session (NANO_XRCE_Client *const self, const NANO_usize max_messages, const NANO_Timeout timeout_ms)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_update_locator (NANO_XRCE_Client *const self, const NANO_XRCE_ClientTransportLocatorType locator_type, const NANO_XRCE_TransportLocator *const locator)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_wait_for_data_received (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_Timeout wait_timeout_ms)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_wait_for_request_acked (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_Timeout wait_timeout_ms)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_wait_for_request_complete (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_Timeout wait_timeout_ms, NANO_XRCE_ResultStatus *const request_result_out)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_write_data (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_StreamId request_stream, const NANO_XRCE_RequestFlags request_flags, const NANO_Timeout request_timeout_ms, const NANO_u16 writer_id, const NANO_u8 *const payload, const NANO_u16 payload_len)
 TODO. More...
 
NANO_RetCode NANO_XRCE_Client_write_w_args (NANO_XRCE_Client *const self, NANO_XRCE_ClientRequestToken *const request_token, const NANO_XRCE_WriteArgs *const args)
 TODO. More...
 

Detailed Description

Typedef Documentation

◆ NANO_XRCE_Client

typedef struct NANO_XRCE_ClientI NANO_XRCE_Client

An object used to establish a session on a remote XRCE Agent and access its services.

A NANO_XRCE_Client encapsulate all the state required by an application to communicate with an XRCE Agent, and operate on the XRCE Objects it contains.

Function Documentation

◆ NANO_XRCE_Client_allocate_message_buffer()

NANO_MessageBuffer* NANO_XRCE_Client_allocate_message_buffer ( NANO_XRCE_Client *const  self,
const NANO_XRCE_StreamId  stream_id,
const NANO_u8 *const  payload,
const NANO_u16  payload_len 
)

TODO.

Parameters
self
stream_id
payload
payload_len
Returns
NANO_MessageBuffer

◆ NANO_XRCE_Client_announce()

NANO_RetCode NANO_XRCE_Client_announce ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_RequestArgs *const  args 
)

TODO.

Parameters
self
request_token
args
Returns
NANO_RetCode

◆ NANO_XRCE_Client_connect()

NANO_RetCode NANO_XRCE_Client_connect ( NANO_XRCE_Client *const  self,
const NANO_Timeout  timeout_ms 
)

TODO.

Parameters
self
timeout_ms
Returns
NANO_RetCode

◆ NANO_XRCE_Client_connected()

NANO_bool NANO_XRCE_Client_connected ( const NANO_XRCE_Client *const  self)

TODO.

Parameters
self
Returns
NANO_bool

◆ NANO_XRCE_Client_create_application_xml()

NANO_RetCode NANO_XRCE_Client_create_application_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_xml_repr 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_xml_repr
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_datareader_xml()

NANO_RetCode NANO_XRCE_Client_create_datareader_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_xml_repr,
const NANO_u16  subscriber_id 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_xml_repr
subscriber_id
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_datawriter_xml()

NANO_RetCode NANO_XRCE_Client_create_datawriter_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_xml_repr,
const NANO_u16  publisher_id 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_xml_repr
publisher_id
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_domain_xml()

NANO_RetCode NANO_XRCE_Client_create_domain_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_xml_repr 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_xml_repr
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_object_w_args()

NANO_RetCode NANO_XRCE_Client_create_object_w_args ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_CreateArgs *const  args 
)

TODO.

Parameters
self
request_token
args
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_object_xml()

NANO_RetCode NANO_XRCE_Client_create_object_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_XRCE_ObjectKind  object_kind,
const NANO_u16  object_id,
const NANO_u16  parent_id,
const char *const  object_xml_repr 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_kind
object_id
parent_id
object_xml_repr
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_participant_xml()

NANO_RetCode NANO_XRCE_Client_create_participant_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_xml_repr 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_xml_repr
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_publisher_xml()

NANO_RetCode NANO_XRCE_Client_create_publisher_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_xml_repr,
const NANO_u16  participant_id 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_xml_repr
participant_id
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_qosprofile_xml()

NANO_RetCode NANO_XRCE_Client_create_qosprofile_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_xml_repr 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_xml_repr
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_subscriber_xml()

NANO_RetCode NANO_XRCE_Client_create_subscriber_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_xml_repr,
const NANO_u16  participant_id 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_xml_repr
participant_id
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_topic_xml()

NANO_RetCode NANO_XRCE_Client_create_topic_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_xml_repr,
const NANO_u16  participant_id 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_xml_repr
participant_id
Returns
NANO_RetCode

◆ NANO_XRCE_Client_create_type_xml()

NANO_RetCode NANO_XRCE_Client_create_type_xml ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_xml_repr 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_xml_repr
Returns
NANO_RetCode

◆ NANO_XRCE_Client_delete_object_w_args()

NANO_RetCode NANO_XRCE_Client_delete_object_w_args ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_RequestArgs *const  args 
)

TODO.

Parameters
self
request_token
args
Returns
NANO_RetCode

◆ NANO_XRCE_Client_disconnect()

NANO_RetCode NANO_XRCE_Client_disconnect ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
Returns
NANO_RetCode

◆ NANO_XRCE_Client_disconnect_w_args()

NANO_RetCode NANO_XRCE_Client_disconnect_w_args ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_RequestArgs *const  args 
)

TODO.

Parameters
self
request_token
args
Returns
NANO_RetCode

◆ NANO_XRCE_Client_discovering()

NANO_bool NANO_XRCE_Client_discovering ( const NANO_XRCE_Client *const  self)

TODO.

Parameters
self
Returns
NANO_bool

◆ NANO_XRCE_Client_dismiss_request()

void NANO_XRCE_Client_dismiss_request ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token 
)

TODO.

Parameters
self
request_token

◆ NANO_XRCE_Client_drop_requests()

void NANO_XRCE_Client_drop_requests ( NANO_XRCE_Client *const  self)

TODO.

Parameters
self

◆ NANO_XRCE_Client_enable_stream()

NANO_RetCode NANO_XRCE_Client_enable_stream ( NANO_XRCE_Client *const  self,
const NANO_XRCE_StreamId  stream_id,
NANO_XRCE_ClientStorage *const  storage 
)

TODO.

Parameters
self
stream_id
storage
Returns
NANO_RetCode

◆ NANO_XRCE_Client_finalize()

void NANO_XRCE_Client_finalize ( NANO_XRCE_Client *const  self)

TODO.

Parameters
self

◆ NANO_XRCE_Client_fragment_reconstruction_buffer()

NANO_RetCode NANO_XRCE_Client_fragment_reconstruction_buffer ( NANO_XRCE_Client *const  self,
const NANO_XRCE_StreamId  stream_id,
NANO_u8 *const  buffer,
const NANO_usize  buffer_size 
)

TODO.

Parameters
self
stream_id
buffer
buffer_size
Returns
NANO_RetCode

◆ NANO_XRCE_Client_initialize()

NANO_RetCode NANO_XRCE_Client_initialize ( NANO_XRCE_Client *const  self,
const NANO_XRCE_ClientProperties *const  properties 
)

TODO.

Parameters
self
properties
Returns
NANO_RetCode

◆ NANO_XRCE_Client_liveliness_assertion_period()

void NANO_XRCE_Client_liveliness_assertion_period ( NANO_XRCE_Client *const  self,
const NANO_u64  period 
)

TODO.

Parameters
self
period

◆ NANO_XRCE_Client_mark_connected()

void NANO_XRCE_Client_mark_connected ( NANO_XRCE_Client *const  self)

TODO.

Parameters
self

◆ NANO_XRCE_Client_mark_disconnected()

void NANO_XRCE_Client_mark_disconnected ( NANO_XRCE_Client *const  self)

TODO.

Parameters
self
Returns

◆ NANO_XRCE_Client_on_data()

void NANO_XRCE_Client_on_data ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientListener_OnDataFn  on_data,
void *const  listener_ctx 
)

TODO.

Parameters
self
on_data
listener_ctx

◆ NANO_XRCE_Client_read_data()

NANO_RetCode NANO_XRCE_Client_read_data ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  reader_id,
const NANO_XRCE_StreamId  read_stream,
const NANO_XRCE_DataDeliveryControl *const  data_delivery_ctrl,
const char *const  content_filter 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
reader_id
read_stream
data_delivery_ctrl
content_filter
Returns
NANO_RetCode

◆ NANO_XRCE_Client_read_w_args()

NANO_RetCode NANO_XRCE_Client_read_w_args ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_ReadArgs *const  args 
)

TODO.

Parameters
self
request_token
args
Returns
NANO_RetCode

◆ NANO_XRCE_Client_register_datareader()

NANO_RetCode NANO_XRCE_Client_register_datareader ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_ref 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_ref
Returns
NANO_RetCode

◆ NANO_XRCE_Client_register_datawriter()

NANO_RetCode NANO_XRCE_Client_register_datawriter ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_ref 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_ref
Returns
NANO_RetCode

◆ NANO_XRCE_Client_register_object()

NANO_RetCode NANO_XRCE_Client_register_object ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_XRCE_ObjectKind  object_kind,
const NANO_u16  object_id,
const NANO_u16  parent_id,
const char *const  object_ref 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_kind
object_id
parent_id
object_ref
Returns
NANO_RetCode

◆ NANO_XRCE_Client_register_participant()

NANO_RetCode NANO_XRCE_Client_register_participant ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_ref 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_ref
Returns
NANO_RetCode

◆ NANO_XRCE_Client_register_publisher()

NANO_RetCode NANO_XRCE_Client_register_publisher ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_ref 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_ref
Returns
NANO_RetCode

◆ NANO_XRCE_Client_register_subscriber()

NANO_RetCode NANO_XRCE_Client_register_subscriber ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_ref 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_ref
Returns
NANO_RetCode

◆ NANO_XRCE_Client_register_topic()

NANO_RetCode NANO_XRCE_Client_register_topic ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  object_id,
const char *const  object_ref 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
object_id
object_ref
Returns
NANO_RetCode

◆ NANO_XRCE_Client_release_message_buffer()

NANO_RetCode NANO_XRCE_Client_release_message_buffer ( NANO_XRCE_Client *const  self,
const NANO_XRCE_StreamId  stream_id,
NANO_MessageBuffer *const  mbuf 
)

TODO.

Parameters
self
stream_id
mbuf
Returns
NANO_RetCode

◆ NANO_XRCE_Client_run_session()

NANO_RetCode NANO_XRCE_Client_run_session ( NANO_XRCE_Client *const  self,
const NANO_usize  max_messages,
const NANO_Timeout  timeout_ms 
)

TODO.

Parameters
self
max_messages
timeout_ms
Returns
NANO_RetCode

◆ NANO_XRCE_Client_update_locator()

NANO_RetCode NANO_XRCE_Client_update_locator ( NANO_XRCE_Client *const  self,
const NANO_XRCE_ClientTransportLocatorType  locator_type,
const NANO_XRCE_TransportLocator *const  locator 
)

TODO.

Parameters
self
locator_type
locator
Returns
NANO_RetCode

◆ NANO_XRCE_Client_wait_for_data_received()

NANO_RetCode NANO_XRCE_Client_wait_for_data_received ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_Timeout  wait_timeout_ms 
)

TODO.

Parameters
self
request_token
wait_timeout_ms
Returns
NANO_RetCode

◆ NANO_XRCE_Client_wait_for_request_acked()

NANO_RetCode NANO_XRCE_Client_wait_for_request_acked ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_Timeout  wait_timeout_ms 
)

TODO.

Parameters
self
request_token
wait_timeout_ms
Returns
NANO_RetCode

◆ NANO_XRCE_Client_wait_for_request_complete()

NANO_RetCode NANO_XRCE_Client_wait_for_request_complete ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_Timeout  wait_timeout_ms,
NANO_XRCE_ResultStatus *const  request_result_out 
)

TODO.

Parameters
self
request_token
wait_timeout_ms
request_result_out
Returns
NANO_RetCode

◆ NANO_XRCE_Client_write_data()

NANO_RetCode NANO_XRCE_Client_write_data ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_StreamId  request_stream,
const NANO_XRCE_RequestFlags  request_flags,
const NANO_Timeout  request_timeout_ms,
const NANO_u16  writer_id,
const NANO_u8 *const  payload,
const NANO_u16  payload_len 
)

TODO.

Parameters
self
request_token
request_stream
request_flags
request_timeout_ms
writer_id
payload
payload_len
Returns
NANO_RetCode

◆ NANO_XRCE_Client_write_w_args()

NANO_RetCode NANO_XRCE_Client_write_w_args ( NANO_XRCE_Client *const  self,
NANO_XRCE_ClientRequestToken *const  request_token,
const NANO_XRCE_WriteArgs *const  args 
)

TODO.

Parameters
self
request_token
args
Returns
NANO_RetCode