MonitorVerbBuilder class
Monitor builder generates a command that streams incoming notifications from the secondary server to the current client. See also VerbSyntax.monitor
- Implemented types
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setteroverride
- lastNotificationTime ↔ int?
-
The timestamp, in milliseconds since epoch, to be used when building the monitor command.
When lastNotificationTime is supplied, server will only send notifications received at
or after that timestamp
getter/setter pair
- multiplexed ↔ bool
-
Whether this monitor command is to be built with the 'multiplexed' flag or not.
When multiplexed is true, the server will understand that this is a connection
which the client is using not just for notifications but also for request-response
interactions. In this case, the server will only send notifications once there is
no request currently in progress
getter/setter pair
- regex ↔ String?
-
The regular expression to be used when building the monitor command.
When regex is supplied, server will send notifications which match the regex. If strict
is true, then only those regex-matching notifications will be sent. If strict is false,
then other 'control' notifications (e.g. the statsNotification) which don't necessarily
match the regex will also be sent
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selfNotificationsEnabled ↔ bool
-
Whether self notifications should be delivered through monitor.
This flag is set to false by default.
New clients with APKAM enabled will set this flag to true.
getter/setter pair
- strict ↔ bool
-
Whether this monitor command is to be built with the 'strict' flag or not.
When strict is true, server will only send notifications which match the regex; no other
'control' notifications such as statsNotifications will be sent on this connection unless
they match the regex
getter/setter pair
Methods
-
buildCommand(
) → String -
Build the @ command to be sent to remote secondary for execution.
override
-
checkParams(
) → bool -
Checks whether all params required by the verb builder are set. Returns false if
required params are not set.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override
Static Methods
-
getBuilder(
String command) → MonitorVerbBuilder - Create a MonitorVerbBuilder from an atProtocol command string