Interface PubSubOption

All Known Implementing Classes:
PubSubOption.DisableLocal, PubSubOption.DisableRemote, PubSubOption.ExcludePublisher, PubSubOption.ExcludePublisherHandle, PubSubOption.ExcludeSelf, PubSubOption.Hidden, PubSubOption.KeepDuplicates, PubSubOption.Periodic, PubSubOption.PollStorage, PubSubOption.SendAll, PubSubOption.TopicsOnly
public sealed interface PubSubOption permits PubSubOption.Periodic, PubSubOption.SendAll, PubSubOption.TopicsOnly, PubSubOption.KeepDuplicates, PubSubOption.PollStorage, PubSubOption.DisableRemote, PubSubOption.DisableLocal, PubSubOption.ExcludePublisher, PubSubOption.ExcludePublisherHandle, PubSubOption.ExcludeSelf, PubSubOption.Hidden
NetworkTables publish/subscribe option.

  • Field Details

    • SEND_CHANGES

      static final PubSubOption SEND_CHANGES
      Indicates only value changes will be sent over the network (default).

    • SEND_ALL

      static final PubSubOption SEND_ALL
      Indicates all value changes will be sent over the network.

    • TOPICS_AND_VALUES

      static final PubSubOption TOPICS_AND_VALUES
      Indicates both topics and values will be sent over the network (default).

    • TOPICS_ONLY

      static final PubSubOption TOPICS_ONLY
      Indicates only topics will be sent over the network.

    • IGNORE_DUPLICATES

      static final PubSubOption IGNORE_DUPLICATES
      Indicates duplicate value changes will be ignored (default).

    • KEEP_DUPLICATES

      static final PubSubOption KEEP_DUPLICATES
      Indicates duplicate value changes will be preserved.

    • ENABLE_REMOTE

      static final PubSubOption ENABLE_REMOTE
      For subscriptions, indicates remote value updates will be queued for readQueue() (default).

    • DISABLE_REMOTE

      static final PubSubOption DISABLE_REMOTE
      For subscriptions, indicates remote value updates will not be queued for readQueue() .

    • ENABLE_LOCAL

      static final PubSubOption ENABLE_LOCAL
      For subscriptions, indicates local value updates will be queued for readQueue() (default).

    • DISABLE_LOCAL

      static final PubSubOption DISABLE_LOCAL
      For subscriptions, indicates local value updates will not be queued for readQueue() .

    • INCLUDE_SELF

      static final PubSubOption INCLUDE_SELF
      For entries, indicates value updates from the internal publisher will be included (default).

    • EXCLUDE_SELF

      static final PubSubOption EXCLUDE_SELF
      For entries, indicates value updates from the internal publisher will be excluded.

    • VISIBLE

      static final PubSubOption VISIBLE
      For subscriptions, indicates the subscription is visible to the network (default).

    • HIDDEN

      static final PubSubOption HIDDEN
      For subscriptions, indicates the subscription is hidden from the network.

  • Method Details

    • periodic

      static PubSubOption periodic(double period)
      How frequently changes will be sent over the network. 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 if unspecified is 100 ms.
      Parameters:
      period - time between updates, in seconds
      Returns:
      option

    • pollStorage

      static PubSubOption pollStorage(int depth)
      Polling storage for subscription. Specifies the maximum number of updates NetworkTables should store between calls to the subscriber's readQueue() function. Defaults to 1 if sendAll is false, 20 if sendAll is true.
      Parameters:
      depth - number of entries to save for polling.
      Returns:
      option

    • excludePublisher

      static PubSubOption excludePublisher(int publisher)
      Don't queue value updates for the given publisher. Only has an effect on subscriptions. Only one exclusion may be set.
      Parameters:
      publisher - publisher handle to exclude
      Returns:
      option

    • excludePublisher

      static PubSubOption excludePublisher(Publisher publisher)
      Don't queue value updates for the given publisher. Only has an effect on subscriptions. Only one exclusion may be set.
      Parameters:
      publisher - publisher to exclude
      Returns:
      option