Class StompClient

java.lang.Object
io.vertx.reactivex.ext.stomp.StompClient
All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class StompClient extends Object implements io.vertx.lang.rx.RxDelegate
Defines a STOMP client.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

  • Field Details

    • __TYPE_ARG

      public static final io.vertx.lang.rx.TypeArg<StompClient> __TYPE_ARG

  • Constructor Details

    • StompClient

      public StompClient(StompClient delegate)

    • StompClient

      public StompClient(Object delegate)

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getDelegate

      public StompClient getDelegate()
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate

    • create

      public static StompClient create(Vertx vertx)
      Creates a StompClient using the default implementation.
      Parameters:
      vertx - the vert.x instance to use
      Returns:
      the created StompClient

    • create

      public static StompClient create(Vertx vertx, StompClientOptions options)
      Creates a StompClient using the default implementation.
      Parameters:
      vertx - the vert.x instance to use
      options - the options
      Returns:
      the created StompClient

    • connect

      public Future<StompClientConnection> connect(int port, String host)
      Connects to the server.
      Parameters:
      port - the server port
      host - the server host
      Returns:
      a future notified with the connection result

    • rxConnect

      public Single<StompClientConnection> rxConnect(int port, String host)
      Connects to the server.
      Parameters:
      port - the server port
      host - the server host
      Returns:
      a future notified with the connection result

    • connect

      public Future<StompClientConnection> connect()
      Connects to the server using the host and port configured in the client's options.
      Returns:
      a future notified with the connection result. A failure will be sent to the handler if a TCP level issue happen before the `CONNECTED` frame is received.

    • rxConnect

      public Single<StompClientConnection> rxConnect()
      Connects to the server using the host and port configured in the client's options.
      Returns:
      a future notified with the connection result. A failure will be sent to the handler if a TCP level issue happen before the `CONNECTED` frame is received.

    • receivedFrameHandler

      public StompClient receivedFrameHandler(Handler<Frame> handler)
      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 StompClientConnection.receivedFrameHandler(Handler).

      Parameters:
      handler - the handler
      Returns:
      the current StompClient

    • writingFrameHandler

      public StompClient writingFrameHandler(Handler<Frame> handler)
      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 StompClientConnection.writingFrameHandler(Handler).

      Parameters:
      handler - the handler
      Returns:
      the current StompClient

    • errorFrameHandler

      public StompClient errorFrameHandler(Handler<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 StompClientConnection created from this client. Obviously, the client can override it when the connection is established.
      Parameters:
      handler - the handler
      Returns:
      the current StompClient

    • exceptionHandler

      public StompClient exceptionHandler(Handler<Throwable> handler)
      Sets an exception handler notified for TCP-level errors.
      Parameters:
      handler - the handler
      Returns:
      the current StompClient

    • close

      public Future<Void> close()
      Closes the client.
      Returns:

    • rxClose

      public Completable rxClose()
      Closes the client.
      Returns:

    • options

      public StompClientOptions options()
      Returns:
      the client's options.

    • vertx

      public Vertx vertx()
      Returns:
      the vert.x instance used by the client.

    • isClosed

      public boolean isClosed()
      Returns:
      whether or not the client is connected to the server.

    • newInstance

      public static StompClient newInstance(StompClient arg)