DetectPublishersOptions class

Options for detecting matching advanced publishers.

The presence of this object on AdvancedSubscriberOptions.detectPublishers enables detection; this object carries only the history flag. Splitting the two axes makes the invalid combination — asking for history with detection off — unrepresentable rather than silently ignored.

Canon models the same thing as a struct (z_liveliness_subscriber_options_t), which is why a presence carries the enable axis here while enableMatchingListener on the publisher side is a bare bool: canon's matching listener has no options struct to stand in for.

Constructors

DetectPublishersOptions({bool? history, bool retainPayload = false})
Creates detect-publishers options.
const

Properties

hashCode int
The hash code for this object.
no setterinherited
history bool?
Whether to receive events for advanced publishers that were already live when detection was declared.
final
retainPayload bool
Whether detection samples carry a retained Sample.payloadZBytes.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited