Packages

class StompClient extends AnyRef

Defines a STOMP client.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StompClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StompClient(_asJava: AnyRef)

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 asJava: AnyRef
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def close(): Unit

    Closes the client.

  8. def connect(resultHandler: Handler[AsyncResult[StompClientConnection]]): StompClient

    Connects to the server using the host and port configured in the client's options.

    Connects to the server using the host and port configured in the client's options. * @param resultHandler handler called with the connection result. A failure will be sent to the handler if a TCP level issue happen before the CONNECTED frame is received. Afterwards, the #exceptionHandler(Handler) is called.

    returns

    the current StompClient

  9. def connect(port: Int, host: String, net: NetClient, resultHandler: Handler[AsyncResult[StompClientConnection]]): StompClient

    Connects to the server.

    Connects to the server. * @param port the server port

    host

    the server host

    net

    the NET client to use

    resultHandler

    handler called with the connection result

    returns

    the current StompClient

  10. def connect(net: NetClient, resultHandler: Handler[AsyncResult[StompClientConnection]]): StompClient

    Connects to the server.

    Connects to the server. * @param net the NET client to use

    resultHandler

    handler called with the connection result

    returns

    the current StompClient

  11. def connect(port: Int, host: String, resultHandler: Handler[AsyncResult[StompClientConnection]]): StompClient

    Connects to the server.

    Connects to the server. * @param port the server port

    host

    the server host

    resultHandler

    handler called with the connection result

    returns

    the current StompClient

  12. def connectFuture(): Future[StompClientConnection]

    Like connect but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  13. def connectFuture(port: Int, host: String, net: NetClient): Future[StompClientConnection]

    Like connect but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  14. def connectFuture(net: NetClient): Future[StompClientConnection]

    Like connect but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  15. def connectFuture(port: Int, host: String): Future[StompClientConnection]

    Like connect but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def errorFrameHandler(handler: Handler[Frame]): StompClient

    A general error frame handler.

    A general error frame handler. It can be used to catch ERROR frame emitted during the connection process (wrong authentication). This error handler will be pass to all io.vertx.scala.ext.stomp.StompClientConnection created from this client. Obviously, the client can override it when the connection is established. * @param handler the handler

    returns

    the current StompClient

  19. def exceptionHandler(handler: Handler[Throwable]): StompClient

    Sets an exception handler notified for TCP-level errors.

    Sets an exception handler notified for TCP-level errors. * @param handler the handler

    returns

    the current StompClient

  20. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def isClosed(): Boolean

    returns

    whether or not the client is connected to the server.

  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def options(): StompClientOptions

    returns

    the client's options.see StompClientOptions

  29. def receivedFrameHandler(handler: Handler[Frame]): StompClient

    Configures a received handler that gets notified when a STOMP frame is received by the client.

    Configures a received handler that gets notified when a STOMP frame is received by the client. This handler can be used for logging, debugging or ad-hoc behavior. The frame can still be modified at the time.

    When a connection is created, the handler is used as io.vertx.scala.ext.stomp.StompClientConnection#receivedFrameHandler. * @param handler the handler

    returns

    the current StompClient

  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def vertx(): Vertx

    returns

    the vert.x instance used by the client.

  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  36. def writingFrameHandler(handler: Handler[Frame]): StompClient

    Configures a writing handler that gets notified when a STOMP frame is written on the wire.

    Configures a writing handler that gets notified when a STOMP frame is written on the wire. This handler can be used for logging, debugging or ad-hoc behavior. The frame can still be modified at the time.

    When a connection is created, the handler is used as io.vertx.scala.ext.stomp.StompClientConnection#writingFrameHandler. * @param handler the handler

    returns

    the current StompClient

Inherited from AnyRef

Inherited from Any

Ungrouped