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

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package mqtt
  Definition Classes
    scala
-  package messages
  Definition Classes
    mqtt
- MqttAuth
- MqttEndpoint
- MqttServer
- MqttServerOptions
- MqttTopicSubscription
- MqttWill

c

io.vertx.scala.mqtt

# MqttServer 

###
Companion object MqttServer

#### class MqttServer extends AnyRef

An MQTT server

You can accept incoming MQTT connection requests providing a io.vertx.scala.mqtt.MqttServer#endpointHandler. As the requests arrive, the handler will be called with an instance of io.vertx.scala.mqtt.MqttEndpoint in order to manage the communication with the remote MQTT client.

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. MqttServer
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new MqttServer(_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

   The actual port the server is listening on.

   The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number signifying an ephemeral port

   returns

     the actual port the server is listening on.

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
     @throws( ... )
8.  def close(completionHandler: Handler[AsyncResult[Unit]]): Unit

   Close the server supplying an handler that will be called when the server is actually closed (or has failed).

   Close the server supplying an handler that will be called when the server is actually closed (or has failed).

   completionHandler

     the handler called on completion

9.  def close(): Unit

   Close the server.

   Close the server.

   The close happens asynchronously and the server may not be closed until some time after the call has returned.

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

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

11.  def endpointHandler(handler: Handler[MqttEndpoint]): MqttServer

    Set the endpoint handler for the server.

    Set the endpoint handler for the server. If an MQTT client connect to the server a new MqttEndpoint instance will be created and passed to the handler

    handler

      the endpoint handler

    returns

      a reference to this, so the API can be used fluently

12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
14.  def exceptionHandler(handler: Handler[Throwable]): MqttServer

    Set an exception handler for the server, that will be called when an error happens independantly of an accepted io.vertx.scala.mqtt.MqttEndpoint, like a rejected connection

    Set an exception handler for the server, that will be called when an error happens independantly of an accepted io.vertx.scala.mqtt.MqttEndpoint, like a rejected connection

    handler

      the exception handler

    returns

      a reference to this, so the API can be used fluently

15.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
16.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
17.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
18.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
19.  def listen(listenHandler: Handler[AsyncResult[MqttServer]]): MqttServer

    Start the server listening for incoming connections using the specified options through the constructor

    Start the server listening for incoming connections using the specified options through the constructor

    listenHandler

      handler called when the asynchronous listen call ends

    returns

      a reference to this, so the API can be used fluently

20.  def listen(port: Int, listenHandler: Handler[AsyncResult[MqttServer]]): MqttServer

    Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host.

    Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host. It ignores any options specified through the constructor

    port

      the port to listen on

    listenHandler

      handler called when the asynchronous listen call ends

    returns

      a reference to this, so the API can be used fluently

21.  def listen(port: Int): MqttServer

    Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host.

    Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host. It ignores any options specified through the constructor

    port

      the port to listen on

    returns

      a reference to this, so the API can be used fluently

22.  def listen(port: Int, host: String, listenHandler: Handler[AsyncResult[MqttServer]]): MqttServer

    Start the server listening for incoming connections on the port and host specified It ignores any options specified through the constructor

    Start the server listening for incoming connections on the port and host specified It ignores any options specified through the constructor

    port

      the port to listen on

    host

      the host to listen on

    listenHandler

      handler called when the asynchronous listen call ends

    returns

      a reference to this, so the API can be used fluently

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

    Start the server listening for incoming connections on the port and host specified

    Start the server listening for incoming connections on the port and host specified

    port

      the port to listen on

    host

      the host to listen on

    returns

      a reference to this, so the API can be used fluently

24.  def listen(): MqttServer

    Start the server listening for incoming connections using the specified options through the constructor

    Start the server listening for incoming connections using the specified options through the constructor

    returns

      a reference to this, so the API can be used fluently

25.  def listenFuture(): Future[MqttServer]

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

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

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

27.  def listenFuture(port: Int, host: String): Future[MqttServer]

    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
30.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
31.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
32.  def toString(): String
    Definition Classes
      AnyRef → Any
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
      @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped