vertx / io.vertx.rxjava.ext.stomp / StompServer

# StompServer

`open class StompServer`

Defines a STOMP server. STOMP servers delegates to a io.vertx.rxjava.ext.stomp.StompServerHandler that let customize the behavior of the server. By default, it uses a handler compliant with the STOMP specification, but let you change anything. NOTE: This class has been automatically generated from the io.vertx.ext.stomp.StompServer non RX-ified interface using Vert.x codegen.

### Constructors

<init> | `StompServer(delegate: StompServer)`

### Properties

__TYPE_ARG | `static val __TYPE_ARG: TypeArg<StompServer>`

### Functions

actualPort | `open fun actualPort(): Int` Gets the port on which the server is listening. This is useful if you bound the server specifying 0 as port number signifying an ephemeral port.
close | `open fun close(completionHandler: Handler<AsyncResult<Void>>): Unit` `open fun close(): Unit` Closes the server.
create | `open static fun create(vertx: Vertx, options: StompServerOptions): StompServer` `open static fun create(vertx: Vertx, netServer: NetServer): StompServer` `open static fun create(vertx: Vertx, net: NetServer, options: StompServerOptions): StompServer` Creates a io.vertx.rxjava.ext.stomp.StompServer based on the default Stomp Server implementation. `open static fun create(vertx: Vertx): StompServer` Creates a io.vertx.rxjava.ext.stomp.StompServer based on the default Stomp Server implementation, and use the default options.
equals | `open fun equals(other: Any?): Boolean`
getDelegate | `open fun getDelegate(): StompServer`
handler | `open fun handler(handler: StompServerHandler): StompServer` Configures the io.vertx.rxjava.ext.stomp.StompServerHandler. You must calls this method before calling the `io.vertx.rxjava.ext.stomp.StompServer#listen` method.
hashCode | `open fun hashCode(): Int`
isListening | `open fun isListening(): Boolean` Checks whether or not the server is listening.
listen | `open fun listen(port: Int): StompServer` Connects the STOMP server to the given port. `open fun listen(port: Int, host: String): StompServer` Connects the STOMP server to the given port / interface. `open fun listen(): StompServer` Connects the STOMP server to the port / host configured in the server options. `open fun listen(handler: Handler<AsyncResult<StompServer>>): StompServer` Connects the STOMP server default port (61613) and network interface (`0.0.0.0`). Once the socket it bounds calls the given handler with the result. The result may be a failure if the socket is already used. `open fun listen(port: Int, handler: Handler<AsyncResult<StompServer>>): StompServer` Connects the STOMP server to the given port. This method use the default host (`0.0.0.0`). Once the socket it bounds calls the given handler with the result. The result may be a failure if the socket is already used. `open fun listen(port: Int, host: String, handler: Handler<AsyncResult<StompServer>>): StompServer` Connects the STOMP server to the given port / interface. Once the socket it bounds calls the given handler with the result. The result may be a failure if the socket is already used.
newInstance | `open static fun newInstance(arg: StompServer): StompServer`
options | `open fun options(): StompServerOptions`
rxClose | `open fun rxClose(): Single<Void>` Closes the server.
rxListen | `open fun rxListen(): Single<StompServer>` Connects the STOMP server default port (61613) and network interface (`0.0.0.0`). Once the socket it bounds calls the given handler with the result. The result may be a failure if the socket is already used. `open fun rxListen(port: Int): Single<StompServer>` Connects the STOMP server to the given port. This method use the default host (`0.0.0.0`). Once the socket it bounds calls the given handler with the result. The result may be a failure if the socket is already used. `open fun rxListen(port: Int, host: String): Single<StompServer>` Connects the STOMP server to the given port / interface. Once the socket it bounds calls the given handler with the result. The result may be a failure if the socket is already used.
stompHandler | `open fun stompHandler(): StompServerHandler`
toString | `open fun toString(): String`
vertx | `open fun vertx(): Vertx`
webSocketHandler | `open fun webSocketHandler(): Handler<ServerWebSocket>` Gets the able to manage web socket connections. If the web socket bridge is disabled, it returns `null`.
writingFrameHandler | `open fun writingFrameHandler(handler: Handler<ServerFrame>): StompServer` Configures the handler that is invoked every time a frame is going to be written to the "wire". It lets you log the frames, but also adapt the frame if needed.