Package io.vertx.reactivex.mqtt
Class MqttServer
- java.lang.Object
-
- io.vertx.reactivex.mqtt.MqttServer
-
public class MqttServer extends Object
An MQTT serverYou can accept incoming MQTT connection requests providing a
NOTE: This class has been automatically generated from theendpointHandler(io.vertx.core.Handler<io.vertx.reactivex.mqtt.MqttEndpoint>)
. As the requests arrive, the handler will be called with an instance ofMqttEndpoint
in order to manage the communication with the remote MQTT client.original
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<MqttServer>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description MqttServer(MqttServer delegate)
MqttServer(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
actualPort()
The actual port the server is listening on.void
close()
Close the server supplying an handler that will be called when the server is actually closed (or has failed).void
close(Handler<AsyncResult<Void>> completionHandler)
Close the server supplying an handler that will be called when the server is actually closed (or has failed).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.boolean
equals(Object o)
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 connectionMqttServer
getDelegate()
int
hashCode()
MqttServer
listen()
Start the server listening for incoming connections using the specified options through the constructorMqttServer
listen(int port)
Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host.MqttServer
listen(int port, Handler<AsyncResult<MqttServer>> listenHandler)
Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host.MqttServer
listen(int port, String host)
Start the server listening for incoming connections on the port and host specified It ignores any options specified through the constructorMqttServer
listen(int port, String host, Handler<AsyncResult<MqttServer>> listenHandler)
Start the server listening for incoming connections on the port and host specified It ignores any options specified through the constructorMqttServer
listen(Handler<AsyncResult<MqttServer>> listenHandler)
Start the server listening for incoming connections using the specified options through the constructorstatic MqttServer
newInstance(MqttServer arg)
io.reactivex.Completable
rxClose()
Close the server supplying an handler that will be called when the server is actually closed (or has failed).io.reactivex.Single<MqttServer>
rxListen()
Start the server listening for incoming connections using the specified options through the constructorio.reactivex.Single<MqttServer>
rxListen(int port)
Start the server listening for incoming connections on the port specified but on "0.0.0.0" as host.io.reactivex.Single<MqttServer>
rxListen(int port, String host)
Start the server listening for incoming connections on the port and host specified It ignores any options specified through the constructorString
toString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<MqttServer> __TYPE_ARG
-
-
Constructor Detail
-
MqttServer
public MqttServer(MqttServer delegate)
-
MqttServer
public MqttServer(Object delegate)
-
-
Method Detail
-
getDelegate
public MqttServer getDelegate()
-
create
public 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
public static MqttServer create(Vertx vertx)
Return an MQTT server instance using default options- Parameters:
vertx
- Vert.x instance- Returns:
- MQTT server instance
-
listen
public MqttServer listen(int port, String host, Handler<AsyncResult<MqttServer>> listenHandler)
Start the server listening for incoming connections on the port and host specified It ignores any options specified through the constructor- Parameters:
port
- the port to listen onhost
- the host to listen onlistenHandler
- handler called when the asynchronous listen call ends- Returns:
- a reference to this, so the API can be used fluently
-
listen
public MqttServer listen(int port, String host)
Start the server listening for incoming connections on the port and host specified It ignores any options specified through the constructor- Parameters:
port
- the port to listen onhost
- the host to listen on- Returns:
- a reference to this, so the API can be used fluently
-
rxListen
public io.reactivex.Single<MqttServer> rxListen(int port, String host)
Start the server listening for incoming connections on the port and host specified It ignores any options specified through the constructor- Parameters:
port
- the port to listen onhost
- the host to listen on- Returns:
- a reference to this, so the API can be used fluently
-
listen
public MqttServer listen(int port, Handler<AsyncResult<MqttServer>> listenHandler)
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 onlistenHandler
- handler called when the asynchronous listen call ends- Returns:
- a reference to this, so the API can be used fluently
-
listen
public 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 reference to this, so the API can be used fluently
-
rxListen
public io.reactivex.Single<MqttServer> rxListen(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 reference to this, so the API can be used fluently
-
listen
public MqttServer listen(Handler<AsyncResult<MqttServer>> listenHandler)
Start the server listening for incoming connections using the specified options through the constructor- Parameters:
listenHandler
- handler called when the asynchronous listen call ends- Returns:
- a reference to this, so the API can be used fluently
-
listen
public MqttServer listen()
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
-
rxListen
public io.reactivex.Single<MqttServer> rxListen()
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
-
endpointHandler
public 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
public 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
public 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.
-
close
public void close(Handler<AsyncResult<Void>> completionHandler)
Close the server supplying an handler that will be called when the server is actually closed (or has failed).- Parameters:
completionHandler
- the handler called on completion
-
close
public void close()
Close the server supplying an handler that will be called when the server is actually closed (or has failed).
-
rxClose
public io.reactivex.Completable rxClose()
Close the server supplying an handler that will be called when the server is actually closed (or has failed).- Returns:
-
newInstance
public static MqttServer newInstance(MqttServer arg)
-
-