nano-client API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
XRCE Stream Storage

Data Structures

struct  NANO_XRCE_DefaultBestEffortStreamStorage
 TODO. More...
 
struct  NANO_XRCE_DefaultReliableStreamStorage
 TODO. More...
 
struct  NANO_XRCE_StreamStorage
 TODO. More...
 

Macros

#define NANO_XRCE_CUSTOMSTREAMSTORAGE_INITIALIZE(s_)
 TODO.
 
#define NANO_XRCE_CUSTOMSTREAMSTORAGE_INITIALIZER
 TODO.
 
#define NANO_XRCE_CUSTOMSTREAMSTORAGE_PAYLOAD_IN_SIZE(max_payload_in_)
 TODO.
 
#define NANO_XRCE_CUSTOMSTREAMSTORAGE_TYPE_MEMBERS(max_header_, max_payload_, max_payload_tail_, max_payload_user_, max_payload_in_)
 TODO.
 
#define NANO_XRCE_DefaultBestEffortStreamStorage_initialize(s_)   NANO_XRCE_SIMPLESTREAMSTORAGE_INITIALIZE((s_))
 TODO.
 
#define NANO_XRCE_DEFAULTBESTEFFORTSTREAMSTORAGE_INITIALIZER   NANO_XRCE_CUSTOMSTREAMSTORAGE_INITIALIZER
 TODO.
 
#define NANO_XRCE_DEFAULTBESTEFFORTSTREAMSTORAGE_SIZE   1
 TODO.
 
#define NANO_XRCE_DefaultReliableStreamStorage_initialize(s_)   NANO_XRCE_SIMPLESTREAMSTORAGE_INITIALIZE((s_))
 TODO.
 
#define NANO_XRCE_DEFAULTRELIABLESTREAMSTORAGE_INITIALIZER   NANO_XRCE_CUSTOMSTREAMSTORAGE_INITIALIZER
 TODO.
 
#define NANO_XRCE_SIMPLESTREAMSTORAGE_TYPE_MEMBERS(send_queue_len_, max_payload_in_)
 TODO.
 
#define NANO_XRCE_STREAM_INLINE_BUFFER_HEADER_SIZE
 TODO.
 
#define NANO_XRCE_STREAM_INLINE_BUFFER_HEADER_SIZE_BYTES   (NANO_XRCE_STREAM_INLINE_BUFFER_HEADER_SIZE * sizeof(NANO_MessageBufferData))
 TODO.
 
#define NANO_XRCE_STREAM_INLINE_BUFFER_TAIL_SIZE
 TODO.
 
#define NANO_XRCE_STREAM_INLINE_BUFFER_TAIL_SIZE_BYTES   (NANO_XRCE_STREAM_INLINE_BUFFER_TAIL_SIZE * sizeof(NANO_MessageBufferData))
 TODO.
 
#define NANO_XRCE_STREAM_INLINE_PAYLOAD_HEADER_SIZE   NANO_XRCE_CREATECLIENTPAYLOAD_HEADER_SERIALIZED_SIZE_MAX
 TODO.
 
#define NANO_XRCE_STREAM_INLINE_PAYLOAD_TAIL_SIZE   NANO_XRCE_READDATAPAYLOAD_TAIL_SERIALIZED_SIZE_MAX
 TODO.
 
#define NANO_XRCE_STREAMSTORAGE_INITIALIZER
 TODO.
 

Functions

void NANO_XRCE_StreamStorage_initialize (NANO_XRCE_StreamStorage *const self, NANO_MessageBufferData *const header, const NANO_usize header_max, NANO_MessageBufferData *const payload, const NANO_usize payload_max, NANO_MessageBufferData *const payload_tail, const NANO_usize payload_tail_max, NANO_MessageBuffer *const payload_user, const NANO_usize payload_user_max, NANO_MessageBufferData *const payload_in, const NANO_usize payload_in_max)
 TODO. More...
 

Detailed Description

Function Documentation

◆ NANO_XRCE_StreamStorage_initialize()

void NANO_XRCE_StreamStorage_initialize ( NANO_XRCE_StreamStorage *const  self,
NANO_MessageBufferData *const  header,
const NANO_usize  header_max,
NANO_MessageBufferData *const  payload,
const NANO_usize  payload_max,
NANO_MessageBufferData *const  payload_tail,
const NANO_usize  payload_tail_max,
NANO_MessageBuffer *const  payload_user,
const NANO_usize  payload_user_max,
NANO_MessageBufferData *const  payload_in,
const NANO_usize  payload_in_max 
)

TODO.

Parameters
self
header
header_max
payload
payload_max
payload_tail
payload_tail_max
payload_user
payload_user_max
payload_in
payload_in_max