final class MqttControl extends AnyRef
Represents an application view of a connection to an MQTT broker as used by a stage
Constructor is INTERNAL API.
- Alphabetic
- By Inheritance
- MqttControl
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def drain(): CompletionStage[Done]
Instruct the stage to drain and then stop.
Instruct the stage to drain and then stop. The exact semantics of this depend on the particular stage.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hasConnected: CompletionStage[Done]
Completed with success if the stage's first connection attempt succeeded, otherwise fails with the exception from the connection attempt.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def onDisconnection(callback: Consumer[MqttDisconnectResponse]): MqttControl
Register a callback to be executed when the connection is lost to the stage (e.g.
Register a callback to be executed when the connection is lost to the stage (e.g. for instrumentation)
Callbacks are executed asynchronously and it is possible that the same callback may be executed simultaneously (therefore the callback must be concurrency-safe). The callback must also not throw, and blocking should be avoided.
It is not possible to unregister a callback. Dynamic callback registrations can be implemented in the application by, e.g., registering a single callback which sends a message to an actor.
- def onMqttConnect(callback: BiConsumer[Boolean, String]): MqttControl
Register a callback to be executed when a server is connected to (e.g.
Register a callback to be executed when a server is connected to (e.g. for instrumentation).
The callback is passed a Boolean which is true if this is a reconnection and the URI of the server connected to.
Callbacks are executed asynchronously and it is possible that the same callback may be executed simultaneously (therefore the callback must be concurrency-safe). The callback must also not throw, and blocking should be avoided.
It is not possible to unregister a callback. Dynamic callback registrations can be implemented in the application by, e.g., registering a single callback which sends a message to an actor.
- def onMqttError(callback: Consumer[MqttException]): MqttControl
Register a callback to be executed if an error is raised by the underlying client (e.g.
Register a callback to be executed if an error is raised by the underlying client (e.g. for instrumentation).
Callbacks are executed asynchronously and it is possible that the same callback may be executed simultaneously (therefore the callback must be concurrency-safe). The callback must also not throw, and blocking should be avoided.
It is not possible to unregister a callback. Dynamic callback registrations can be implemented in the application by, e.g., registering a single callback which sends a message to an actor.
- def shutdown(): CompletionStage[Done]
Instruct the stage to stop immediately without draining.
Instruct the stage to stop immediately without draining. The exact semantics of this depend on the particular stage.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def whenShutdown: CompletionStage[Done]
Completed when the stage has shutdown.