open class StompClientConnection
Once a connection to the STOMP server has been made, client receives a io.vertx.rxjava.ext.stomp.StompClientConnection, that let send and receive STOMP frames. NOTE: This class has been automatically generated from the io.vertx.ext.stomp.StompClientConnection non RX-ified interface using Vert.x codegen.
StompClientConnection(delegate: StompClientConnection) |
static val __TYPE_ARG: TypeArg<StompClientConnection> |
open fun abort(id: String): StompClientConnectionopen fun abort(id: String, receiptHandler: Handler<Frame>): StompClientConnectionopen fun abort(id: String, headers: MutableMap<String, String>): StompClientConnectionopen fun abort(id: String, headers: MutableMap<String, String>, receiptHandler: Handler<Frame>): StompClientConnection
Aborts a transaction. |
|
open fun ack(id: String): StompClientConnectionopen fun ack(id: String, receiptHandler: Handler<Frame>): StompClientConnection
Sends an acknowledgement for a specific message. It means that the message has been handled and processed by the client. The open fun ack(id: String, txId: String): StompClientConnectionopen fun ack(id: String, txId: String, receiptHandler: Handler<Frame>): StompClientConnection
Sends an acknowledgement for the given frame. It means that the frame has been handled and processed by the client. The sent acknowledgement is part of the transaction identified by the given id. |
|
open fun beginTX(id: String, receiptHandler: Handler<Frame>): StompClientConnectionopen fun beginTX(id: String): StompClientConnectionopen fun beginTX(id: String, headers: MutableMap<String, String>): StompClientConnectionopen fun beginTX(id: String, headers: MutableMap<String, String>, receiptHandler: Handler<Frame>): StompClientConnection
Begins a transaction. |
|
open fun close(): Unit
Closes the connection without sending the |
|
open fun closeHandler(handler: Handler<StompClientConnection>): StompClientConnection
Sets a handler notified when the STOMP connection is closed. |
|
open fun commit(id: String): StompClientConnectionopen fun commit(id: String, receiptHandler: Handler<Frame>): StompClientConnectionopen fun commit(id: String, headers: MutableMap<String, String>): StompClientConnectionopen fun commit(id: String, headers: MutableMap<String, String>, receiptHandler: Handler<Frame>): StompClientConnection
Commits a transaction. |
|
open fun connectionDroppedHandler(handler: Handler<StompClientConnection>): StompClientConnection
Sets a handler notified when the server does not respond to a |
|
open fun disconnect(): StompClientConnectionopen fun disconnect(receiptHandler: Handler<Frame>): StompClientConnection
Disconnects the client. Unlike the open fun disconnect(frame: Frame): StompClientConnectionopen fun disconnect(frame: Frame, receiptHandler: Handler<Frame>): StompClientConnection
Disconnects the client. Unlike the |
|
open fun equals(other: Any?): Boolean |
|
open fun errorHandler(handler: Handler<Frame>): StompClientConnection
Sets a handler notified when an |
|
open fun exceptionHandler(exceptionHandler: Handler<Throwable>): StompClientConnection
Configures the exception handler notified upon TCP-level errors. |
|
open fun getDelegate(): StompClientConnection |
|
open fun hashCode(): Int |
|
open fun isConnected(): Boolean
Returns whether or not the `CONNECTED` frame has been receive meaning that the Stomp connection is established. |
|
open fun nack(id: String): StompClientConnectionopen fun nack(id: String, receiptHandler: Handler<Frame>): StompClientConnection
Sends a non-acknowledgement for the given message. It means that the message has not been handled by the client. The open fun nack(id: String, txId: String): StompClientConnectionopen fun nack(id: String, txId: String, receiptHandler: Handler<Frame>): StompClientConnection
Sends a non-acknowledgement for the given frame. It means that the frame has not been handled by the client. The sent non-acknowledgement is part of the transaction identified by the given id. |
|
open static fun newInstance(arg: StompClientConnection): StompClientConnection |
|
open fun pingHandler(handler: Handler<StompClientConnection>): StompClientConnection
Sets a handler that let customize the behavior when a ping needs to be sent to the server. Be aware that changing the default behavior may break the compliance with the STOMP specification. |
|
open fun receivedFrameHandler(handler: Handler<Frame>): StompClientConnection
Configures a received handler that get 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 by the handler. Unlike |
|
open fun send(headers: MutableMap<String, String>, body: Buffer): StompClientConnectionopen fun send(headers: MutableMap<String, String>, body: Buffer, receiptHandler: Handler<Frame>): StompClientConnection
Sends a open fun send(destination: String, body: Buffer): StompClientConnectionopen fun send(destination: String, body: Buffer, receiptHandler: Handler<Frame>): StompClientConnection
Sends a open fun send(frame: Frame): StompClientConnectionopen fun send(frame: Frame, receiptHandler: Handler<Frame>): StompClientConnection
Sends the given frame to the server. open fun send(destination: String, headers: MutableMap<String, String>, body: Buffer): StompClientConnectionopen fun send(destination: String, headers: MutableMap<String, String>, body: Buffer, receiptHandler: Handler<Frame>): StompClientConnection
Sends a |
|
open fun server(): String |
|
open fun session(): String |
|
open fun subscribe(destination: String, handler: Handler<Frame>): Stringopen fun subscribe(destination: String, handler: Handler<Frame>, receiptHandler: Handler<Frame>): String
Subscribes to the given destination. This destination is used as subscription id. open fun subscribe(destination: String, headers: MutableMap<String, String>, handler: Handler<Frame>): Stringopen fun subscribe(destination: String, headers: MutableMap<String, String>, handler: Handler<Frame>, receiptHandler: Handler<Frame>): String
Subscribes to the given destination. |
|
open fun toString(): String |
|
open fun unsubscribe(destination: String): StompClientConnectionopen fun unsubscribe(destination: String, receiptHandler: Handler<Frame>): StompClientConnection
Un-subscribes from the given destination. This method only works if the subscription did not specifies a subscription id (using the open fun unsubscribe(destination: String, headers: MutableMap<String, String>): StompClientConnectionopen fun unsubscribe(destination: String, headers: MutableMap<String, String>, receiptHandler: Handler<Frame>): StompClientConnection
Un-subscribes from the given destination. This method computes the subscription id as follows. If the given headers contains the |
|
open fun version(): String |
|
open fun writingFrameHandler(handler: Handler<Frame>): StompClientConnection
Configures a handler notified when a frame is going to be written on the wire. This handler can be used from logging, debugging. The handler can modify the received frame. If a writing frame handler is set on the io.vertx.rxjava.ext.stomp.StompClient, it will be used by all clients connection, so calling this method is useless, except if you want to use a different handler. |