Struct NT_PubSubOptions

#[repr(C)]
pub struct NT_PubSubOptions {
    pub structSize: u32,
    pub pollStorage: u32,
    pub periodic: f64,
    pub excludePublisher: NT_Publisher,
    pub sendAll: NT_Bool,
    pub topicsOnly: NT_Bool,
    pub prefixMatch: NT_Bool,
    pub keepDuplicates: NT_Bool,
    pub disableRemote: NT_Bool,
    pub disableLocal: NT_Bool,
    pub excludeSelf: NT_Bool,
    pub hidden: NT_Bool,
}

NetworkTables publish/subscribe options.

Fields

structSize: u32

Structure size. Must be set to sizeof(NT_PubSubOptions).

pollStorage: u32

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.

periodic: f64

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.

excludePublisher: NT_Publisher

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

sendAll: NT_Bool

Send all value changes over the network.

topicsOnly: NT_Bool

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

prefixMatch: NT_Bool

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.

keepDuplicates: NT_Bool

Preserve duplicate value changes (rather than ignoring them).

disableRemote: NT_Bool

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

disableLocal: NT_Bool

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

excludeSelf: NT_Bool

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

hidden: NT_Bool

For subscriptions, don’t share the existence of the subscription with the network. Note this means updates will not be received from the network unless another subscription overlaps with this one, and the subscription will not appear in metatopics.

Trait Implementations

impl Clone for NT_PubSubOptions

fn clone(&self) -> NT_PubSubOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NT_PubSubOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for NT_PubSubOptions

fn eq(&self, other: &NT_PubSubOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for NT_PubSubOptions

impl StructuralPartialEq for NT_PubSubOptions