vertx-lang-scala-docs_2.12 3.8.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package stomp
  Definition Classes
    ext
- Acknowledgement
- BridgeOptions
- Destination
- DestinationFactory
- Frame
- Frames
- ServerFrame
- StompClient
- StompClientConnection
- StompClientOptions
- StompServer
- StompServerConnection
- StompServerHandler
- StompServerOptions

c

io.vertx.scala.ext.stomp

# StompServer 

###
Companion object StompServer

#### class StompServer extends AnyRef

Defines a STOMP server. STOMP servers delegates to a io.vertx.scala.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.

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. StompServer
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new StompServer(_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.  def actualPort(): Int

   Gets the port on which the server is listening.

   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. * @return the port

5.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
6.  def asJava: AnyRef
7.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
8.  def close(): Unit

   Closes the server.

9.  def close(completionHandler: Handler[AsyncResult[Unit]]): Unit

   Closes the server.

   Closes the server. * @param completionHandler handler called once the server has been stopped

10.  def closeFuture(): Future[Unit]

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

11.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
12.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
13.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
14.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
15.  def handler(handler: StompServerHandler): StompServer

    Configures the io.vertx.scala.ext.stomp.StompServerHandler.

    Configures the io.vertx.scala.ext.stomp.StompServerHandler. You must calls this method before calling the io.vertx.scala.ext.stomp.StompServer#listen method. * @param handler the handler

    returns

      the current StompServer

16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  def isListening(): Boolean

    Checks whether or not the server is listening.

    Checks whether or not the server is listening. * @return `true` if the server is listening, `false` otherwise

19.  def listen(port: Int, host: String, handler: Handler[AsyncResult[StompServer]]): StompServer

    Connects the STOMP server to the given port / interface.

    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. * @param port the port

    host

      the host / interface

    handler

      the handler to call with the result

    returns

      the current StompServer

20.  def listen(port: Int, handler: Handler[AsyncResult[StompServer]]): StompServer

    Connects the STOMP server to the given port.

    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. * @param port the port

    handler

      the handler to call with the result

    returns

      the current StompServer

21.  def listen(handler: Handler[AsyncResult[StompServer]]): StompServer

    Connects the STOMP server default port (61613) and network interface (`0.0.0.0`).

    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. * @param handler the handler to call with the result

    returns

      the current StompServer

22.  def listen(): StompServer

    Connects the STOMP server to the port / host configured in the server options.

    Connects the STOMP server to the port / host configured in the server options. * @return the current StompServer

23.  def listen(port: Int, host: String): StompServer

    Connects the STOMP server to the given port / interface.

    Connects the STOMP server to the given port / interface. * @param port the port

    host

      the interface

    returns

      the current StompServer

24.  def listen(port: Int): StompServer

    Connects the STOMP server to the given port.

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

    returns

      the current StompServer

25.  def listenFuture(port: Int, host: String): Future[StompServer]

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

26.  def listenFuture(port: Int): Future[StompServer]

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

27.  def listenFuture(): Future[StompServer]

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

28.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
29.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
30.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
31.  def options(): StompServerOptions

    returns

      the server optionssee StompServerOptions

32.  def stompHandler(): StompServerHandler

    returns

      the StompServerHandler used by this server.

33.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
34.  def toString(): String
    Definition Classes
      AnyRef → Any
35.  def vertx(): Vertx

    returns

      the instance of vert.x used by the server.

36.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
37.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
38.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
39.  def webSocketHandler(): Handler[ServerWebSocket]

    Gets the able to manage web socket connections.

    Gets the able to manage web socket connections. If the web socket bridge is disabled, it returns `null`. * @return the handler that can be passed to io.vertx.scala.core.http.HttpServer#websocketHandler(Handler).

40.  def writingFrameHandler(handler: Handler[ServerFrame]): StompServer

    Configures the handler that is invoked every time a frame is going to be written to the "wire".

    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. * @param handler the handler, must not be `null`

    returns

      the current StompServer

### Inherited from AnyRef

### Inherited from Any

### Ungrouped