WPILibC++ 2023.4.3-108-ge5452e3
NT_PubSubOptions Struct Reference

NetworkTables publish/subscribe options. More...

#include <ntcore_c.h>

Public Attributes

unsigned int structSize
 Structure size. More...
 
unsigned int pollStorage
 Polling storage size for a subscription. More...
 
double periodic
 How frequently changes will be sent over the network, in seconds. More...
 
NT_Publisher excludePublisher
 For subscriptions, if non-zero, value updates for ReadQueue() are not queued for this publisher. More...
 
NT_Bool sendAll
 Send all value changes over the network. More...
 
NT_Bool topicsOnly
 For subscriptions, don't ask for value changes (only topic announcements). More...
 
NT_Bool prefixMatch
 Perform prefix match on subscriber topic names. More...
 
NT_Bool keepDuplicates
 Preserve duplicate value changes (rather than ignoring them). More...
 
NT_Bool disableRemote
 For subscriptions, if remote value updates should not be queued for ReadQueue(). More...
 
NT_Bool disableLocal
 For subscriptions, if local value updates should not be queued for ReadQueue(). More...
 
NT_Bool excludeSelf
 For entries, don't queue (for ReadQueue) value updates for the entry's internal publisher. More...
 

Detailed Description

NetworkTables publish/subscribe options.

Member Data Documentation

◆ disableLocal

NT_Bool NT_PubSubOptions::disableLocal

For subscriptions, if local value updates should not be queued for ReadQueue().

See also disableRemote.

◆ disableRemote

NT_Bool NT_PubSubOptions::disableRemote

For subscriptions, if remote value updates should not be queued for ReadQueue().

See also disableLocal.

◆ excludePublisher

NT_Publisher NT_PubSubOptions::excludePublisher

For subscriptions, if non-zero, value updates for ReadQueue() are not queued for this publisher.

◆ excludeSelf

NT_Bool NT_PubSubOptions::excludeSelf

For entries, don't queue (for ReadQueue) value updates for the entry's internal publisher.

◆ keepDuplicates

NT_Bool NT_PubSubOptions::keepDuplicates

Preserve duplicate value changes (rather than ignoring them).

◆ periodic

double NT_PubSubOptions::periodic

How frequently changes will be sent over the network, in seconds.

NetworkTables may send more frequently than this (e.g. use a combined minimum period for all values) or apply a restricted range to this value. The default is 100 ms.

◆ pollStorage

unsigned int NT_PubSubOptions::pollStorage

Polling storage size for a subscription.

Specifies the maximum number of updates NetworkTables should store between calls to the subscriber's ReadQueue() function. If zero, defaults to 1 if sendAll is false, 20 if sendAll is true.

◆ prefixMatch

NT_Bool NT_PubSubOptions::prefixMatch

Perform prefix match on subscriber topic names.

Is ignored/overridden by Subscribe() functions; only present in struct for the purposes of getting information about subscriptions.

◆ sendAll

NT_Bool NT_PubSubOptions::sendAll

Send all value changes over the network.

◆ structSize

unsigned int NT_PubSubOptions::structSize

Structure size.

Must be set to sizeof(NT_PubSubOptions).

◆ topicsOnly

NT_Bool NT_PubSubOptions::topicsOnly

For subscriptions, don't ask for value changes (only topic announcements).


The documentation for this struct was generated from the following file: