PubSubOptions

class ntcore.PubSubOptions(*, pollStorage: int = 0, periodic: float = 0.1, excludePublisher: ntcore._ntcore.Publisher | None = None, sendAll: bool = False, topicsOnly: bool = False, keepDuplicates: bool = False, prefixMatch: bool = False, disableRemote: bool = False, disableLocal: bool = False, excludeSelf: bool = False, hidden: bool = False)

Bases: pybind11_object

NetworkTables publish/subscribe options.

Parameters:

  • 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.

  • 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.

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

  • sendAll – Send all value changes over the network.

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

  • keepDuplicates – Preserve duplicate value changes (rather than ignoring them).

  • 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.

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

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

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

  • hidden – 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.

property disableLocal → bool

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

property disableRemote → bool

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

property excludePublisher → int

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

property excludeSelf → bool

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

property hidden → 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.

kDefaultPeriodic = 0.1
property keepDuplicates → bool

Preserve duplicate value changes (rather than ignoring them).

property periodic → float

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.

property pollStorage → int

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.

property prefixMatch → 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.

property sendAll → bool

Send all value changes over the network.

property topicsOnly → bool

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