Packages

c

akka.stream.alpakka.mqttv5.impl

MqttControlImpl

final class MqttControlImpl extends MqttControl

INTERNAL API

Annotations
@InternalApi()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MqttControlImpl
  2. MqttControl
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MqttControlImpl(hasConnected: Future[Done], whenShutdown: Future[Done], drainImpl: () => Future[Done], shutdownImpl: () => Unit)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def drain(): Future[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.

    Definition Classes
    MqttControlImplMqttControl
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. val hasConnected: Future[Done]

    Completed with success if the stage's first connection attempt succeeded, otherwise fails with the exception from the connection attempt.

    Completed with success if the stage's first connection attempt succeeded, otherwise fails with the exception from the connection attempt.

    Definition Classes
    MqttControlImplMqttControl
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def onDisconnection(callback: (MqttDisconnectResponse) => Unit): MqttControlImpl

    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.

    Definition Classes
    MqttControlImplMqttControl
  17. def onMqttConnect(callback: (Boolean, String) => Unit): MqttControlImpl

    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.

    Definition Classes
    MqttControlImplMqttControl
  18. def onMqttError(callback: (MqttException) => Unit): MqttControlImpl

    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.

    Definition Classes
    MqttControlImplMqttControl
  19. def shutdown(): Future[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.

    Definition Classes
    MqttControlImplMqttControl
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. val whenShutdown: Future[Done]

    Completed when the stage has shutdown.

    Completed when the stage has shutdown.

    Definition Classes
    MqttControlImplMqttControl

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from MqttControl

Inherited from AnyRef

Inherited from Any

Ungrouped