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)
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.
- property disableLocal
For subscriptions, if local value updates should not be queued for ReadQueue(). See also disableRemote.
- property disableRemote
For subscriptions, if remote value updates should not be queued for ReadQueue(). See also disableLocal.
- property excludePublisher
For subscriptions, if non-zero, value updates for ReadQueue() are not queued for this publisher.
- property excludeSelf
For entries, don’t queue (for ReadQueue) value updates for the entry’s internal publisher.
- kDefaultPeriodic = 0.1
- property keepDuplicates
Preserve duplicate value changes (rather than ignoring them).
- property 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.
- property 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.
- property 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.
- property sendAll
Send all value changes over the network.
- property topicsOnly
For subscriptions, don’t ask for value changes (only topic announcements).