io.vertx.mqtt.MqttEndpoint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-mqtt Show documentation
Show all versions of vertx-mqtt Show documentation
Vert.x MQTT reactive client and server
The newest version!
/*
* Copyright 2016 Red Hat Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.vertx.mqtt;
import io.netty.handler.codec.mqtt.MqttConnectReturnCode;
import io.netty.handler.codec.mqtt.MqttProperties;
import io.netty.handler.codec.mqtt.MqttQoS;
import io.vertx.codegen.annotations.CacheReturn;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.MultiMap;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.net.SocketAddress;
import io.vertx.mqtt.messages.MqttDisconnectMessage;
import io.vertx.mqtt.messages.MqttPubAckMessage;
import io.vertx.mqtt.messages.MqttPubCompMessage;
import io.vertx.mqtt.messages.MqttPubRecMessage;
import io.vertx.mqtt.messages.MqttPubRelMessage;
import io.vertx.mqtt.messages.MqttPublishMessage;
import io.vertx.mqtt.messages.MqttSubscribeMessage;
import io.vertx.mqtt.messages.MqttUnsubscribeMessage;
import io.vertx.mqtt.messages.MqttAuthenticationExchangeMessage;
import io.vertx.mqtt.messages.codes.MqttDisconnectReasonCode;
import io.vertx.mqtt.messages.codes.MqttPubAckReasonCode;
import io.vertx.mqtt.messages.codes.MqttPubCompReasonCode;
import io.vertx.mqtt.messages.codes.MqttPubRecReasonCode;
import io.vertx.mqtt.messages.codes.MqttPubRelReasonCode;
import io.vertx.mqtt.messages.codes.MqttSubAckReasonCode;
import io.vertx.mqtt.messages.codes.MqttUnsubAckReasonCode;
import javax.net.ssl.SSLSession;
import java.util.List;
/**
* Represents an MQTT endpoint for point-to-point communication with the remote MQTT client
*/
@VertxGen
public interface MqttEndpoint {
/**
* Close the endpoint, so the connection with remote MQTT client
*/
void close();
/**
* @return the remote address for this socket
*/
@CacheReturn
SocketAddress remoteAddress();
/**
* @return the local address for this socket
*/
@CacheReturn
SocketAddress localAddress();
/**
* @return true if this {@link io.vertx.mqtt.MqttEndpoint} is encrypted via SSL/TLS.
*/
boolean isSsl();
/**
* Returns the HTTP headers sent by the client when a WebSocket transport is used otherwise {@code null}
*
* @return the HTTP headers
*/
MultiMap httpHeaders();
/**
* Returns the HTTP request URI sent by the client when a WebSocket transport is used otherwise {@code null}
*
* @return the HTTP request uri
*/
String httpRequestURI();
/**
* @return SSLSession associated with the underlying socket. Returns null if connection is
* not SSL.
* @see javax.net.ssl.SSLSession
*/
@GenIgnore
SSLSession sslSession();
/**
* @return the client identifier as provided by the remote MQTT client
*/
@CacheReturn
String clientIdentifier();
/**
* @return the Authentication information as provided by the remote MQTT client
*/
@CacheReturn
MqttAuth auth();
/**
* @return the Will information as provided by the remote MQTT client
*/
@CacheReturn
MqttWill will();
/**
* @return the protocol version required by the remote MQTT client
*/
@CacheReturn
int protocolVersion();
/**
* @return the protocol name provided by the remote MQTT client
*/
@CacheReturn
String protocolName();
/**
* @return true when clean session is requested by the remote MQTT client
*/
@CacheReturn
boolean isCleanSession();
/**
* @return the keep alive timeout (in seconds) specified by the remote MQTT client
*/
@CacheReturn
int keepAliveTimeSeconds();
/**
* @return the message identifier used for last published message
*/
@CacheReturn
int lastMessageId();
/**
* Enable/disable subscription/unsubscription requests auto acknowledge
*
* @param isSubscriptionAutoAck auto acknowledge status
*/
void subscriptionAutoAck(boolean isSubscriptionAutoAck);
/**
* @return true when auto acknowledge status for subscription/unsubscription requests
*/
boolean isSubscriptionAutoAck();
/**
* Enable/disable publishing (in/out) auto acknowledge
*
* @param isPublishAutoAck auto acknowledge status
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishAutoAck(boolean isPublishAutoAck);
/**
* @return auto acknowledge status for publishing (in/out)
*/
boolean isPublishAutoAck();
/**
* Enable/disable auto keep alive (sending ping response)
*
* @param isAutoKeepAlive auto keep alive
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint autoKeepAlive(boolean isAutoKeepAlive);
/**
* @return the auto keep alive status (sending ping response)
*/
boolean isAutoKeepAlive();
/**
* @return if the connection between remote client and local endpoint is established/open
*/
boolean isConnected();
/**
* @return MQTT properties of the CONNECT message
*/
@GenIgnore(GenIgnore.PERMITTED_TYPE)
MqttProperties connectProperties();
/**
* Set client identifier if not provided by the remote MQTT client (zero-bytes)
*
* @param clientIdentifier the client identifier
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint setClientIdentifier(String clientIdentifier);
/**
* Set a disconnect handler on the MQTT endpoint. This handler is called when a DISCONNECT
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint disconnectHandler(Handler handler);
/**
* Set a disconnect handler on the MQTT endpoint. This handler is called when a DISCONNECT
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint disconnectMessageHandler(Handler handler);
/**
* Set a subscribe handler on the MQTT endpoint. This handler is called when a SUBSCRIBE
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint subscribeHandler(Handler handler);
/**
* Set a unsubscribe handler on the MQTT endpoint. This handler is called when a UNSUBSCRIBE
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint unsubscribeHandler(Handler handler);
/**
* Set the publish handler on the MQTT endpoint. This handler is called when a PUBLISH
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishHandler(Handler handler);
/**
* Set the puback handler on the MQTT endpoint. This handler is called when a PUBACK
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishAcknowledgeHandler(Handler handler);
/**
* Set the puback handler on the MQTT endpoint. This handler is called when a PUBACK
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishAcknowledgeMessageHandler(Handler handler);
/**
* Set the pubrec handler on the MQTT endpoint. This handler is called when a PUBREC
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishReceivedHandler(Handler handler);
/**
* Set the pubrec handler on the MQTT endpoint. This handler is called when a PUBREC
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishReceivedMessageHandler(Handler handler);
/**
* Set the pubrel handler on the MQTT endpoint. This handler is called when a PUBREL
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishReleaseHandler(Handler handler);
/**
* Set the pubrel handler on the MQTT endpoint. This handler is called when a PUBREL
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishReleaseMessageHandler(Handler handler);
/**
* Set the pubcomp handler on the MQTT endpoint. This handler is called when a PUBCOMP
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishCompletionHandler(Handler handler);
/**
* Set the pubcomp handler on the MQTT endpoint. This handler is called when a PUBCOMP
* message is received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishCompletionMessageHandler(Handler handler);
/**
* Set the auth handler on the MQTT endpoint. This handler is called when a AUTH message is
* received by the remote MQTT client
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint authenticationExchangeHandler(Handler handler);
/**
* Set the pingreq handler on the MQTT endpoint. This handler is called when a PINGREQ
* message is received by the remote MQTT client. In any case the endpoint sends the
* PINGRESP internally after executing this handler.
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint pingHandler(Handler handler);
/**
* Set a close handler. This will be called when the MQTT endpoint is closed
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint closeHandler(Handler handler);
/**
* Set an exception handler. This will be called when an error at protocol level happens
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint exceptionHandler(Handler handler);
/**
* Like {@link #accept(boolean)} with no session is present.
*/
@Fluent
MqttEndpoint accept();
/**
* Sends the CONNACK message to the remote MQTT client with "connection accepted"
* return code. See {@link #reject(MqttConnectReturnCode)} for refusing connection
*
* @param sessionPresent if a previous session is present
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint accept(boolean sessionPresent);
/**
* Sends the CONNACK message to the remote MQTT client with "connection accepted"
* return code. See {@link #reject(MqttConnectReturnCode)} for refusing connection
*
* @param sessionPresent if a previous session is present
* @param properties CONNACK message properties (MQTT5)
* @return a reference to this, so the API can be used fluently
*/
@GenIgnore(GenIgnore.PERMITTED_TYPE)
@Fluent
MqttEndpoint accept(boolean sessionPresent, MqttProperties properties);
/**
* Sends the CONNACK message to the remote MQTT client rejecting the connection
* request with specified return code. See {@link #accept(boolean)} for accepting connection
*
* @param returnCode the connect return code
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint reject(MqttConnectReturnCode returnCode);
/**
* Sends the CONNACK message to the remote MQTT client rejecting the connection
* request with specified return code. See {@link #accept(boolean)} for accepting connection
*
* @param returnCode the connect return code
* @param properties CONNACK message properties
* @return a reference to this, so the API can be used fluently
*/
@Fluent
@GenIgnore(GenIgnore.PERMITTED_TYPE)
MqttEndpoint reject(MqttConnectReturnCode returnCode, MqttProperties properties);
/**
* Sends the SUBACK message to the remote MQTT client
*
* @param subscribeMessageId identifier of the SUBSCRIBE message to acknowledge
* @param grantedQoSLevels granted QoS levels for the requested topics
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint subscribeAcknowledge(int subscribeMessageId, List grantedQoSLevels);
/**
* Sends the SUBACK message to the remote MQTT client
*
* @param subscribeMessageId identifier of the SUBSCRIBE message to acknowledge
* @param reasonCodes reason codes
* @param properties MQTT message properties
* @return a reference to this, so the API can be used fluently
*/
@Fluent
@GenIgnore(GenIgnore.PERMITTED_TYPE)
MqttEndpoint subscribeAcknowledge(int subscribeMessageId, List reasonCodes, MqttProperties properties);
/**
* Sends the UNSUBACK message to the remote MQTT client
*
* @param unsubscribeMessageId identifier of the UNSUBSCRIBE message to acknowledge
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint unsubscribeAcknowledge(int unsubscribeMessageId);
/**
* Sends the UNSUBACK message to the remote MQTT client
*
* @param unsubscribeMessageId identifier of the UNSUBSCRIBE message to acknowledge
* @param reasonCodes reason codes
* @param properties MQTT message properties
* @return a reference to this, so the API can be used fluently
*/
@Fluent
@GenIgnore(GenIgnore.PERMITTED_TYPE)
MqttEndpoint unsubscribeAcknowledge(int unsubscribeMessageId, List reasonCodes, MqttProperties properties);
/**
* Sends the PUBACK message to the remote MQTT client
*
* @param publishMessageId identifier of the PUBLISH message to acknowledge
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishAcknowledge(int publishMessageId);
@Fluent
@GenIgnore(GenIgnore.PERMITTED_TYPE)
MqttEndpoint publishAcknowledge(int publishMessageId, MqttPubAckReasonCode reasonCode, MqttProperties properties);
/**
* Sends the PUBREC message to the remote MQTT client
*
* @param publishMessageId identifier of the PUBLISH message to acknowledge
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishReceived(int publishMessageId);
/**
* Sends the PUBREC message to the remote MQTT client
*
* @param publishMessageId identifier of the PUBLISH message to acknowledge
* @param reasonCode code of the outcome
* @param properties MQTT properties
* @return a reference to this, so the API can be used fluently
*/
@GenIgnore(GenIgnore.PERMITTED_TYPE)
@Fluent
MqttEndpoint publishReceived(int publishMessageId, MqttPubRecReasonCode reasonCode, MqttProperties properties);
/**
* Sends the PUBREL message to the remote MQTT client
*
* @param publishMessageId identifier of the PUBLISH message to acknowledge
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishRelease(int publishMessageId);
/**
* Sends the PUBREL message to the remote MQTT client
*
* @param publishMessageId identifier of the PUBLISH message to acknowledge
* @param reasonCode reason code
* @param properties MQTT message properties
* @return a reference to this, so the API can be used fluently
*/
@Fluent
@GenIgnore(GenIgnore.PERMITTED_TYPE)
MqttEndpoint publishRelease(int publishMessageId, MqttPubRelReasonCode reasonCode, MqttProperties properties);
/**
* Sends the PUBCOMP message to the remote MQTT client
*
* @param publishMessageId identifier of the PUBLISH message to acknowledge
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint publishComplete(int publishMessageId);
/**
* Sends the PUBCOMP message to the remote MQTT client
*
* @param publishMessageId identifier of the PUBLISH message to acknowledge
* @param reasonCode reason code
* @param properties MQTT message properties
* @return a reference to this, so the API can be used fluently
*/
@Fluent
@GenIgnore(GenIgnore.PERMITTED_TYPE)
MqttEndpoint publishComplete(int publishMessageId, MqttPubCompReasonCode reasonCode, MqttProperties properties);
/**
* Sends the PUBLISH message to the remote MQTT client
*
* @param topic topic on which the message is published
* @param payload message payload
* @param qosLevel quality of service level
* @param isDup if the message is a duplicate
* @param isRetain if the message needs to be retained
* @return a {@code Future} completed after PUBLISH packet sent with a packetId
*/
Future publish(String topic, Buffer payload, MqttQoS qosLevel, boolean isDup, boolean isRetain);
/**
* Sends the PUBLISH message to the remote MQTT server explicitly specifying the messageId
*
* @param topic topic on which the message is published
* @param payload message payload
* @param qosLevel QoS level
* @param isDup if the message is a duplicate
* @param isRetain if the message needs to be retained
* @param messageId message ID
* @return a future notified after PUBLISH packet sent with a packetId
*/
Future publish(String topic, Buffer payload, MqttQoS qosLevel, boolean isDup, boolean isRetain, int messageId);
/**
* Sends the PUBLISH message to the remote MQTT server explicitly specifying the messageId
*
* @param topic topic on which the message is published
* @param payload message payload
* @param qosLevel QoS level
* @param isDup if the message is a duplicate
* @param isRetain if the message needs to be retained
* @param messageId message ID
* @param properties PUBLISH message properties
* @return a future notified after PUBLISH packet sent with a packetId
*/
@GenIgnore(GenIgnore.PERMITTED_TYPE)
Future publish(String topic, Buffer payload, MqttQoS qosLevel, boolean isDup, boolean isRetain, int messageId, MqttProperties properties);
/**
* Sends the AUTH message to the remote MQTT client
*
* @param message
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint authenticationExchange(MqttAuthenticationExchangeMessage message);
/**
* Sends the PINGRESP message to the remote MQTT client
*
* @return a reference to this, so the API can be used fluently
*/
@Fluent
MqttEndpoint pong();
/**
* Sends the DISCONNECT message to the remote MQTT client
*
* @param code reason code
* @param properties MQTT message properties
* @return a reference to this, so the API can be used fluently
*/
@GenIgnore(GenIgnore.PERMITTED_TYPE)
@Fluent
MqttEndpoint disconnect(MqttDisconnectReasonCode code, MqttProperties properties);
}