WPILibC++ 2024.3.2
ntcore C meta-topic API

Meta-topic decoders for C. More...

Classes

struct  NT_Meta_SubscriberOptions
 Subscriber options. More...
 
struct  NT_Meta_TopicPublisher
 Topic publisher (as published via $pub$<topic>). More...
 
struct  NT_Meta_TopicSubscriber
 Topic subscriber (as published via $sub$<topic>). More...
 
struct  NT_Meta_ClientPublisher
 Client publisher (as published via $clientpub$<client> or $serverpub). More...
 
struct  NT_Meta_ClientSubscriber
 Client subscriber (as published via $clientsub$<client> or $serversub). More...
 
struct  NT_Meta_Client
 Client (as published via $clients). More...
 

Functions

struct NT_Meta_TopicPublisherNT_Meta_DecodeTopicPublishers (const uint8_t *data, size_t size, size_t *count)
 Decodes $pub$<topic> meta-topic data. More...
 
struct NT_Meta_TopicSubscriberNT_Meta_DecodeTopicSubscribers (const uint8_t *data, size_t size, size_t *count)
 Decodes $sub$<topic> meta-topic data. More...
 
struct NT_Meta_ClientPublisherNT_Meta_DecodeClientPublishers (const uint8_t *data, size_t size, size_t *count)
 Decodes $clientpub$<topic> meta-topic data. More...
 
struct NT_Meta_ClientSubscriberNT_Meta_DecodeClientSubscribers (const uint8_t *data, size_t size, size_t *count)
 Decodes $clientsub$<topic> meta-topic data. More...
 
struct NT_Meta_ClientNT_Meta_DecodeClients (const uint8_t *data, size_t size, size_t *count)
 Decodes $clients meta-topic data. More...
 
void NT_Meta_FreeTopicPublishers (struct NT_Meta_TopicPublisher *arr, size_t count)
 Frees an array of NT_Meta_TopicPublisher. More...
 
void NT_Meta_FreeTopicSubscribers (struct NT_Meta_TopicSubscriber *arr, size_t count)
 Frees an array of NT_Meta_TopicSubscriber. More...
 
void NT_Meta_FreeClientPublishers (struct NT_Meta_ClientPublisher *arr, size_t count)
 Frees an array of NT_Meta_ClientPublisher. More...
 
void NT_Meta_FreeClientSubscribers (struct NT_Meta_ClientSubscriber *arr, size_t count)
 Frees an array of NT_Meta_ClientSubscriber. More...
 
void NT_Meta_FreeClients (struct NT_Meta_Client *arr, size_t count)
 Frees an array of NT_Meta_Client. More...
 

Detailed Description

Meta-topic decoders for C.

Function Documentation

◆ NT_Meta_DecodeClientPublishers()

struct NT_Meta_ClientPublisher * NT_Meta_DecodeClientPublishers ( const uint8_t *  data,
size_t  size,
size_t *  count 
)

Decodes $clientpub$<topic> meta-topic data.

Parameters
datadata contents
sizesize of data contents
countnumber of elements in returned array (output)
Returns
Array of ClientPublishers, or NULL on decoding error.

◆ NT_Meta_DecodeClients()

struct NT_Meta_Client * NT_Meta_DecodeClients ( const uint8_t *  data,
size_t  size,
size_t *  count 
)

Decodes $clients meta-topic data.

Parameters
datadata contents
sizesize of data contents
countnumber of elements in returned array (output)
Returns
Array of Clients, or NULL on decoding error.

◆ NT_Meta_DecodeClientSubscribers()

struct NT_Meta_ClientSubscriber * NT_Meta_DecodeClientSubscribers ( const uint8_t *  data,
size_t  size,
size_t *  count 
)

Decodes $clientsub$<topic> meta-topic data.

Parameters
datadata contents
sizesize of data contents
countnumber of elements in returned array (output)
Returns
Array of ClientSubscribers, or NULL on decoding error.

◆ NT_Meta_DecodeTopicPublishers()

struct NT_Meta_TopicPublisher * NT_Meta_DecodeTopicPublishers ( const uint8_t *  data,
size_t  size,
size_t *  count 
)

Decodes $pub$<topic> meta-topic data.

Parameters
datadata contents
sizesize of data contents
countnumber of elements in returned array (output)
Returns
Array of TopicPublishers, or NULL on decoding error.

◆ NT_Meta_DecodeTopicSubscribers()

struct NT_Meta_TopicSubscriber * NT_Meta_DecodeTopicSubscribers ( const uint8_t *  data,
size_t  size,
size_t *  count 
)

Decodes $sub$<topic> meta-topic data.

Parameters
datadata contents
sizesize of data contents
countnumber of elements in returned array (output)
Returns
Array of TopicSubscribers, or NULL on decoding error.

◆ NT_Meta_FreeClientPublishers()

void NT_Meta_FreeClientPublishers ( struct NT_Meta_ClientPublisher arr,
size_t  count 
)

Frees an array of NT_Meta_ClientPublisher.

Parameters
arrpointer to the array to free
countsize of the array to free

◆ NT_Meta_FreeClients()

void NT_Meta_FreeClients ( struct NT_Meta_Client arr,
size_t  count 
)

Frees an array of NT_Meta_Client.

Parameters
arrpointer to the array to free
countsize of the array to free

◆ NT_Meta_FreeClientSubscribers()

void NT_Meta_FreeClientSubscribers ( struct NT_Meta_ClientSubscriber arr,
size_t  count 
)

Frees an array of NT_Meta_ClientSubscriber.

Parameters
arrpointer to the array to free
countsize of the array to free

◆ NT_Meta_FreeTopicPublishers()

void NT_Meta_FreeTopicPublishers ( struct NT_Meta_TopicPublisher arr,
size_t  count 
)

Frees an array of NT_Meta_TopicPublisher.

Parameters
arrpointer to the array to free
countsize of the array to free

◆ NT_Meta_FreeTopicSubscribers()

void NT_Meta_FreeTopicSubscribers ( struct NT_Meta_TopicSubscriber arr,
size_t  count 
)

Frees an array of NT_Meta_TopicSubscriber.

Parameters
arrpointer to the array to free
countsize of the array to free