Package io.vertx.mqtt
Interface MqttServer
-
public interface MqttServer
An MQTT serverYou can accept incoming MQTT connection requests providing a
endpointHandler(Handler)
. As the requests arrive, the handler will be called with an instance ofMqttEndpoint
in order to manage the communication with the remote MQTT client.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description int
actualPort()
The actual port the server is listening on.Future<Void>
close()
Close the server.static MqttServer
create(Vertx vertx)
Return an MQTT server instance using default optionsstatic MqttServer
create(Vertx vertx, MqttServerOptions options)
Return an MQTT server instanceMqttServer
endpointHandler(Handler<MqttEndpoint> handler)
Set the endpoint handler for the server.MqttServer
exceptionHandler(Handler<Throwable> handler)
Set an exception handler for the server, that will be called when an error happens independantly of an acceptedMqttEndpoint
, like a rejected connectionFuture<MqttServer>
listen()
Start the server listening for incoming connections using the specified options through the constructorFuture<MqttServer>
listen(int port)
Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host.Future<MqttServer>
listen(int port, String host)
Start the server listening for incoming connections on the port and host specified
-
-
-
Method Detail
-
create
static MqttServer create(Vertx vertx, MqttServerOptions options)
Return an MQTT server instance- Parameters:
vertx
- Vert.x instanceoptions
- MQTT server options- Returns:
- MQTT server instance
-
create
static MqttServer create(Vertx vertx)
Return an MQTT server instance using default options- Parameters:
vertx
- Vert.x instance- Returns:
- MQTT server instance
-
listen
Future<MqttServer> listen()
Start the server listening for incoming connections using the specified options through the constructor- Returns:
- a
Future
completed with this server instance
-
listen
Future<MqttServer> listen(int port, String host)
Start the server listening for incoming connections on the port and host specified- Parameters:
port
- the port to listen onhost
- the host to listen on- Returns:
- a
Future
completed with this server instance
-
listen
Future<MqttServer> listen(int port)
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- Parameters:
port
- the port to listen on- Returns:
- a
Future
completed with this server instance
-
endpointHandler
MqttServer endpointHandler(Handler<MqttEndpoint> handler)
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- Parameters:
handler
- the endpoint handler- Returns:
- a reference to this, so the API can be used fluently
-
exceptionHandler
MqttServer exceptionHandler(Handler<Throwable> handler)
Set an exception handler for the server, that will be called when an error happens independantly of an acceptedMqttEndpoint
, like a rejected connection- Parameters:
handler
- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
actualPort
int actualPort()
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.
-
-