From fe98ec5156697c3de39322d1a89b1e8f7eb362c2 Mon Sep 17 00:00:00 2001 From: Silvio Giebl Date: Fri, 17 Apr 2020 18:22:02 +0200 Subject: [PATCH 1/3] Improved javadoc --- .../mqtt3/reactor/Mqtt3ReactorClient.java | 105 ++++++++------- .../mqtt5/reactor/Mqtt5ReactorClient.java | 124 +++++++++--------- .../com/hivemq/client/mqtt/MqttClient.java | 9 +- .../hivemq/client/mqtt/MqttClientBuilder.java | 2 +- .../client/mqtt/MqttClientBuilderBase.java | 2 +- .../hivemq/client/mqtt/MqttClientConfig.java | 2 +- .../mqtt/MqttClientConnectionConfig.java | 2 +- .../client/mqtt/MqttClientSslConfig.java | 4 +- .../mqtt/MqttClientSslConfigBuilderBase.java | 4 +- .../hivemq/client/mqtt/MqttClientState.java | 17 ++- .../client/mqtt/MqttGlobalPublishFilter.java | 20 +-- .../mqtt/datatypes/MqttClientIdentifier.java | 8 +- .../hivemq/client/mqtt/datatypes/MqttQos.java | 2 +- .../mqtt/datatypes/MqttSharedTopicFilter.java | 8 +- .../client/mqtt/datatypes/MqttTopic.java | 6 +- .../mqtt/datatypes/MqttTopicFilter.java | 6 +- .../client/mqtt/datatypes/MqttUtf8String.java | 25 ++-- .../exceptions/MqttClientStateException.java | 2 +- .../mqtt/exceptions/MqttDecodeException.java | 2 +- .../MqttClientDisconnectedContext.java | 28 ++-- .../MqttClientDisconnectedListener.java | 26 ++-- .../mqtt/lifecycle/MqttDisconnectSource.java | 8 +- .../client/mqtt/mqtt3/Mqtt3AsyncClient.java | 52 ++++---- .../mqtt/mqtt3/Mqtt3BlockingClient.java | 15 +-- .../hivemq/client/mqtt/mqtt3/Mqtt3Client.java | 2 +- .../client/mqtt/mqtt3/Mqtt3ClientBuilder.java | 2 +- .../client/mqtt/mqtt3/Mqtt3ClientConfig.java | 2 +- .../mqtt3/Mqtt3ClientConnectionConfig.java | 2 +- .../client/mqtt/mqtt3/Mqtt3RxClient.java | 105 ++++++++------- .../Mqtt3ClientConnectedContext.java | 2 +- .../Mqtt3ClientDisconnectedContext.java | 2 +- .../lifecycle/Mqtt3ClientReconnector.java | 2 +- .../mqtt3/message/auth/Mqtt3SimpleAuth.java | 2 +- .../mqtt3/message/connect/Mqtt3Connect.java | 2 +- .../message/connect/connack/Mqtt3ConnAck.java | 2 +- .../connack/Mqtt3ConnAckReturnCode.java | 2 +- .../message/disconnect/Mqtt3Disconnect.java | 2 +- .../mqtt/mqtt3/message/ping/Mqtt3PingReq.java | 2 +- .../mqtt3/message/ping/Mqtt3PingResp.java | 2 +- .../mqtt3/message/publish/Mqtt3Publish.java | 2 +- .../message/publish/Mqtt3PublishResult.java | 2 +- .../message/publish/puback/Mqtt3PubAck.java | 2 +- .../message/publish/pubcomp/Mqtt3PubComp.java | 2 +- .../message/publish/pubrec/Mqtt3PubRec.java | 2 +- .../message/publish/pubrel/Mqtt3PubRel.java | 2 +- .../message/subscribe/Mqtt3Subscribe.java | 2 +- .../message/subscribe/Mqtt3Subscription.java | 2 +- .../message/subscribe/suback/Mqtt3SubAck.java | 2 +- .../suback/Mqtt3SubAckReturnCode.java | 2 +- .../message/unsubscribe/Mqtt3Unsubscribe.java | 4 +- .../unsubscribe/unsuback/Mqtt3UnsubAck.java | 2 +- .../client/mqtt/mqtt5/Mqtt5AsyncClient.java | 78 +++++------ .../mqtt/mqtt5/Mqtt5BlockingClient.java | 15 +-- .../hivemq/client/mqtt/mqtt5/Mqtt5Client.java | 2 +- .../client/mqtt/mqtt5/Mqtt5ClientBuilder.java | 2 +- .../client/mqtt/mqtt5/Mqtt5ClientConfig.java | 2 +- .../mqtt5/Mqtt5ClientConnectionConfig.java | 2 +- .../client/mqtt/mqtt5/Mqtt5RxClient.java | 124 +++++++++--------- .../advanced/Mqtt5ClientAdvancedConfig.java | 2 +- .../interceptor/Mqtt5ClientInterceptors.java | 2 +- .../auth/Mqtt5EnhancedAuthMechanism.java | 26 ++-- .../Mqtt5ClientConnectedContext.java | 2 +- .../Mqtt5ClientDisconnectedContext.java | 2 +- .../lifecycle/Mqtt5ClientReconnector.java | 2 +- .../mqtt/mqtt5/message/auth/Mqtt5Auth.java | 2 +- .../message/auth/Mqtt5AuthReasonCode.java | 2 +- .../mqtt5/message/auth/Mqtt5SimpleAuth.java | 2 +- .../mqtt5/message/connect/Mqtt5Connect.java | 2 +- .../connect/Mqtt5ConnectRestrictions.java | 17 +-- .../message/connect/connack/Mqtt5ConnAck.java | 2 +- .../connack/Mqtt5ConnAckReasonCode.java | 2 +- .../connack/Mqtt5ConnAckRestrictions.java | 2 +- .../message/disconnect/Mqtt5Disconnect.java | 2 +- .../disconnect/Mqtt5DisconnectReasonCode.java | 2 +- .../mqtt/mqtt5/message/ping/Mqtt5PingReq.java | 2 +- .../mqtt5/message/ping/Mqtt5PingResp.java | 2 +- .../mqtt5/message/publish/Mqtt5Publish.java | 2 +- .../message/publish/Mqtt5PublishResult.java | 2 +- .../message/publish/Mqtt5WillPublish.java | 4 +- .../message/publish/puback/Mqtt5PubAck.java | 2 +- .../publish/puback/Mqtt5PubAckReasonCode.java | 2 +- .../message/publish/pubcomp/Mqtt5PubComp.java | 2 +- .../pubcomp/Mqtt5PubCompReasonCode.java | 2 +- .../message/publish/pubrec/Mqtt5PubRec.java | 2 +- .../publish/pubrec/Mqtt5PubRecReasonCode.java | 2 +- .../message/publish/pubrel/Mqtt5PubRel.java | 2 +- .../publish/pubrel/Mqtt5PubRelReasonCode.java | 2 +- .../message/subscribe/Mqtt5Subscribe.java | 2 +- .../message/subscribe/Mqtt5Subscription.java | 2 +- .../message/subscribe/suback/Mqtt5SubAck.java | 2 +- .../suback/Mqtt5SubAckReasonCode.java | 2 +- .../message/unsubscribe/Mqtt5Unsubscribe.java | 4 +- .../unsubscribe/unsuback/Mqtt5UnsubAck.java | 2 +- .../unsuback/Mqtt5UnsubAckReasonCode.java | 2 +- 94 files changed, 492 insertions(+), 486 deletions(-) diff --git a/reactor/src/main/java/com/hivemq/client/mqtt/mqtt3/reactor/Mqtt3ReactorClient.java b/reactor/src/main/java/com/hivemq/client/mqtt/mqtt3/reactor/Mqtt3ReactorClient.java index 5c9d5afdd..9ec071eef 100644 --- a/reactor/src/main/java/com/hivemq/client/mqtt/mqtt3/reactor/Mqtt3ReactorClient.java +++ b/reactor/src/main/java/com/hivemq/client/mqtt/mqtt3/reactor/Mqtt3ReactorClient.java @@ -38,7 +38,7 @@ import reactor.core.publisher.Mono; /** - * Reactor API of a {@link Mqtt3Client}. + * Reactor API of an {@link Mqtt3Client}. * * @author Silvio Giebl * @since 1.2 @@ -81,12 +81,11 @@ public interface Mqtt3ReactorClient extends Mqtt3Client { * @param connect the Connect message sent to the broker during connect. * @return the {@link Mono} which * */ @CheckReturnValue @@ -118,12 +117,12 @@ public interface Mqtt3ReactorClient extends Mqtt3Client { * @param subscribe the Subscribe message sent to the broker during subscribe. * @return the {@link Mono} which * */ @CheckReturnValue @@ -153,17 +152,17 @@ public interface Mqtt3ReactorClient extends Mqtt3Client { * @param subscribe the Subscribe message sent to the broker during subscribe. * @return the {@link FluxWithSingle} which * * @see #subscribePublishes(Mqtt3Subscribe, boolean) */ @@ -182,17 +181,17 @@ public interface Mqtt3ReactorClient extends Mqtt3Client { * @param manualAcknowledgement whether the Publish messages are acknowledged manually. * @return the {@link FluxWithSingle} which * * @see #subscribePublishes(Mqtt3Subscribe) */ @@ -223,10 +222,10 @@ public interface Mqtt3ReactorClient extends Mqtt3Client { * @param filter the filter with which all incoming Publish messages are filtered. * @return the {@link Flux} which * * @see #publishes(MqttGlobalPublishFilter, boolean) */ @@ -244,10 +243,10 @@ public interface Mqtt3ReactorClient extends Mqtt3Client { * @param manualAcknowledgement whether the Publish messages are acknowledged manually. * @return the {@link Flux} which * * @see #publishes(MqttGlobalPublishFilter) */ @@ -264,9 +263,9 @@ public interface Mqtt3ReactorClient extends Mqtt3Client { * @param unsubscribe the Unsubscribe message sent to the broker during unsubscribe. * @return the {@link Mono} which * */ @CheckReturnValue @@ -296,11 +295,11 @@ public interface Mqtt3ReactorClient extends Mqtt3Client { * @param publisher the source of the Publish messages to publish. * @return the {@link Flux} which * */ @CheckReturnValue @@ -314,8 +313,8 @@ public interface Mqtt3ReactorClient extends Mqtt3Client { * * @return the {@link Mono} which * */ @CheckReturnValue diff --git a/reactor/src/main/java/com/hivemq/client/mqtt/mqtt5/reactor/Mqtt5ReactorClient.java b/reactor/src/main/java/com/hivemq/client/mqtt/mqtt5/reactor/Mqtt5ReactorClient.java index 111db4a8d..76c64eb4b 100644 --- a/reactor/src/main/java/com/hivemq/client/mqtt/mqtt5/reactor/Mqtt5ReactorClient.java +++ b/reactor/src/main/java/com/hivemq/client/mqtt/mqtt5/reactor/Mqtt5ReactorClient.java @@ -41,7 +41,7 @@ import reactor.core.publisher.Mono; /** - * Reactor API of a {@link Mqtt5Client}. + * Reactor API of an {@link Mqtt5Client}. * * @author Silvio Giebl * @since 1.2 @@ -84,12 +84,11 @@ public interface Mqtt5ReactorClient extends Mqtt5Client { * @param connect the Connect message sent to the broker during connect. * @return the {@link Mono} which * */ @CheckReturnValue @@ -121,12 +120,12 @@ public interface Mqtt5ReactorClient extends Mqtt5Client { * @param subscribe the Subscribe message sent to the broker during subscribe. * @return the {@link Mono} which * */ @CheckReturnValue @@ -156,17 +155,17 @@ public interface Mqtt5ReactorClient extends Mqtt5Client { * @param subscribe the Subscribe message sent to the broker during subscribe. * @return the {@link FluxWithSingle} which * * @see #subscribePublishes(Mqtt5Subscribe, boolean) */ @@ -185,17 +184,17 @@ public interface Mqtt5ReactorClient extends Mqtt5Client { * @param manualAcknowledgement whether the Publish messages are acknowledged manually. * @return the {@link FluxWithSingle} which * * @see #subscribePublishes(Mqtt5Subscribe) */ @@ -226,10 +225,10 @@ public interface Mqtt5ReactorClient extends Mqtt5Client { * @param filter the filter with which all incoming Publish messages are filtered. * @return the {@link Flux} which * * @see #publishes(MqttGlobalPublishFilter, boolean) */ @@ -247,10 +246,10 @@ public interface Mqtt5ReactorClient extends Mqtt5Client { * @param manualAcknowledgement whether the Publish messages are acknowledged manually. * @return the {@link Flux} which * * @see #publishes(MqttGlobalPublishFilter) */ @@ -267,13 +266,13 @@ public interface Mqtt5ReactorClient extends Mqtt5Client { * @param unsubscribe the Unsubscribe message sent to the broker during unsubscribe. * @return the {@link Mono} which * */ @CheckReturnValue @@ -303,11 +302,11 @@ public interface Mqtt5ReactorClient extends Mqtt5Client { * @param publisher the source of the Publish messages to publish. * @return the {@link Flux} which * */ @CheckReturnValue @@ -321,12 +320,11 @@ public interface Mqtt5ReactorClient extends Mqtt5Client { * * @return the {@link Mono} which * */ @CheckReturnValue @@ -350,8 +348,8 @@ public interface Mqtt5ReactorClient extends Mqtt5Client { * @param disconnect the Disconnect message sent to the broker during disconnect. * @return the {@link Mono} which * */ @CheckReturnValue diff --git a/src/main/java/com/hivemq/client/mqtt/MqttClient.java b/src/main/java/com/hivemq/client/mqtt/MqttClient.java index e19ddd9a4..62ff7dba6 100644 --- a/src/main/java/com/hivemq/client/mqtt/MqttClient.java +++ b/src/main/java/com/hivemq/client/mqtt/MqttClient.java @@ -38,7 +38,7 @@ public interface MqttClient { */ int DEFAULT_SERVER_PORT = 1883; /** - * The default server port when using SSL. + * The default server port when using SSL/TLS. */ int DEFAULT_SERVER_PORT_SSL = 8883; /** @@ -46,14 +46,14 @@ public interface MqttClient { */ int DEFAULT_SERVER_PORT_WEBSOCKET = 80; /** - * The default server port when using SSL and WebSocket. + * The default server port when using SSL/TLS and WebSocket. */ int DEFAULT_SERVER_PORT_WEBSOCKET_SSL = 443; /** - * Creates a builder for a MQTT client. + * Creates a builder for an MQTT client. * - * @return the created builder for a MQTT client. + * @return the created builder for an MQTT client. */ static @NotNull MqttClientBuilder builder() { return new MqttRxClientBuilderBase.Choose(); @@ -66,6 +66,7 @@ public interface MqttClient { /** * @return the state of this client. + * @since 1.1 */ default @NotNull MqttClientState getState() { return getConfig().getState(); diff --git a/src/main/java/com/hivemq/client/mqtt/MqttClientBuilder.java b/src/main/java/com/hivemq/client/mqtt/MqttClientBuilder.java index 12f77c70c..9bb0003e8 100644 --- a/src/main/java/com/hivemq/client/mqtt/MqttClientBuilder.java +++ b/src/main/java/com/hivemq/client/mqtt/MqttClientBuilder.java @@ -23,7 +23,7 @@ import org.jetbrains.annotations.NotNull; /** - * Builder for a {@link MqttClient}. + * Builder for an {@link MqttClient}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/MqttClientBuilderBase.java b/src/main/java/com/hivemq/client/mqtt/MqttClientBuilderBase.java index 90aa220ad..5a41fa79f 100644 --- a/src/main/java/com/hivemq/client/mqtt/MqttClientBuilderBase.java +++ b/src/main/java/com/hivemq/client/mqtt/MqttClientBuilderBase.java @@ -30,7 +30,7 @@ import java.net.InetSocketAddress; /** - * Builder base for a {@link MqttClient}. + * Builder base for an {@link MqttClient}. * * @param the type of the builder. * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/MqttClientConfig.java b/src/main/java/com/hivemq/client/mqtt/MqttClientConfig.java index fb49604c2..f7b8c58ff 100644 --- a/src/main/java/com/hivemq/client/mqtt/MqttClientConfig.java +++ b/src/main/java/com/hivemq/client/mqtt/MqttClientConfig.java @@ -29,7 +29,7 @@ import java.util.Optional; /** - * Configuration of a {@link MqttClient}. + * Configuration of an {@link MqttClient}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/MqttClientConnectionConfig.java b/src/main/java/com/hivemq/client/mqtt/MqttClientConnectionConfig.java index 1a06cfa52..b4bdc75f8 100644 --- a/src/main/java/com/hivemq/client/mqtt/MqttClientConnectionConfig.java +++ b/src/main/java/com/hivemq/client/mqtt/MqttClientConnectionConfig.java @@ -20,7 +20,7 @@ import org.jetbrains.annotations.NotNull; /** - * Connection configuration of a {@link MqttClient}. + * Connection configuration of an {@link MqttClient}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/MqttClientSslConfig.java b/src/main/java/com/hivemq/client/mqtt/MqttClientSslConfig.java index fbf0c3c13..8aa5f67a8 100644 --- a/src/main/java/com/hivemq/client/mqtt/MqttClientSslConfig.java +++ b/src/main/java/com/hivemq/client/mqtt/MqttClientSslConfig.java @@ -38,7 +38,7 @@ public interface MqttClientSslConfig { /** - * The default ssl handshake timeout in milliseconds. + * The default SSL/TLS handshake timeout in milliseconds. */ long DEFAULT_HANDSHAKE_TIMEOUT_MS = 10_000; @@ -78,7 +78,7 @@ public interface MqttClientSslConfig { @NotNull Optional<@Immutable List<@NotNull String>> getProtocols(); /** - * @return the ssl handshake timeout in milliseconds. + * @return the SSL/TLS handshake timeout in milliseconds. */ long getHandshakeTimeoutMs(); diff --git a/src/main/java/com/hivemq/client/mqtt/MqttClientSslConfigBuilderBase.java b/src/main/java/com/hivemq/client/mqtt/MqttClientSslConfigBuilderBase.java index bac914f8d..865af5c48 100644 --- a/src/main/java/com/hivemq/client/mqtt/MqttClientSslConfigBuilderBase.java +++ b/src/main/java/com/hivemq/client/mqtt/MqttClientSslConfigBuilderBase.java @@ -78,11 +78,11 @@ public interface MqttClientSslConfigBuilderBase protocols); /** - * Sets the {@link MqttClientSslConfig#getHandshakeTimeoutMs() ssl handshake timeout}. + * Sets the {@link MqttClientSslConfig#getHandshakeTimeoutMs() SSL/TLS handshake timeout}. *

* The timeout in milliseconds must be in the range: [0, {@link Integer#MAX_VALUE}]. * - * @param timeout the ssl handshake timeout or 0 to disable the timeout. + * @param timeout the SSL/TLS handshake timeout or 0 to disable the timeout. * @param timeUnit the time unit of the given timeout (this timeout only supports millisecond precision). * @return the builder. */ diff --git a/src/main/java/com/hivemq/client/mqtt/MqttClientState.java b/src/main/java/com/hivemq/client/mqtt/MqttClientState.java index f38712a00..604b35fde 100644 --- a/src/main/java/com/hivemq/client/mqtt/MqttClientState.java +++ b/src/main/java/com/hivemq/client/mqtt/MqttClientState.java @@ -21,7 +21,22 @@ import java.util.EnumSet; /** - * State of a {@link MqttClient}. + * State of an {@link MqttClient}. + * 

+ * +--------------+             +------------------------+
+ * | DISCONNECTED <-+         +-> DISCONNECTED_RECONNECT |
+ * +-------+------+  \       /  +-----------+------------+
+ *         |          \     /               |
+ *         |           \   /                |
+ * +-------v------+     \ /     +-----------v------------+
+ * |  CONNECTING  +------x------+  CONNECTING_RECONNECT  |
+ * +-------+------+      |      +-----------+------------+
+ *         |             |                  |
+ *         |             |                  |
+ *         |      +------+------+           |
+ *         +------>  CONNECTED  <-----------+
+ *                +-------------+
+ *
* * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/MqttGlobalPublishFilter.java b/src/main/java/com/hivemq/client/mqtt/MqttGlobalPublishFilter.java index 4f0d42f29..44330f36a 100644 --- a/src/main/java/com/hivemq/client/mqtt/MqttGlobalPublishFilter.java +++ b/src/main/java/com/hivemq/client/mqtt/MqttGlobalPublishFilter.java @@ -52,23 +52,23 @@ public enum MqttGlobalPublishFilter { *

* This filter will not match any messages if *

    - *
  • the {@link #ALL} filter is used or
    • - *
  • both {@link #SUBSCRIBED} and {@link #UNSOLICITED} filters are used.
    • + *
  • the {@link #ALL} filter is used or + *
  • both {@link #SUBSCRIBED} and {@link #UNSOLICITED} filters are used. *
*

* Example (pseudo-code): *

    - *
  • stream1 = client.subscribeWithStream("a/#")
    • - *
  • client.subscribe("b/#")
    • - *
  • stream2 = client.publishes(SUBSCRIBED)
    • - *
  • stream3 = client.publishes(REMAINING)
    • + *
  • stream1 = client.subscribePublishes("a/#") + *
  • client.subscribe("b/#") + *
  • stream2 = client.publishes(SUBSCRIBED) + *
  • stream3 = client.publishes(REMAINING) *
* Result: incoming Publishes with topic *
    - *
  • "a/b" will be emitted in stream1 and stream2.
    • - *
  • "b/c" will be emitted in stream2
    • - *
  • "c/d" will be emitted in stream3 as there is no other stream registered for the - * topic.
    • + *
  • "a/b" will be emitted in stream1 and stream2. + *
  • "b/c" will be emitted in stream2 + *
  • "c/d" will be emitted in stream3 as there is no other stream registered for the + * topic. *
*/ REMAINING diff --git a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttClientIdentifier.java b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttClientIdentifier.java index 448f39abb..15d0c47e7 100644 --- a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttClientIdentifier.java +++ b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttClientIdentifier.java @@ -43,12 +43,12 @@ public interface MqttClientIdentifier extends MqttUtf8String { } /** - * Checks whether this Client Identifier must be allowed by a MQTT broker according to the MQTT specification. + * Checks whether this Client Identifier must be allowed by every MQTT broker according to the MQTT specification. *

- * A Client Identifier must be allowed by a MQTT broker if it is between 1 and 23 characters long and only contains - * lower or uppercase alphabetical characters or numbers. + * A Client Identifier must be allowed by every MQTT broker if it is between 1 and 23 characters long and only + * contains lower or uppercase alphabetical characters or numbers. * - * @return whether this Client Identifier must be allowed by a MQTT broker. + * @return whether this Client Identifier must be allowed by every MQTT broker. */ boolean mustBeAllowedByServer(); } diff --git a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttQos.java b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttQos.java index 513e01d6e..f4d21d4e0 100644 --- a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttQos.java +++ b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttQos.java @@ -20,7 +20,7 @@ import org.jetbrains.annotations.Nullable; /** - * MQTT Quality of Service according to the MQTT 5 specification. + * MQTT Quality of Service (QoS) according to the MQTT specification. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttSharedTopicFilter.java b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttSharedTopicFilter.java index 74f5c7452..f9ab30494 100644 --- a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttSharedTopicFilter.java +++ b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttSharedTopicFilter.java @@ -28,10 +28,10 @@ *

* The Share Name has the same requirements as an {@link MqttUtf8String UTF-8 encoded string}. Additionally it *

    - *
  • must be at least 1 character long,
    • - *
  • must not contain wildcard characters ({@value MqttTopicFilter#MULTI_LEVEL_WILDCARD}, {@value - * MqttTopicFilter#SINGLE_LEVEL_WILDCARD}) and
    • - *
  • must not contain a topic level separator ({@value MqttTopic#TOPIC_LEVEL_SEPARATOR})
    • + *
  • must be at least 1 character long, + *
  • must not contain wildcard characters ({@value MqttTopicFilter#MULTI_LEVEL_WILDCARD}, {@value + * MqttTopicFilter#SINGLE_LEVEL_WILDCARD}) and + *
  • must not contain a topic level separator ({@value MqttTopic#TOPIC_LEVEL_SEPARATOR}) *
*

* The Topic Filter has the same restrictions as a {@link MqttTopicFilter Topic Filter}. diff --git a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttTopic.java b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttTopic.java index d26944ba8..bcea085b8 100644 --- a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttTopic.java +++ b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttTopic.java @@ -29,9 +29,9 @@ *

* A Topic Name has the same requirements as an {@link MqttUtf8String UTF-8 encoded string}. Additionally it *

    - *
  • must be at least 1 character long and
    • - *
  • must not contain wildcard characters ({@value MqttTopicFilter#MULTI_LEVEL_WILDCARD}, {@value - * MqttTopicFilter#SINGLE_LEVEL_WILDCARD}).
    • + *
  • must be at least 1 character long and + *
  • must not contain wildcard characters ({@value MqttTopicFilter#MULTI_LEVEL_WILDCARD}, {@value + * MqttTopicFilter#SINGLE_LEVEL_WILDCARD}). *
* * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttTopicFilter.java b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttTopicFilter.java index 375025c81..49f713844 100644 --- a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttTopicFilter.java +++ b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttTopicFilter.java @@ -29,9 +29,9 @@ *

* A Topic Filter has the same requirements as an {@link MqttUtf8String UTF-8 encoded string}. Additionally it *

    - *
  • must be at least one character long,
    • - *
  • may contain one multi-level wildcard character ({@value #MULTI_LEVEL_WILDCARD}) at the end and
    • - *
  • may contain multiple single-level wildcards ({@value #SINGLE_LEVEL_WILDCARD}).
    • + *
  • must be at least one character long, + *
  • may contain one multi-level wildcard character ({@value #MULTI_LEVEL_WILDCARD}) at the end and + *
  • may contain multiple single-level wildcards ({@value #SINGLE_LEVEL_WILDCARD}). *
* * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttUtf8String.java b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttUtf8String.java index 4456e08f8..4bbe55ea9 100644 --- a/src/main/java/com/hivemq/client/mqtt/datatypes/MqttUtf8String.java +++ b/src/main/java/com/hivemq/client/mqtt/datatypes/MqttUtf8String.java @@ -23,24 +23,23 @@ import java.nio.ByteBuffer; /** - * UTF-8 encoded String according to the MQTT specification. + * UTF-8 encoded string according to the MQTT specification. *

- * MUST requirements: An UTF-8 encoded String + * MUST requirements: An UTF-8 encoded string *

    - *
  • must not be longer than 65535 bytes in UTF-8 encoding,
    • - *
  • must not contain the null character (U+0000) and
    • - *
  • must be well-formed UTF-8 as defined by the Unicode specification, so - *
      - *
    • must not contain encodings of UTF-16 surrogates (U+D800..U+DFFF) and
      • - *
    • must not contain non-shortest form encodings.
      • - *
    - *
    • + *
  • must not be longer than 65535 bytes in UTF-8 encoding, + *
  • must not contain the null character (U+0000) and + *
  • must be well-formed UTF-8 as defined by the Unicode specification, so + *
      + *
    • must not contain encodings of UTF-16 surrogates (U+D800..U+DFFF) and + *
    • must not contain non-shortest form encodings. + *
    *
*

- * SHOULD requirements: An UTF-8 encoded String + * SHOULD requirements: An UTF-8 encoded string *

    - *
  • should not contain control characters (U+0001..U+001F, U+007F..U+009F) and
    • - *
  • should not contain non-characters.
    • + *
  • should not contain control characters (U+0001..U+001F, U+007F..U+009F) and + *
  • should not contain non-characters. *
* * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/exceptions/MqttClientStateException.java b/src/main/java/com/hivemq/client/mqtt/exceptions/MqttClientStateException.java index 92b77cf12..fe4b71a86 100644 --- a/src/main/java/com/hivemq/client/mqtt/exceptions/MqttClientStateException.java +++ b/src/main/java/com/hivemq/client/mqtt/exceptions/MqttClientStateException.java @@ -20,7 +20,7 @@ import org.jetbrains.annotations.NotNull; /** - * Exception that is used if an operation is called on a {@link com.hivemq.client.mqtt.MqttClient MqttClient} that is + * Exception that is used if an operation is called on an {@link com.hivemq.client.mqtt.MqttClient MqttClient} that is * not possible in its current state, e.g. a client can not publish if it is not connected. * * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/exceptions/MqttDecodeException.java b/src/main/java/com/hivemq/client/mqtt/exceptions/MqttDecodeException.java index 01acf873b..2903b934b 100644 --- a/src/main/java/com/hivemq/client/mqtt/exceptions/MqttDecodeException.java +++ b/src/main/java/com/hivemq/client/mqtt/exceptions/MqttDecodeException.java @@ -20,7 +20,7 @@ import org.jetbrains.annotations.NotNull; /** - * Exception that is used if an decoding error occurred. + * Exception that is used if a decoding error occurred. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientDisconnectedContext.java b/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientDisconnectedContext.java index c5686a3d7..cc0a46190 100644 --- a/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientDisconnectedContext.java +++ b/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientDisconnectedContext.java @@ -21,7 +21,7 @@ import org.jetbrains.annotations.NotNull; /** - * Provides context about the client that is now disconnected and the cause for disconnection and allows reconnecting. + * Provides context about the client that is now disconnected, the cause for disconnection and allows reconnecting. * * @author Silvio Giebl * @since 1.1 @@ -44,19 +44,19 @@ public interface MqttClientDisconnectedContext { *

* This can be: *

    - *
  • {@link com.hivemq.client.mqtt.exceptions.ConnectionFailedException ConnectionFailedException} if a connect - * attempt failed
    • - *
  • {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3ConnAckException Mqtt3ConnAckException} or {@link - * com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5ConnAckException Mqtt5ConnAckException} (depending on the MQTT - * version of the client) if the ConnAck message contained an error code, which means that the connect was - * rejected
    • - *
  • {@link com.hivemq.client.mqtt.exceptions.ConnectionClosedException ConnectionClosedException} if the - * connection was closed without sending a Disconnect message (use {@link #getSource()} to determine if the server - * or the client closed the connection)
    • - *
  • {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3DisconnectException Mqtt3DisconnectException} or {@link - * com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5DisconnectException Mqtt5DisconnectException} (depending on the MQTT - * version of the client) if the connection was closed with a Disconnect message (use {@link #getSource()} to - * determine if the server, the user or the client sent the Disconnect message)
    • + *
  • {@link com.hivemq.client.mqtt.exceptions.ConnectionFailedException ConnectionFailedException} if a connect + * attempt failed + *
  • {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3ConnAckException Mqtt3ConnAckException} or {@link + * com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5ConnAckException Mqtt5ConnAckException} (depending on the MQTT + * version of the client) if the ConnAck message contained an error code, which means that the connect was + * rejected + *
  • {@link com.hivemq.client.mqtt.exceptions.ConnectionClosedException ConnectionClosedException} if the + * connection was closed without sending a Disconnect message (use {@link #getSource()} to determine if the + * server or the client closed the connection) + *
  • {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3DisconnectException Mqtt3DisconnectException} or {@link + * com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5DisconnectException Mqtt5DisconnectException} (depending on the + * MQTT version of the client) if the connection was closed with a Disconnect message (use {@link #getSource()} + * to determine if the server, the user or the client sent the Disconnect message) *
*

* Example: You can use the following code to extract the Disconnect message: diff --git a/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientDisconnectedListener.java b/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientDisconnectedListener.java index d65c4a582..a1c0a5ed1 100644 --- a/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientDisconnectedListener.java +++ b/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientDisconnectedListener.java @@ -31,28 +31,28 @@ public interface MqttClientDisconnectedListener { /** * Listener method which is notified in the following cases: *

    - *
  • A client was disconnected (with or without a Disconnect message, by the server, client or user) or the - * connection failed. The client state will still be {@link com.hivemq.client.mqtt.MqttClientState#CONNECTED - * CONNECTED} and the {@link com.hivemq.client.mqtt.MqttClientConnectionConfig MqttClientConnectionConfig} will - * still be present.
    • - *
  • A connect attempt by the user failed. The client state will still be - * {@link com.hivemq.client.mqtt.MqttClientState#CONNECTING CONNECTING}.
    • - *
  • A reconnect attempt by the client failed. The client state will still be - * {@link com.hivemq.client.mqtt.MqttClientState#CONNECTING_RECONNECT CONNECTING_RECONNECT}.
    • + *
  • A client was disconnected (with or without a Disconnect message, by the server, client or user) or the + * connection failed. The client state will still be {@link com.hivemq.client.mqtt.MqttClientState#CONNECTED + * CONNECTED} and the {@link com.hivemq.client.mqtt.MqttClientConnectionConfig MqttClientConnectionConfig} will + * still be present. + *
  • A connect attempt by the user failed. The client state will still be + * {@link com.hivemq.client.mqtt.MqttClientState#CONNECTING CONNECTING}. + *
  • A reconnect attempt by the client failed. The client state will still be + * {@link com.hivemq.client.mqtt.MqttClientState#CONNECTING_RECONNECT CONNECTING_RECONNECT}. *
* The client state will be updated after all {@link MqttClientDisconnectedListener MqttClientDisconnectedListeners} * are called to *
    - *
  • {@link com.hivemq.client.mqtt.MqttClientState#DISCONNECTED DISCONNECTED} or
    • - *
  • {@link com.hivemq.client.mqtt.MqttClientState#DISCONNECTED_RECONNECT DISCONNECTED_RECONNECT} if the client - * is instructed to reconnect.
    • + *
  • {@link com.hivemq.client.mqtt.MqttClientState#DISCONNECTED DISCONNECTED} or + *
  • {@link com.hivemq.client.mqtt.MqttClientState#DISCONNECTED_RECONNECT DISCONNECTED_RECONNECT} if the client + * is instructed to reconnect. *
*

* This method must not block. If you want to reconnect you have to use the supplied {@link * MqttClientDisconnectedContext#getReconnector()}. * - * @param context provides context about the client that is now disconnected and the cause for disconnection and - * allows reconnecting. + * @param context provides context about the client that is now disconnected, the cause for disconnection and allows + * reconnecting. */ void onDisconnected(@NotNull MqttClientDisconnectedContext context); } diff --git a/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttDisconnectSource.java b/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttDisconnectSource.java index aca7bb8b5..e1f4eece5 100644 --- a/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttDisconnectSource.java +++ b/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttDisconnectSource.java @@ -35,10 +35,10 @@ public enum MqttDisconnectSource { *

* This can happen if *

    - *
  • an initialization error occurs (e.g. unknown host)
    • - *
  • an operation times out (e.g. connect, ping)
    • - *
  • a network error occurs
    • - *
  • the server does not conform to the MQTT specification (e.g. malformed packet, protocol error)
    • + *
  • an initialization error occurs (e.g. unknown host) + *
  • an operation times out (e.g. connect, ping) + *
  • a network error occurs + *
  • the server does not conform to the MQTT specification (e.g. malformed packet, protocol error) *
*/ CLIENT, diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3AsyncClient.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3AsyncClient.java index c11be2910..009ae96ee 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3AsyncClient.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3AsyncClient.java @@ -36,7 +36,7 @@ import java.util.function.Consumer; /** - * Asynchronous API of a {@link Mqtt3Client} based on futures and callbacks. + * Asynchronous API of an {@link Mqtt3Client} based on futures and callbacks. * * @author Silvio Giebl * @since 1.0 @@ -58,12 +58,12 @@ public interface Mqtt3AsyncClient extends Mqtt3Client { * @param connect the Connect message sent to the broker. * @return a {@link CompletableFuture} which *
    - *
  • completes normally with the ConnAck message if it does not contain an Error Code (connected - * successfully),
    • - *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3ConnAckException - * Mqtt3ConnAckException} wrapping the ConnAck message if it contains an Error Code or
    • - *
  • completes exceptionally with a different exception if an error occurred before the Connect message - * was sent or before the ConnAck message was received.
    • + *
  • completes normally with the ConnAck message if it does not contain an Error Code (connected + * successfully), + *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3ConnAckException + * Mqtt3ConnAckException} wrapping the ConnAck message if it contains an Error Code or + *
  • completes exceptionally with a different exception if an error occurred before the Connect message + * was sent or before the ConnAck message was received. *
*/ @NotNull CompletableFuture<@NotNull Mqtt3ConnAck> connect(@NotNull Mqtt3Connect connect); @@ -91,12 +91,12 @@ public interface Mqtt3AsyncClient extends Mqtt3Client { * @param subscribe the Subscribe messages sent to the broker. * @return a {@link CompletableFuture} which *
    - *
  • completes normally with the SubAck message if all subscriptions of the Subscribe message were - * successful (the SubAck message contains no Error Codes),
    • - *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException - * Mqtt3SubAckException} wrapping the SubAck message if it contains at least one Error Code or
    • - *
  • completes exceptionally with a different exception if an error occurred before the Subscribe message - * was sent or before a SubAck message was received.
    • + *
  • completes normally with the SubAck message if all subscriptions of the Subscribe message were + * successful (the SubAck message contains no Error Codes), + *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException + * Mqtt3SubAckException} wrapping the SubAck message if it contains at least one Error Code or + *
  • completes exceptionally with a different exception if an error occurred before the Subscribe + * message was sent or before a SubAck message was received. *
*/ @NotNull CompletableFuture<@NotNull Mqtt3SubAck> subscribe(@NotNull Mqtt3Subscribe subscribe); @@ -185,10 +185,10 @@ public interface Mqtt3AsyncClient extends Mqtt3Client { * Calling {@link Mqtt3SubscribeAndCallbackBuilder.Complete#send()} on the returned builder has the same effect as * calling one of the following methods: *
    - *
  • {@link #subscribe(Mqtt3Subscribe)} if no callback has been supplied to the builder
    • - *
  • {@link #subscribe(Mqtt3Subscribe, Consumer)} if only a callback has been supplied to the builder
    • - *
  • {@link #subscribe(Mqtt3Subscribe, Consumer, Executor)} if a callback and an executor have been supplied to - * the builder
    • + *
  • {@link #subscribe(Mqtt3Subscribe)} if no callback has been supplied to the builder + *
  • {@link #subscribe(Mqtt3Subscribe, Consumer)} if only a callback has been supplied to the builder + *
  • {@link #subscribe(Mqtt3Subscribe, Consumer, Executor)} if a callback and an executor have been supplied to + * the builder *
* * @return the fluent builder for the Subscribe message. @@ -265,9 +265,9 @@ void publishes( * @param unsubscribe the Unsubscribe message sent to the broker. * @return a {@link CompletableFuture} which *
    - *
  • completes normally when the corresponding UnsubAck message was received or
    • - *
  • completes exceptionally if an error occurred before the Unsubscribe message was sent or before a - * UnsubAck message was received.
    • + *
  • completes normally when the corresponding UnsubAck message was received or + *
  • completes exceptionally if an error occurred before the Unsubscribe message was sent or before a + * UnsubAck message was received. *
*/ @NotNull CompletableFuture unsubscribe(@NotNull Mqtt3Unsubscribe unsubscribe); @@ -290,10 +290,10 @@ void publishes( * @param publish the Publish message sent to the broker. * @return a {@link CompletableFuture} which *
    - *
  • completes normally with the same Publish message (for context) if the Publish message was - * successfully published or
    • - *
  • completes exceptionally if an error occurred before the Publish message was sent or before an - * acknowledgement message was received.
    • + *
  • completes normally with the same Publish message (for context) if the Publish message was + * successfully published or + *
  • completes exceptionally if an error occurred before the Publish message was sent or before an + * acknowledgement message was received. *
*/ @NotNull CompletableFuture<@NotNull Mqtt3Publish> publish(@NotNull Mqtt3Publish publish); @@ -315,8 +315,8 @@ void publishes( * * @return the {@link CompletableFuture} which *
    - *
  • completes when the client was successfully disconnected or
    • - *
  • errors if not disconnected gracefully.
    • + *
  • completes when the client was successfully disconnected or + *
  • errors if not disconnected gracefully. *
*/ @NotNull CompletableFuture disconnect(); diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3BlockingClient.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3BlockingClient.java index 74f81218d..7c9de86fa 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3BlockingClient.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3BlockingClient.java @@ -35,7 +35,7 @@ import java.util.concurrent.TimeUnit; /** - * Blocking API of a {@link Mqtt3Client}. + * Blocking API of an {@link Mqtt3Client}. * * @author Silvio Giebl * @since 1.0 @@ -178,9 +178,9 @@ interface Mqtt3Publishes extends AutoCloseable { /** * Receives the next incoming Publish message. *
    - *
  • Might return immediately if there is already a Publish message queued in this {@link Mqtt3Publishes} - * instance.
    • - *
  • Otherwise blocks the calling thread until a Publish message is received.
    • + *
  • Might return immediately if there is already a Publish message queued in this {@link Mqtt3Publishes} + * instance. + *
  • Otherwise blocks the calling thread until a Publish message is received. *
* * @return the received Publish message. @@ -192,10 +192,9 @@ interface Mqtt3Publishes extends AutoCloseable { /** * Receives the next incoming Publish message. *
    - *
  • Might return immediately if there is already a Publish message queued in this {@link Mqtt3Publishes} - * instance.
    • - *
  • Otherwise blocks the calling thread until a Publish message is received or the given timeout - * applies.
    • + *
  • Might return immediately if there is already a Publish message queued in this {@link Mqtt3Publishes} + * instance. + *
  • Otherwise blocks the calling thread until a Publish message is received or the given timeout applies. *
* * @param timeout the time to wait for a Publish messages to be received. diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3Client.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3Client.java index 10bde91c0..7fd7e2935 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3Client.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3Client.java @@ -32,7 +32,7 @@ public interface Mqtt3Client extends MqttClient { /** - * Creates a builder for a MQTT 3 client. + * Creates a builder for an MQTT 3 client. * * @return the created builder for a MQTT 3 client. */ diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientBuilder.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientBuilder.java index a8bb5fd99..b460bd331 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientBuilder.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientBuilder.java @@ -27,7 +27,7 @@ import org.jetbrains.annotations.Nullable; /** - * Builder for a {@link Mqtt3Client}. + * Builder for an {@link Mqtt3Client}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientConfig.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientConfig.java index 04e2f7562..c0ff11d0a 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientConfig.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientConfig.java @@ -25,7 +25,7 @@ import java.util.Optional; /** - * Configuration of a {@link Mqtt3Client}. + * Configuration of an {@link Mqtt3Client}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientConnectionConfig.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientConnectionConfig.java index b6a20ab08..42949102d 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientConnectionConfig.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3ClientConnectionConfig.java @@ -21,7 +21,7 @@ import org.jetbrains.annotations.NotNull; /** - * Connection configuration of a {@link Mqtt3Client}. + * Connection configuration of an {@link Mqtt3Client}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3RxClient.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3RxClient.java index 199dc68e7..ae062da21 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3RxClient.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/Mqtt3RxClient.java @@ -36,7 +36,7 @@ import org.jetbrains.annotations.NotNull; /** - * Reactive API of a {@link Mqtt3Client}. + * Reactive API of an {@link Mqtt3Client}. * * @author Silvio Giebl * @since 1.0 @@ -63,12 +63,11 @@ public interface Mqtt3RxClient extends Mqtt3Client { * @param connect the Connect message sent to the broker during connect. * @return the {@link Single} which *
    - *
  • succeeds with the ConnAck message if it does not contain an Error Code (connected - * successfully),
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3ConnAckException - * Mqtt3ConnAckException} wrapping the ConnAck message if it contains an Error Code or
    • - *
  • errors with a different exception if an error occurred before the Connect message was sent or before - * the ConnAck message was received.
    • + *
  • succeeds with the ConnAck message if it does not contain an Error Code (connected successfully), + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3ConnAckException + * Mqtt3ConnAckException} wrapping the ConnAck message if it contains an Error Code or + *
  • errors with a different exception if an error occurred before the Connect message was sent or + * before the ConnAck message was received. *
*/ @CheckReturnValue @@ -100,12 +99,12 @@ public interface Mqtt3RxClient extends Mqtt3Client { * @param subscribe the Subscribe message sent to the broker during subscribe. * @return the {@link Single} which *
    - *
  • succeeds with the SubAck message if at least one subscription of the Subscribe message was - * successful (the SubAck message contains at least one Return Code that is not an Error Code),
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException - * Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or
    • - *
  • errors with a different exception if an error occurred before the Subscribe message was sent or - * before a SubAck message was received.
    • + *
  • succeeds with the SubAck message if at least one subscription of the Subscribe message was + * successful (the SubAck message contains at least one Return Code that is not an Error Code), + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException + * Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or + *
  • errors with a different exception if an error occurred before the Subscribe message was sent or + * before a SubAck message was received. *
*/ @CheckReturnValue @@ -147,17 +146,17 @@ public interface Mqtt3RxClient extends Mqtt3Client { * @param subscribe the Subscribe message sent to the broker during subscribe. * @return the {@link FlowableWithSingle} which *
    - *
  • emits the SubAck message as the single and first element if at least one subscription of the - * Subscribe message was successful (the SubAck message contains at least one Return Code that is not an - * Error Code) and then emits the Publish messages matching the successful subscriptions of the Subscribe - * message,
    • - *
  • completes when all subscriptions of the Subscribe message were unsubscribed,
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException - * Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or
    • - *
  • errors with a different exception if an error occurred before the Subscribe message was sent, - * before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe - * message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException - * MqttSessionExpiredException}).
    • + *
  • emits the SubAck message as the single and first element if at least one subscription of the + * Subscribe message was successful (the SubAck message contains at least one Return Code that is not an + * Error Code) and then emits the Publish messages matching the successful subscriptions of the + * Subscribe message, + *
  • completes when all subscriptions of the Subscribe message were unsubscribed, + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException + * Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or + *
  • errors with a different exception if an error occurred before the Subscribe message was sent, + * before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe + * message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException + * MqttSessionExpiredException}). *
* @see #subscribePublishes(Mqtt3Subscribe, boolean) * @since 1.2 @@ -177,17 +176,17 @@ public interface Mqtt3RxClient extends Mqtt3Client { * @param manualAcknowledgement whether the Publish messages are acknowledged manually. * @return the {@link FlowableWithSingle} which *
    - *
  • emits the SubAck message as the single and first element if at least one subscription of the - * Subscribe message was successful (the SubAck message contains at least one Return Code that is not an - * Error Code) and then emits the Publish messages matching the successful subscriptions of the Subscribe - * message,
    • - *
  • completes when all subscriptions of the Subscribe message were unsubscribed,
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException - * Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or
    • - *
  • errors with a different exception if an error occurred before the Subscribe message was sent, - * before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe - * message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException - * MqttSessionExpiredException}).
    • + *
  • emits the SubAck message as the single and first element if at least one subscription of the + * Subscribe message was successful (the SubAck message contains at least one Return Code that is not an + * Error Code) and then emits the Publish messages matching the successful subscriptions of the + * Subscribe message, + *
  • completes when all subscriptions of the Subscribe message were unsubscribed, + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException + * Mqtt3SubAckException} wrapping the SubAck message if it only contains Error Codes or + *
  • errors with a different exception if an error occurred before the Subscribe message was sent, + * before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe + * message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException + * MqttSessionExpiredException}). *
* @see #subscribePublishes(Mqtt3Subscribe) * @since 1.2 @@ -220,10 +219,10 @@ public interface Mqtt3RxClient extends Mqtt3Client { * @param filter the filter with which all incoming Publish messages are filtered. * @return the {@link Flowable} which *
    - *
  • emits the incoming Publish messages matching the given filter,
    • - *
  • never completes but
    • - *
  • errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException - * MqttSessionExpiredException} when the MQTT session expires.
    • + *
  • emits the incoming Publish messages matching the given filter, + *
  • never completes but + *
  • errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException + * MqttSessionExpiredException} when the MQTT session expires. *
* @see #publishes(MqttGlobalPublishFilter, boolean) */ @@ -241,10 +240,10 @@ public interface Mqtt3RxClient extends Mqtt3Client { * @param manualAcknowledgement whether the Publish messages are acknowledged manually. * @return the {@link Flowable} which *
    - *
  • emits the incoming Publish messages matching the given filter,
    • - *
  • never completes but
    • - *
  • errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException - * MqttSessionExpiredException} when the MQTT session expires.
    • + *
  • emits the incoming Publish messages matching the given filter, + *
  • never completes but + *
  • errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException + * MqttSessionExpiredException} when the MQTT session expires. *
* @see #publishes(MqttGlobalPublishFilter) * @since 1.2 @@ -262,9 +261,9 @@ public interface Mqtt3RxClient extends Mqtt3Client { * @param unsubscribe the Unsubscribe message sent to the broker during unsubscribe. * @return the {@link Completable} which *
    - *
  • succeeds when the corresponding UnsubAck message was received or
    • - *
  • errors if an error occurred before the Unsubscribe message was sent or before a UnsubAck message was - * received.
    • + *
  • succeeds when the corresponding UnsubAck message was received or + *
  • errors if an error occurred before the Unsubscribe message was sent or before a UnsubAck message + * was received. *
*/ @CheckReturnValue @@ -294,11 +293,11 @@ public interface Mqtt3RxClient extends Mqtt3Client { * @param publishFlowable the source of the Publish messages to publish. * @return the {@link Flowable} which *
    - *
  • emits {@link Mqtt3PublishResult}s each corresponding to a Publish message,
    • - *
  • completes if the given {@link Flowable} completes, but not before all {@link Mqtt3PublishResult}s - * were emitted, or
    • - *
  • errors with the same exception if the given {@link Flowable} errors, but not before all - * {@link Mqtt3PublishResult}s were emitted.
    • + *
  • emits {@link Mqtt3PublishResult}s each corresponding to a Publish message, + *
  • completes if the given {@link Flowable} completes, but not before all {@link Mqtt3PublishResult}s + * were emitted, or + *
  • errors with the same exception if the given {@link Flowable} errors, but not before all + * {@link Mqtt3PublishResult}s were emitted. *
*/ @CheckReturnValue @@ -312,8 +311,8 @@ public interface Mqtt3RxClient extends Mqtt3Client { * * @return the {@link Completable} which *
    - *
  • completes when the client was successfully disconnected or
    • - *
  • errors if not disconnected gracefully.
    • + *
  • completes when the client was successfully disconnected or + *
  • errors if not disconnected gracefully. *
*/ @CheckReturnValue diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientConnectedContext.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientConnectedContext.java index 539c190d6..e5aa65a46 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientConnectedContext.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientConnectedContext.java @@ -24,7 +24,7 @@ import org.jetbrains.annotations.NotNull; /** - * A {@link MqttClientConnectedContext} with methods specific to a {@link com.hivemq.client.mqtt.mqtt3.Mqtt3Client + * A {@link MqttClientConnectedContext} with methods specific to an {@link com.hivemq.client.mqtt.mqtt3.Mqtt3Client * Mqtt3Client}. * * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientDisconnectedContext.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientDisconnectedContext.java index eb489bbb6..1b8901af8 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientDisconnectedContext.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientDisconnectedContext.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * A {@link MqttClientDisconnectedContext} with methods specific to a {@link com.hivemq.client.mqtt.mqtt3.Mqtt3Client + * A {@link MqttClientDisconnectedContext} with methods specific to an {@link com.hivemq.client.mqtt.mqtt3.Mqtt3Client * Mqtt3Client}. * * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientReconnector.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientReconnector.java index 87eb35685..dac4a65de 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientReconnector.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/lifecycle/Mqtt3ClientReconnector.java @@ -31,7 +31,7 @@ import java.util.function.BiConsumer; /** - * A {@link MqttClientReconnector} with methods specific to a {@link com.hivemq.client.mqtt.mqtt3.Mqtt3Client + * A {@link MqttClientReconnector} with methods specific to an {@link com.hivemq.client.mqtt.mqtt3.Mqtt3Client * Mqtt3Client}. * * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/auth/Mqtt3SimpleAuth.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/auth/Mqtt3SimpleAuth.java index 5dc78e286..1ca47e1b1 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/auth/Mqtt3SimpleAuth.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/auth/Mqtt3SimpleAuth.java @@ -25,7 +25,7 @@ import java.util.Optional; /** - * Simple authentication and/or authorization related data in a {@link com.hivemq.client.mqtt.mqtt3.message.connect.Mqtt3Connect + * Simple authentication and/or authorization related data in an {@link com.hivemq.client.mqtt.mqtt3.message.connect.Mqtt3Connect * MQTT 3 Connect message}. * * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/Mqtt3Connect.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/Mqtt3Connect.java index ade85fb20..2ec330c77 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/Mqtt3Connect.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/Mqtt3Connect.java @@ -27,7 +27,7 @@ import java.util.Optional; /** - * MQTT 3 Connect message. This message is translated from and to a MQTT 3 CONNECT packet. + * MQTT 3 Connect message. This message is translated from and to an MQTT 3 CONNECT packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/connack/Mqtt3ConnAck.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/connack/Mqtt3ConnAck.java index 6624ae7bf..531d09624 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/connack/Mqtt3ConnAck.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/connack/Mqtt3ConnAck.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 3 ConnAck message. This message is translated from and to a MQTT 3 CONNACK packet. + * MQTT 3 ConnAck message. This message is translated from and to an MQTT 3 CONNACK packet. * * @author Daniel Krüger * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/connack/Mqtt3ConnAckReturnCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/connack/Mqtt3ConnAckReturnCode.java index 91cedf13a..dca1ef5f7 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/connack/Mqtt3ConnAckReturnCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/connect/connack/Mqtt3ConnAckReturnCode.java @@ -21,7 +21,7 @@ import org.jetbrains.annotations.Nullable; /** - * Return Code of a {@link Mqtt3ConnAck MQTT 3 ConnAck message}. + * Return Code of an {@link Mqtt3ConnAck MQTT 3 ConnAck message}. * * @author Daniel Krüger * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/disconnect/Mqtt3Disconnect.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/disconnect/Mqtt3Disconnect.java index de409f094..0ffdf3564 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/disconnect/Mqtt3Disconnect.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/disconnect/Mqtt3Disconnect.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 3 Disconnect message. This message is translated from and to a MQTT 3 DISCONNECT packet. + * MQTT 3 Disconnect message. This message is translated from and to an MQTT 3 DISCONNECT packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/ping/Mqtt3PingReq.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/ping/Mqtt3PingReq.java index f0f398132..e7e5a46f2 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/ping/Mqtt3PingReq.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/ping/Mqtt3PingReq.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 3 PingReq message. This message is translated from and to a MQTT 3 PINGREQ packet. + * MQTT 3 PingReq message. This message is translated from and to an MQTT 3 PINGREQ packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/ping/Mqtt3PingResp.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/ping/Mqtt3PingResp.java index 492558019..de1cf12d1 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/ping/Mqtt3PingResp.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/ping/Mqtt3PingResp.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 3 PingResp message. This message is translated from and to a MQTT 3 PINGRESP packet. + * MQTT 3 PingResp message. This message is translated from and to an MQTT 3 PINGRESP packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/Mqtt3Publish.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/Mqtt3Publish.java index 1496a6304..70aa48f35 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/Mqtt3Publish.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/Mqtt3Publish.java @@ -28,7 +28,7 @@ import java.util.Optional; /** - * MQTT 3 Publish message. This message is translated from and to a MQTT 3 PUBLISH packet. + * MQTT 3 Publish message. This message is translated from and to an MQTT 3 PUBLISH packet. * * @author Daniel Krüger * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/Mqtt3PublishResult.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/Mqtt3PublishResult.java index e8d8e07e9..0ccaaf31f 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/Mqtt3PublishResult.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/Mqtt3PublishResult.java @@ -22,7 +22,7 @@ import java.util.Optional; /** - * Result for a {@link Mqtt3Publish MQTT 3 Publish message} sent by the client. + * Result for an {@link Mqtt3Publish MQTT 3 Publish message} sent by the client. *

* The result is provided if a Publish message is successfully delivered (sent or acknowledged respectively to its * {@link com.hivemq.client.mqtt.datatypes.MqttQos QoS} level). diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/puback/Mqtt3PubAck.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/puback/Mqtt3PubAck.java index 38e0a0cf1..11b538b6b 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/puback/Mqtt3PubAck.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/puback/Mqtt3PubAck.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 3 PubAck message. This message is translated from and to a MQTT 3 PUBACK packet. + * MQTT 3 PubAck message. This message is translated from and to an MQTT 3 PUBACK packet. * * @author Daniel Krüger * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubcomp/Mqtt3PubComp.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubcomp/Mqtt3PubComp.java index d365f6f9f..d6333d76c 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubcomp/Mqtt3PubComp.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubcomp/Mqtt3PubComp.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 3 PubComp message. This message is translated from and to a MQTT 3 PUBCOMP packet. + * MQTT 3 PubComp message. This message is translated from and to an MQTT 3 PUBCOMP packet. * * @author Daniel Krüger * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubrec/Mqtt3PubRec.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubrec/Mqtt3PubRec.java index 30b7d56c4..d0e6ffcb1 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubrec/Mqtt3PubRec.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubrec/Mqtt3PubRec.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 3 PubRec message. This message is translated from and to a MQTT 3 PUBREC packet. + * MQTT 3 PubRec message. This message is translated from and to an MQTT 3 PUBREC packet. * * @author Daniel Krüger * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubrel/Mqtt3PubRel.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubrel/Mqtt3PubRel.java index a2e4cfbff..611568151 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubrel/Mqtt3PubRel.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/publish/pubrel/Mqtt3PubRel.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 3 PubRel message. This message is translated from and to a MQTT 3 PUBREL packet. + * MQTT 3 PubRel message. This message is translated from and to an MQTT 3 PUBREL packet. * * @author Daniel Krüger * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/Mqtt3Subscribe.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/Mqtt3Subscribe.java index c27c39144..0ee0b1603 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/Mqtt3Subscribe.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/Mqtt3Subscribe.java @@ -26,7 +26,7 @@ import java.util.List; /** - * MQTT 3 Subscribe message. This message is translated from and to a MQTT 3 SUBSCRIBE packet. + * MQTT 3 Subscribe message. This message is translated from and to an MQTT 3 SUBSCRIBE packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/Mqtt3Subscription.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/Mqtt3Subscription.java index 420da4912..279104057 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/Mqtt3Subscription.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/Mqtt3Subscription.java @@ -23,7 +23,7 @@ import org.jetbrains.annotations.NotNull; /** - * Subscription in a {@link Mqtt3Subscribe MQTT 3 Subscribe message}. + * Subscription in an {@link Mqtt3Subscribe MQTT 3 Subscribe message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/suback/Mqtt3SubAck.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/suback/Mqtt3SubAck.java index 3ba9102b0..9637b53ce 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/suback/Mqtt3SubAck.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/suback/Mqtt3SubAck.java @@ -25,7 +25,7 @@ import java.util.List; /** - * MQTT 3 SubAck message. This message is translated from and to a MQTT 3 SUBACK packet. + * MQTT 3 SubAck message. This message is translated from and to an MQTT 3 SUBACK packet. * * @author Daniel Krüger * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/suback/Mqtt3SubAckReturnCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/suback/Mqtt3SubAckReturnCode.java index 05b9a163c..a7f97f7ad 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/suback/Mqtt3SubAckReturnCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/subscribe/suback/Mqtt3SubAckReturnCode.java @@ -20,7 +20,7 @@ import org.jetbrains.annotations.Nullable; /** - * Return Code of a {@link Mqtt3SubAck MQTT 3 SubAck message}. + * Return Code of an {@link Mqtt3SubAck MQTT 3 SubAck message}. * * @author Daniel Krüger * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/unsubscribe/Mqtt3Unsubscribe.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/unsubscribe/Mqtt3Unsubscribe.java index a3e386580..75605bd7f 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/unsubscribe/Mqtt3Unsubscribe.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/unsubscribe/Mqtt3Unsubscribe.java @@ -27,7 +27,7 @@ import java.util.List; /** - * MQTT 3 Unsubscribe message. This message is translated from and to a MQTT 3 UNSUBSCRIBE packet. + * MQTT 3 Unsubscribe message. This message is translated from and to an MQTT 3 UNSUBSCRIBE packet. * * @author Daniel Krüger * @author Silvio Giebl @@ -37,7 +37,7 @@ public interface Mqtt3Unsubscribe extends Mqtt3Message { /** - * Creates a builder for a Unsubscribe message. + * Creates a builder for an Unsubscribe message. * * @return the created builder. */ diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/unsubscribe/unsuback/Mqtt3UnsubAck.java b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/unsubscribe/unsuback/Mqtt3UnsubAck.java index 0aa6dabe2..aa6c1a04e 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt3/message/unsubscribe/unsuback/Mqtt3UnsubAck.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt3/message/unsubscribe/unsuback/Mqtt3UnsubAck.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 3 UnsubAck message. This message is translated from and to a MQTT 3 UNSUBACK packet. + * MQTT 3 UnsubAck message. This message is translated from and to an MQTT 3 UNSUBACK packet. * * @author Daniel Krüger * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5AsyncClient.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5AsyncClient.java index 7e0342c44..625400319 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5AsyncClient.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5AsyncClient.java @@ -40,7 +40,7 @@ import java.util.function.Consumer; /** - * Asynchronous API of a {@link Mqtt5Client} based on futures and callbacks. + * Asynchronous API of an {@link Mqtt5Client} based on futures and callbacks. * * @author Silvio Giebl * @since 1.0 @@ -62,12 +62,12 @@ public interface Mqtt5AsyncClient extends Mqtt5Client { * @param connect the Connect message sent to the broker. * @return a {@link CompletableFuture} which *

    - *
  • completes normally with the ConnAck message if it does not contain an Error Code (connected - * successfully),
    • - *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5ConnAckException - * Mqtt5ConnAckException} wrapping the ConnAck message if it contains an Error Code or
    • - *
  • completes exceptionally with a different exception if an error occurred before the Connect message - * was sent or before the ConnAck message was received.
    • + *
  • completes normally with the ConnAck message if it does not contain an Error Code (connected + * successfully), + *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5ConnAckException + * Mqtt5ConnAckException} wrapping the ConnAck message if it contains an Error Code or + *
  • completes exceptionally with a different exception if an error occurred before the Connect message + * was sent or before the ConnAck message was received. *
*/ @NotNull CompletableFuture<@NotNull Mqtt5ConnAck> connect(@NotNull Mqtt5Connect connect); @@ -95,12 +95,12 @@ public interface Mqtt5AsyncClient extends Mqtt5Client { * @param subscribe the Subscribe messages sent to the broker. * @return a {@link CompletableFuture} which *
    - *
  • completes normally with the SubAck message if all subscriptions of the Subscribe message were - * successful (the SubAck message contains no Error Codes),
    • - *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5SubAckException - * Mqtt5SubAckException} wrapping the SubAck message if it contains at least one Error Code or
    • - *
  • completes exceptionally with a different exception if an error occurred before the Subscribe message - * was sent or before a SubAck message was received.
    • + *
  • completes normally with the SubAck message if all subscriptions of the Subscribe message were + * successful (the SubAck message contains no Error Codes), + *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5SubAckException + * Mqtt5SubAckException} wrapping the SubAck message if it contains at least one Error Code or + *
  • completes exceptionally with a different exception if an error occurred before the Subscribe + * message was sent or before a SubAck message was received. *
*/ @NotNull CompletableFuture<@NotNull Mqtt5SubAck> subscribe(@NotNull Mqtt5Subscribe subscribe); @@ -189,10 +189,10 @@ public interface Mqtt5AsyncClient extends Mqtt5Client { * Calling {@link Mqtt5SubscribeAndCallbackBuilder.Complete#send()} on the returned builder has the same effect as * calling one of the following methods: *
    - *
  • {@link #subscribe(Mqtt5Subscribe)} if no callback has been supplied to the builder
    • - *
  • {@link #subscribe(Mqtt5Subscribe, Consumer)} if only a callback has been supplied to the builder
    • - *
  • {@link #subscribe(Mqtt5Subscribe, Consumer, Executor)} if a callback and an executor has been supplied to - * the builder
    • + *
  • {@link #subscribe(Mqtt5Subscribe)} if no callback has been supplied to the builder + *
  • {@link #subscribe(Mqtt5Subscribe, Consumer)} if only a callback has been supplied to the builder + *
  • {@link #subscribe(Mqtt5Subscribe, Consumer, Executor)} if a callback and an executor has been supplied to + * the builder *
* * @return the fluent builder for the Subscribe message. @@ -269,12 +269,13 @@ void publishes( * @param unsubscribe the Unsubscribe message sent to the broker. * @return a {@link CompletableFuture} which *
    - *
  • completes normally with the UnsubAck message if all Topic Filters of the Unsubscribe message were - * successfully unsubscribed (the UnsubAck message contains no Error Codes),
    • - *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5UnsubAckException - * Mqtt5UnsubAckException} wrapping the UnsubAck message if it contains at least one Error Code or
    • - *
  • completes exceptionally with a different exception if an error occurred before the Unsubscribe - * message was sent or before a UnsubAck message was received.
    • + *
  • completes normally with the UnsubAck message if all Topic Filters of the Unsubscribe message were + * successfully unsubscribed (the UnsubAck message contains no Error Codes), + *
  • completes exceptionally with a + * {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5UnsubAckException Mqtt5UnsubAckException} + * wrapping the UnsubAck message if it contains at least one Error Code or + *
  • completes exceptionally with a different exception if an error occurred before the Unsubscribe + * message was sent or before a UnsubAck message was received. *
*/ @NotNull CompletableFuture<@NotNull Mqtt5UnsubAck> unsubscribe(@NotNull Mqtt5Unsubscribe unsubscribe); @@ -297,14 +298,14 @@ void publishes( * @param publish the Publish message sent to the broker. * @return a {@link CompletableFuture} which *
    - *
  • completes normally with the {@link Mqtt5PublishResult} if the Publish message was successfully - * published (no acknowledgement message contains an Error Code, {@link Mqtt5PublishResult#getError()} will - * always be absent),
    • - *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubAckException - * Mqtt5PubAckException} or {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubRecException - * Mqtt5PubRecException} wrapping the acknowledgement message if it contains an Error Code or
    • - *
  • completes exceptionally with a different exception if an error occurred before the Publish message - * was sent or before an acknowledgement message was received.
    • + *
  • completes normally with the {@link Mqtt5PublishResult} if the Publish message was successfully + * published (no acknowledgement message contains an Error Code, {@link Mqtt5PublishResult#getError()} + * will always be absent), + *
  • completes exceptionally with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubAckException + * Mqtt5PubAckException} or {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubRecException + * Mqtt5PubRecException} wrapping the acknowledgement message if it contains an Error Code or + *
  • completes exceptionally with a different exception if an error occurred before the Publish message + * was sent or before an acknowledgement message was received. *
*/ @NotNull CompletableFuture<@NotNull Mqtt5PublishResult> publish(@NotNull Mqtt5Publish publish); @@ -326,12 +327,11 @@ void publishes( * * @return a {@link CompletableFuture} which *
    - *
  • completes normally when the client was successfully re-authenticated,
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5AuthException - * Mqtt5AuthException} wrapping the Auth message with the Error Code if not re-authenticated successfully - * or
    • - *
  • errors with a different exception if an error occurred before the first Auth message was sent or - * before the last Auth message was received.
    • + *
  • completes normally when the client was successfully re-authenticated, + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5AuthException Mqtt5AuthException} + * wrapping the Auth message with the Error Code if not re-authenticated successfully or + *
  • errors with a different exception if an error occurred before the first Auth message was sent or + * before the last Auth message was received. *
*/ @NotNull CompletableFuture reauth(); @@ -350,8 +350,8 @@ void publishes( * @param disconnect the Disconnect message sent to the broker. * @return the {@link CompletableFuture} which *
    - *
  • completes when the client was successfully disconnected or
    • - *
  • errors if not disconnected gracefully.
    • + *
  • completes when the client was successfully disconnected or + *
  • errors if not disconnected gracefully. *
*/ @NotNull CompletableFuture disconnect(@NotNull Mqtt5Disconnect disconnect); diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5BlockingClient.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5BlockingClient.java index 9f7793917..ad6a0d482 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5BlockingClient.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5BlockingClient.java @@ -39,7 +39,7 @@ import java.util.concurrent.TimeUnit; /** - * Blocking API of a {@link Mqtt5Client}. + * Blocking API of an {@link Mqtt5Client}. * * @author Silvio Giebl * @since 1.0 @@ -221,9 +221,9 @@ interface Mqtt5Publishes extends AutoCloseable { /** * Receives the next incoming Publish message. *
    - *
  • Might return immediately if there is already a Publish message queued in this {@link Mqtt5Publishes} - * instance.
    • - *
  • Otherwise blocks the calling thread until a Publish message is received.
    • + *
  • Might return immediately if there is already a Publish message queued in this {@link Mqtt5Publishes} + * instance. + *
  • Otherwise blocks the calling thread until a Publish message is received. *
* * @return the received Publish message. @@ -235,10 +235,9 @@ interface Mqtt5Publishes extends AutoCloseable { /** * Receives the next incoming Publish message. *
    - *
  • Might return immediately if there is already a Publish message queued in this {@link Mqtt5Publishes} - * instance.
    • - *
  • Otherwise blocks the calling thread until a Publish message is received or the given timeout - * applies.
    • + *
  • Might return immediately if there is already a Publish message queued in this {@link Mqtt5Publishes} + * instance. + *
  • Otherwise blocks the calling thread until a Publish message is received or the given timeout applies. *
* * @param timeout the time to wait for a Publish messages to be received. diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5Client.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5Client.java index b39e24e7f..bbfbb6cc3 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5Client.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5Client.java @@ -32,7 +32,7 @@ public interface Mqtt5Client extends MqttClient { /** - * Creates a builder for a MQTT 5 client. + * Creates a builder for an MQTT 5 client. * * @return the created builder for a MQTT 5 client. */ diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientBuilder.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientBuilder.java index d9d26fda1..aab28334b 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientBuilder.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientBuilder.java @@ -30,7 +30,7 @@ import org.jetbrains.annotations.Nullable; /** - * Builder for a {@link Mqtt5Client}. + * Builder for an {@link Mqtt5Client}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientConfig.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientConfig.java index df50387eb..3839aafe5 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientConfig.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientConfig.java @@ -27,7 +27,7 @@ import java.util.Optional; /** - * Configuration of a {@link Mqtt5Client}. + * Configuration of an {@link Mqtt5Client}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientConnectionConfig.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientConnectionConfig.java index 760684717..e9080c915 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientConnectionConfig.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5ClientConnectionConfig.java @@ -25,7 +25,7 @@ import java.util.Optional; /** - * Connection configuration of a {@link Mqtt5Client}. + * Connection configuration of an {@link Mqtt5Client}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5RxClient.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5RxClient.java index 3aa7b137c..9da65ad53 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5RxClient.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5RxClient.java @@ -39,7 +39,7 @@ import org.jetbrains.annotations.NotNull; /** - * Reactive API of a {@link Mqtt5Client}. + * Reactive API of an {@link Mqtt5Client}. * * @author Silvio Giebl * @since 1.0 @@ -66,12 +66,11 @@ public interface Mqtt5RxClient extends Mqtt5Client { * @param connect the Connect message sent to the broker during connect. * @return the {@link Single} which *
    - *
  • succeeds with the ConnAck message if it does not contain an Error Code (connected - * successfully),
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5ConnAckException - * Mqtt5ConnAckException} wrapping the ConnAck message if it contains an Error Code or
    • - *
  • errors with a different exception if an error occurred before the Connect message was sent or before - * the ConnAck message was received.
    • + *
  • succeeds with the ConnAck message if it does not contain an Error Code (connected successfully), + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5ConnAckException + * Mqtt5ConnAckException} wrapping the ConnAck message if it contains an Error Code or + *
  • errors with a different exception if an error occurred before the Connect message was sent or + * before the ConnAck message was received. *
*/ @CheckReturnValue @@ -103,12 +102,12 @@ public interface Mqtt5RxClient extends Mqtt5Client { * @param subscribe the Subscribe message sent to the broker during subscribe. * @return the {@link Single} which *
    - *
  • succeeds with the SubAck message if at least one subscription of the Subscribe message was - * successful (the SubAck message contains at least one Reason Code that is not an Error Code),
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5SubAckException - * Mqtt5SubAckException} wrapping the SubAck message if it only contains Error Codes or
    • - *
  • errors with a different exception if an error occurred before the Subscribe message was sent or - * before a SubAck message was received.
    • + *
  • succeeds with the SubAck message if at least one subscription of the Subscribe message was + * successful (the SubAck message contains at least one Reason Code that is not an Error Code), + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5SubAckException + * Mqtt5SubAckException} wrapping the SubAck message if it only contains Error Codes or + *
  • errors with a different exception if an error occurred before the Subscribe message was sent or + * before a SubAck message was received. *
*/ @CheckReturnValue @@ -150,17 +149,17 @@ public interface Mqtt5RxClient extends Mqtt5Client { * @param subscribe the Subscribe message sent to the broker during subscribe. * @return the {@link FlowableWithSingle} which *
    - *
  • emits the SubAck message as the single and first element if at least one subscription of the - * Subscribe message was successful (the SubAck message contains at least one Reason Code that is not an - * Error Code) and then emits the Publish messages matching the successful subscriptions of the Subscribe - * message,
    • - *
  • completes when all subscriptions of the Subscribe message were unsubscribed,
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5SubAckException - * Mqtt5SubAckException} wrapping the SubAck message if it only contains Error Codes or
    • - *
  • errors with a different exception if an error occurred before the Subscribe message was sent, - * before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe - * message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException - * MqttSessionExpiredException}).
    • + *
  • emits the SubAck message as the single and first element if at least one subscription of the + * Subscribe message was successful (the SubAck message contains at least one Reason Code that is not an + * Error Code) and then emits the Publish messages matching the successful subscriptions of the + * Subscribe message, + *
  • completes when all subscriptions of the Subscribe message were unsubscribed, + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5SubAckException + * Mqtt5SubAckException} wrapping the SubAck message if it only contains Error Codes or + *
  • errors with a different exception if an error occurred before the Subscribe message was sent, + * before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe + * message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException + * MqttSessionExpiredException}). *
* @see #subscribePublishes(Mqtt5Subscribe, boolean) * @since 1.2 @@ -180,17 +179,17 @@ public interface Mqtt5RxClient extends Mqtt5Client { * @param manualAcknowledgement whether the Publish messages are acknowledged manually. * @return the {@link FlowableWithSingle} which *
    - *
  • emits the SubAck message as the single and first element if at least one subscription of the - * Subscribe message was successful (the SubAck message contains at least one Reason Code that is not an - * Error Code) and then emits the Publish messages matching the successful subscriptions of the Subscribe - * message,
    • - *
  • completes when all subscriptions of the Subscribe message were unsubscribed,
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5SubAckException - * Mqtt5SubAckException} wrapping the SubAck message if it only contains Error Codes or
    • - *
  • errors with a different exception if an error occurred before the Subscribe message was sent, - * before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe - * message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException - * MqttSessionExpiredException}).
    • + *
  • emits the SubAck message as the single and first element if at least one subscription of the + * Subscribe message was successful (the SubAck message contains at least one Reason Code that is not an + * Error Code) and then emits the Publish messages matching the successful subscriptions of the + * Subscribe message, + *
  • completes when all subscriptions of the Subscribe message were unsubscribed, + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5SubAckException + * Mqtt5SubAckException} wrapping the SubAck message if it only contains Error Codes or + *
  • errors with a different exception if an error occurred before the Subscribe message was sent, + * before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe + * message were unsubscribed (e.g. {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException + * MqttSessionExpiredException}). *
* @see #subscribePublishes(Mqtt5Subscribe) * @since 1.2 @@ -223,10 +222,10 @@ public interface Mqtt5RxClient extends Mqtt5Client { * @param filter the filter with which all incoming Publish messages are filtered. * @return the {@link Flowable} which *
    - *
  • emits the incoming Publish messages matching the given filter,
    • - *
  • never completes but
    • - *
  • errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException - * MqttSessionExpiredException} when the MQTT session expires.
    • + *
  • emits the incoming Publish messages matching the given filter, + *
  • never completes but + *
  • errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException + * MqttSessionExpiredException} when the MQTT session expires. *
* @see #publishes(MqttGlobalPublishFilter, boolean) */ @@ -244,10 +243,10 @@ public interface Mqtt5RxClient extends Mqtt5Client { * @param manualAcknowledgement whether the Publish messages are acknowledged manually. * @return the {@link Flowable} which *
    - *
  • emits the incoming Publish messages matching the given filter,
    • - *
  • never completes but
    • - *
  • errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException - * MqttSessionExpiredException} when the MQTT session expires.
    • + *
  • emits the incoming Publish messages matching the given filter, + *
  • never completes but + *
  • errors with a {@link com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException + * MqttSessionExpiredException} when the MQTT session expires. *
* @see #publishes(MqttGlobalPublishFilter) * @since 1.2 @@ -265,13 +264,13 @@ public interface Mqtt5RxClient extends Mqtt5Client { * @param unsubscribe the Unsubscribe message sent to the broker during unsubscribe. * @return the {@link Single} which *
    - *
  • succeeds with the UnsubAck message if at least one Topic Filter of the Unsubscribe message was - * successfully unsubscribed (the UnsubAck message contains at least one Reason Code that is not an Error - * Code),
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5UnsubAckException - * Mqtt5UnsubAckException} wrapping the UnsubAck message if it only contains Error Codes or
    • - *
  • errors with a different exception if an error occurred before the Unsubscribe message was sent or - * before a UnsubAck message was received.
    • + *
  • succeeds with the UnsubAck message if at least one Topic Filter of the Unsubscribe message was + * successfully unsubscribed (the UnsubAck message contains at least one Reason Code that is not an + * Error Code), + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5UnsubAckException + * Mqtt5UnsubAckException} wrapping the UnsubAck message if it only contains Error Codes or + *
  • errors with a different exception if an error occurred before the Unsubscribe message was sent or + * before a UnsubAck message was received. *
*/ @CheckReturnValue @@ -301,11 +300,11 @@ public interface Mqtt5RxClient extends Mqtt5Client { * @param publishFlowable the source of the Publish messages to publish. * @return the {@link Flowable} which *
    - *
  • emits {@link Mqtt5PublishResult}s each corresponding to a Publish message,
    • - *
  • completes if the given {@link Flowable} completes, but not before all {@link Mqtt5PublishResult}s - * were emitted, or
    • - *
  • errors with the same exception if the given {@link Flowable} errors, but not before all - * {@link Mqtt5PublishResult}s were emitted.
    • + *
  • emits {@link Mqtt5PublishResult}s each corresponding to a Publish message, + *
  • completes if the given {@link Flowable} completes, but not before all {@link Mqtt5PublishResult}s + * were emitted, or + *
  • errors with the same exception if the given {@link Flowable} errors, but not before all + * {@link Mqtt5PublishResult}s were emitted. *
*/ @CheckReturnValue @@ -319,12 +318,11 @@ public interface Mqtt5RxClient extends Mqtt5Client { * * @return the {@link Completable} which *
    - *
  • completes when the client was successfully re-authenticated,
    • - *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5AuthException - * Mqtt5AuthException} wrapping the Auth message with the Error Code if not re-authenticated successfully - * or
    • - *
  • errors with a different exception if an error occurred before the first Auth message was sent or - * before the last Auth message was received.
    • + *
  • completes when the client was successfully re-authenticated, + *
  • errors with a {@link com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5AuthException Mqtt5AuthException} + * wrapping the Auth message with the Error Code if not re-authenticated successfully or + *
  • errors with a different exception if an error occurred before the first Auth message was sent or + * before the last Auth message was received. *
*/ @CheckReturnValue @@ -348,8 +346,8 @@ public interface Mqtt5RxClient extends Mqtt5Client { * @param disconnect the Disconnect message sent to the broker during disconnect. * @return the {@link Completable} which *
    - *
  • completes when the client was successfully disconnected or
    • - *
  • errors if not disconnected gracefully.
    • + *
  • completes when the client was successfully disconnected or + *
  • errors if not disconnected gracefully. *
*/ @CheckReturnValue diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/advanced/Mqtt5ClientAdvancedConfig.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/advanced/Mqtt5ClientAdvancedConfig.java index 7d5efcbbe..6e6260ddb 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/advanced/Mqtt5ClientAdvancedConfig.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/advanced/Mqtt5ClientAdvancedConfig.java @@ -23,7 +23,7 @@ import org.jetbrains.annotations.Nullable; /** - * Advanced configuration of a {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client Mqtt5Client}. + * Advanced configuration of an {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client Mqtt5Client}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/advanced/interceptor/Mqtt5ClientInterceptors.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/advanced/interceptor/Mqtt5ClientInterceptors.java index c2d67f12d..05d748b2d 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/advanced/interceptor/Mqtt5ClientInterceptors.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/advanced/interceptor/Mqtt5ClientInterceptors.java @@ -26,7 +26,7 @@ import org.jetbrains.annotations.Nullable; /** - * Collection of interceptors of MQTT messages received or sent by a {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client + * Collection of interceptors of MQTT messages received or sent by an {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client * MQTT5Client}. * * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/auth/Mqtt5EnhancedAuthMechanism.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/auth/Mqtt5EnhancedAuthMechanism.java index dd47e877f..d8fc531b4 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/auth/Mqtt5EnhancedAuthMechanism.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/auth/Mqtt5EnhancedAuthMechanism.java @@ -36,20 +36,18 @@ *

* The enhanced auth has two life cycles: *

    - *
  • Auth when connecting: - *
      - *
    1. {@link #onAuth}
      2. - *
    2. ({@link #onContinue})*
      3. - *
    3. ({@link #onAuthSuccess} | {@link - * #onAuthRejected} | {@link #onAuthError})
      4. - *
    - *
    • - *
  • Reauth when connected: - *
      - *
    1. ({@link #onReAuth} | {@link #onServerReAuth})
      2. - *
    2. ({@link #onContinue})*
      3. - *
    3. ({@link #onReAuthSuccess} | {@link #onReAuthRejected} | {@link #onReAuthError})
      4. - *
    + *
  • Auth when connecting: + *
      + *
    1. {@link #onAuth} + *
    2. ({@link #onContinue})* + *
    3. ({@link #onAuthSuccess} | {@link #onAuthRejected} | {@link #onAuthError}) + *
    + *
  • Reauth when connected: + *
      + *
    1. ({@link #onReAuth} | {@link #onServerReAuth}) + *
    2. ({@link #onContinue})* + *
    3. ({@link #onReAuthSuccess} | {@link #onReAuthRejected} | {@link #onReAuthError}) + *
    *
* * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientConnectedContext.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientConnectedContext.java index 11b095c48..cb27d8dfc 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientConnectedContext.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientConnectedContext.java @@ -24,7 +24,7 @@ import org.jetbrains.annotations.NotNull; /** - * A {@link MqttClientConnectedContext} with methods specific to a {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client + * A {@link MqttClientConnectedContext} with methods specific to an {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client * Mqtt5Client}. * * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientDisconnectedContext.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientDisconnectedContext.java index 5c33505d9..ff48ccbc4 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientDisconnectedContext.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientDisconnectedContext.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * A {@link MqttClientDisconnectedContext} with methods specific to a {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client + * A {@link MqttClientDisconnectedContext} with methods specific to an {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client * Mqtt5Client}. * * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientReconnector.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientReconnector.java index efa19754b..48ca76082 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientReconnector.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/lifecycle/Mqtt5ClientReconnector.java @@ -31,7 +31,7 @@ import java.util.function.BiConsumer; /** - * A {@link MqttClientReconnector} with methods specific to a {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client + * A {@link MqttClientReconnector} with methods specific to an {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client * Mqtt5Client}. * * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5Auth.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5Auth.java index 1516bee54..90cd0623a 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5Auth.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5Auth.java @@ -26,7 +26,7 @@ import java.util.Optional; /** - * MQTT 5 Auth message. This message is translated from and to a MQTT 5 AUTH packet. + * MQTT 5 Auth message. This message is translated from and to an MQTT 5 AUTH packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5AuthReasonCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5AuthReasonCode.java index 6a4721879..f0ac07583 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5AuthReasonCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5AuthReasonCode.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.Nullable; /** - * Reason Code of a {@link Mqtt5Auth MQTT 5 Auth message}. + * Reason Code of an {@link Mqtt5Auth MQTT 5 Auth message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5SimpleAuth.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5SimpleAuth.java index 40fc696c3..3f5fbe6d8 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5SimpleAuth.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/auth/Mqtt5SimpleAuth.java @@ -25,7 +25,7 @@ import java.util.Optional; /** - * Simple authentication and/or authorization related data in the {@link com.hivemq.client.mqtt.mqtt5.message.connect.Mqtt5Connect + * Simple authentication and/or authorization related data in an {@link com.hivemq.client.mqtt.mqtt5.message.connect.Mqtt5Connect * MQTT 5 Connect message}. * * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/Mqtt5Connect.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/Mqtt5Connect.java index 76eeb362e..d1572f2d8 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/Mqtt5Connect.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/Mqtt5Connect.java @@ -30,7 +30,7 @@ import java.util.Optional; /** - * MQTT 5 Connect message. This message is translated from and to a MQTT 5 CONNECT packet. + * MQTT 5 Connect message. This message is translated from and to an MQTT 5 CONNECT packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/Mqtt5ConnectRestrictions.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/Mqtt5ConnectRestrictions.java index 9b4e5ea43..761cd85d3 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/Mqtt5ConnectRestrictions.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/Mqtt5ConnectRestrictions.java @@ -23,19 +23,20 @@ import org.jetbrains.annotations.NotNull; /** - * Restrictions set by the client in a {@link Mqtt5Connect MQTT 5 Connect message}. + * Restrictions set by the client in an {@link Mqtt5Connect MQTT 5 Connect message}. *

* These restrictions consist of: *

    - *
  • Restrictions for the server. + *
  • Restrictions for the server. *

    - * These are used to form the {@link com.hivemq.client.mqtt.mqtt5.Mqtt5ClientConnectionConfig.RestrictionsForServer - * Mqtt5ClientConnectionConfig.RestrictionsForServer}

    • - *
  • Restrictions for the client set by the client itself. + * These are used to form the {@link com.hivemq.client.mqtt.mqtt5.Mqtt5ClientConnectionConfig.RestrictionsForServer + * Mqtt5ClientConnectionConfig.RestrictionsForServer} + *
  • Restrictions for the client set by the client itself. *

    - * These restrictions are used in conjunction with the {@link com.hivemq.client.mqtt.mqtt5.message.connect.connack.Mqtt5ConnAckRestrictions - * Mqtt5ConnAckRestrictions} to form the {@link com.hivemq.client.mqtt.mqtt5.Mqtt5ClientConnectionConfig.RestrictionsForClient - * Mqtt5ClientConnectionConfig.RestrictionsForClient}.

    • + * These restrictions are used in conjunction with the + * {@link com.hivemq.client.mqtt.mqtt5.message.connect.connack.Mqtt5ConnAckRestrictions Mqtt5ConnAckRestrictions} + * to form the {@link com.hivemq.client.mqtt.mqtt5.Mqtt5ClientConnectionConfig.RestrictionsForClient + * Mqtt5ClientConnectionConfig.RestrictionsForClient}. *
* * @author Silvio Giebl diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAck.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAck.java index e47c1febe..af537b401 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAck.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAck.java @@ -30,7 +30,7 @@ import java.util.OptionalLong; /** - * MQTT 5 ConnAck packet. This message is translated from and to a MQTT 5 CONNACK packet. + * MQTT 5 ConnAck packet. This message is translated from and to an MQTT 5 CONNACK packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAckReasonCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAckReasonCode.java index 620bd66fe..6cd4981d0 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAckReasonCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAckReasonCode.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.Nullable; /** - * Reason Code of a {@link Mqtt5ConnAck MQTT 5 ConnAck message}. + * Reason Code of an {@link Mqtt5ConnAck MQTT 5 ConnAck message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAckRestrictions.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAckRestrictions.java index c9ba7ce4a..75ecb85e9 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAckRestrictions.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/connect/connack/Mqtt5ConnAckRestrictions.java @@ -23,7 +23,7 @@ import org.jetbrains.annotations.NotNull; /** - * Restrictions for the client set by the server in a {@link Mqtt5ConnAck MQTT 5 ConnAck message}. + * Restrictions for the client set by the server in an {@link Mqtt5ConnAck MQTT 5 ConnAck message}. *

* These restrictions are used in conjunction with the {@link com.hivemq.client.mqtt.mqtt5.message.connect.Mqtt5ConnectRestrictions * Mqtt5ConnectRestrictions} to form the {@link com.hivemq.client.mqtt.mqtt5.Mqtt5ClientConnectionConfig.RestrictionsForClient diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/disconnect/Mqtt5Disconnect.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/disconnect/Mqtt5Disconnect.java index c6613204e..6afc5a82f 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/disconnect/Mqtt5Disconnect.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/disconnect/Mqtt5Disconnect.java @@ -28,7 +28,7 @@ import java.util.OptionalLong; /** - * MQTT 5 Disconnect message. This message is translated from and to a MQTT 5 DISCONNECT packet. + * MQTT 5 Disconnect message. This message is translated from and to an MQTT 5 DISCONNECT packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/disconnect/Mqtt5DisconnectReasonCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/disconnect/Mqtt5DisconnectReasonCode.java index 84b49950b..b0953ae59 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/disconnect/Mqtt5DisconnectReasonCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/disconnect/Mqtt5DisconnectReasonCode.java @@ -24,7 +24,7 @@ import java.util.EnumSet; /** - * Reason Code of {@link Mqtt5Disconnect MQTT 5 Disconnect message}. + * Reason Code of an {@link Mqtt5Disconnect MQTT 5 Disconnect message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/ping/Mqtt5PingReq.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/ping/Mqtt5PingReq.java index d4c70cd58..5c3055963 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/ping/Mqtt5PingReq.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/ping/Mqtt5PingReq.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 5 PingReq message. This message is translated from and to a MQTT 5 PINGREQ packet. + * MQTT 5 PingReq message. This message is translated from and to an MQTT 5 PINGREQ packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/ping/Mqtt5PingResp.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/ping/Mqtt5PingResp.java index 117ed5d3a..b578e53c3 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/ping/Mqtt5PingResp.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/ping/Mqtt5PingResp.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 5 PingResp message. This message is translated from and to a MQTT 5 PINGRESP packet. + * MQTT 5 PingResp message. This message is translated from and to an MQTT 5 PINGRESP packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5Publish.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5Publish.java index b11027beb..a7e10aa95 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5Publish.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5Publish.java @@ -31,7 +31,7 @@ import java.util.OptionalLong; /** - * MQTT 5 Publish message. This message is translated from and to a MQTT 5 PUBLISH packet. + * MQTT 5 Publish message. This message is translated from and to an MQTT 5 PUBLISH packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5PublishResult.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5PublishResult.java index f9e949591..92d275e39 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5PublishResult.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5PublishResult.java @@ -26,7 +26,7 @@ import java.util.Optional; /** - * Result for a {@link Mqtt5Publish MQTT 5 Publish message} sent by the client. + * Result for an {@link Mqtt5Publish MQTT 5 Publish message} sent by the client. *

* The result is provided if a Publish message is successfully delivered (sent or acknowledged respectively to its * {@link com.hivemq.client.mqtt.datatypes.MqttQos QoS} level). diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5WillPublish.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5WillPublish.java index 5c2044c39..4eb8ca7f3 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5WillPublish.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/Mqtt5WillPublish.java @@ -21,8 +21,8 @@ import org.jetbrains.annotations.NotNull; /** - * MQTT 5 Will Publish which can be a part of a {@link com.hivemq.client.mqtt.mqtt5.message.connect.Mqtt5Connect Connect - * message}. + * MQTT 5 Will Publish which can be a part of an {@link com.hivemq.client.mqtt.mqtt5.message.connect.Mqtt5Connect MQTT 5 + * Connect message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/puback/Mqtt5PubAck.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/puback/Mqtt5PubAck.java index e249d16b4..2227ad0af 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/puback/Mqtt5PubAck.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/puback/Mqtt5PubAck.java @@ -26,7 +26,7 @@ import java.util.Optional; /** - * MQTT 5 PubAck message. This message is translated from and to a MQTT 5 PUBACK packet. + * MQTT 5 PubAck message. This message is translated from and to an MQTT 5 PUBACK packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/puback/Mqtt5PubAckReasonCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/puback/Mqtt5PubAckReasonCode.java index 41edf2bf8..ddfa2cc7e 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/puback/Mqtt5PubAckReasonCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/puback/Mqtt5PubAckReasonCode.java @@ -24,7 +24,7 @@ import java.util.EnumSet; /** - * Reason Code of a {@link Mqtt5PubAck MQTT 5 PubAck message}. + * Reason Code of an {@link Mqtt5PubAck MQTT 5 PubAck message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubcomp/Mqtt5PubComp.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubcomp/Mqtt5PubComp.java index 03135342f..1cef4f907 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubcomp/Mqtt5PubComp.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubcomp/Mqtt5PubComp.java @@ -26,7 +26,7 @@ import java.util.Optional; /** - * MQTT 5 PubComp message. This message is translated from and to a MQTT 5 PUBCOMP packet. + * MQTT 5 PubComp message. This message is translated from and to an MQTT 5 PUBCOMP packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubcomp/Mqtt5PubCompReasonCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubcomp/Mqtt5PubCompReasonCode.java index 42ba6177f..276997e8a 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubcomp/Mqtt5PubCompReasonCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubcomp/Mqtt5PubCompReasonCode.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.Nullable; /** - * Reason Code of a {@link Mqtt5PubComp MQTT 5 PubComp message}. + * Reason Code of an {@link Mqtt5PubComp MQTT 5 PubComp message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrec/Mqtt5PubRec.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrec/Mqtt5PubRec.java index f1aa39219..8e2aa05a7 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrec/Mqtt5PubRec.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrec/Mqtt5PubRec.java @@ -26,7 +26,7 @@ import java.util.Optional; /** - * MQTT 5 PubRec message. This message is translated from and to a MQTT 5 PUBREC packet. + * MQTT 5 PubRec message. This message is translated from and to an MQTT 5 PUBREC packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrec/Mqtt5PubRecReasonCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrec/Mqtt5PubRecReasonCode.java index 49b0a72b1..c4c3d5e6c 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrec/Mqtt5PubRecReasonCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrec/Mqtt5PubRecReasonCode.java @@ -24,7 +24,7 @@ import java.util.EnumSet; /** - * Reason Code of a {@link Mqtt5PubRec MQTT 5 PubRec message}. + * Reason Code of an {@link Mqtt5PubRec MQTT 5 PubRec message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrel/Mqtt5PubRel.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrel/Mqtt5PubRel.java index 1ca28acbb..7d84c6d27 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrel/Mqtt5PubRel.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrel/Mqtt5PubRel.java @@ -26,7 +26,7 @@ import java.util.Optional; /** - * MQTT 5 PubRel message. This message is translated from and to a MQTT 5 PUBREL packet. + * MQTT 5 PubRel message. This message is translated from and to an MQTT 5 PUBREL packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrel/Mqtt5PubRelReasonCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrel/Mqtt5PubRelReasonCode.java index 26d50032d..2db5a1d6a 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrel/Mqtt5PubRelReasonCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/publish/pubrel/Mqtt5PubRelReasonCode.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.Nullable; /** - * Reason Code of a {@link Mqtt5PubRel MQTT 5 PubRel message}. + * Reason Code of an {@link Mqtt5PubRel MQTT 5 PubRel message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/Mqtt5Subscribe.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/Mqtt5Subscribe.java index 1c3239ea4..c3ff6ac4d 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/Mqtt5Subscribe.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/Mqtt5Subscribe.java @@ -27,7 +27,7 @@ import java.util.List; /** - * MQTT 5 Subscribe message. This message is translated from and to a MQTT 5 SUBSCRIBE packet. + * MQTT 5 Subscribe message. This message is translated from and to an MQTT 5 SUBSCRIBE packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/Mqtt5Subscription.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/Mqtt5Subscription.java index cf70cda6e..88e7e4a8e 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/Mqtt5Subscription.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/Mqtt5Subscription.java @@ -23,7 +23,7 @@ import org.jetbrains.annotations.NotNull; /** - * Subscription in a {@link Mqtt5Subscribe MQTT 5 Subscribe message}. + * Subscription in an {@link Mqtt5Subscribe MQTT 5 Subscribe message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/suback/Mqtt5SubAck.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/suback/Mqtt5SubAck.java index 4b85359ce..55b8d8de0 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/suback/Mqtt5SubAck.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/suback/Mqtt5SubAck.java @@ -28,7 +28,7 @@ import java.util.Optional; /** - * MQTT 5 SubAck message. This message is translated from and to a MQTT 5 SUBACK packet. + * MQTT 5 SubAck message. This message is translated from and to an MQTT 5 SUBACK packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/suback/Mqtt5SubAckReasonCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/suback/Mqtt5SubAckReasonCode.java index f54d5c6f7..334c63a03 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/suback/Mqtt5SubAckReasonCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/subscribe/suback/Mqtt5SubAckReasonCode.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.Nullable; /** - * Reason Code of a {@link Mqtt5SubAck MQTT 5 SubAck message}. + * Reason Code of an {@link Mqtt5SubAck MQTT 5 SubAck message}. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/Mqtt5Unsubscribe.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/Mqtt5Unsubscribe.java index d82bc6e55..50fbd38b9 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/Mqtt5Unsubscribe.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/Mqtt5Unsubscribe.java @@ -28,7 +28,7 @@ import java.util.List; /** - * MQTT 5 Unsubscribe message. This message is translated from and to a MQTT 5 UNSUBSCRIBE packet. + * MQTT 5 Unsubscribe message. This message is translated from and to an MQTT 5 UNSUBSCRIBE packet. * * @author Silvio Giebl * @since 1.0 @@ -37,7 +37,7 @@ public interface Mqtt5Unsubscribe extends Mqtt5Message { /** - * Creates a builder for a Unsubscribe message. + * Creates a builder for an Unsubscribe message. * * @return the created builder. */ diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/unsuback/Mqtt5UnsubAck.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/unsuback/Mqtt5UnsubAck.java index 21cee7a05..7c442bfed 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/unsuback/Mqtt5UnsubAck.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/unsuback/Mqtt5UnsubAck.java @@ -28,7 +28,7 @@ import java.util.Optional; /** - * MQTT 5 UnsubAck message. This message is translated from and to a MQTT 5 UNSUBACK packet. + * MQTT 5 UnsubAck message. This message is translated from and to an MQTT 5 UNSUBACK packet. * * @author Silvio Giebl * @since 1.0 diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/unsuback/Mqtt5UnsubAckReasonCode.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/unsuback/Mqtt5UnsubAckReasonCode.java index 9c00b376a..94f5e858c 100644 --- a/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/unsuback/Mqtt5UnsubAckReasonCode.java +++ b/src/main/java/com/hivemq/client/mqtt/mqtt5/message/unsubscribe/unsuback/Mqtt5UnsubAckReasonCode.java @@ -22,7 +22,7 @@ import org.jetbrains.annotations.Nullable; /** - * Reason Code of a {@link Mqtt5UnsubAck MQTT 5 UnsubAck message}. + * Reason Code of an {@link Mqtt5UnsubAck MQTT 5 UnsubAck message}. * * @author Silvio Giebl * @since 1.0 From 877250a1bfc6b63658e236caf6999f4eae3805c1 Mon Sep 17 00:00:00 2001 From: Silvio Giebl Date: Fri, 17 Apr 2020 21:38:04 +0200 Subject: [PATCH 2/3] Fixed javadoc character escaping --- src/main/java/com/hivemq/client/mqtt/MqttClientState.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/com/hivemq/client/mqtt/MqttClientState.java b/src/main/java/com/hivemq/client/mqtt/MqttClientState.java index 604b35fde..4413c4d39 100644 --- a/src/main/java/com/hivemq/client/mqtt/MqttClientState.java +++ b/src/main/java/com/hivemq/client/mqtt/MqttClientState.java @@ -24,7 +24,7 @@ * State of an {@link MqttClient}. * 

  * +--------------+             +------------------------+
- * | DISCONNECTED <-+         +-> DISCONNECTED_RECONNECT |
+ * | DISCONNECTED <-+         +-> DISCONNECTED_RECONNECT |
  * +-------+------+  \       /  +-----------+------------+
  *         |          \     /               |
  *         |           \   /                |
@@ -34,7 +34,7 @@
  *         |             |                  |
  *         |             |                  |
  *         |      +------+------+           |
- *         +------>  CONNECTED  <-----------+
+ *         +------>  CONNECTED  <-----------+
  *                +-------------+
  *
* From c7e9900f95620a7cfab8125615d1810e7625c73c Mon Sep 17 00:00:00 2001 From: Silvio Giebl Date: Sat, 18 Apr 2020 22:42:57 +0200 Subject: [PATCH 3/3] Small javadoc improvements --- .../hivemq/client/mqtt/lifecycle/MqttClientReconnector.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientReconnector.java b/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientReconnector.java index df9a7d1ed..898c9840e 100644 --- a/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientReconnector.java +++ b/src/main/java/com/hivemq/client/mqtt/lifecycle/MqttClientReconnector.java @@ -49,7 +49,7 @@ public interface MqttClientReconnector { */ boolean DEFAULT_RECONNECT = false; /** - * If resubscribe when the session expired before the client reconnected successfully is enabled by defaultt. + * If resubscribe when the session expired before the client reconnected successfully is enabled by default. * * @since 1.2 */ @@ -132,7 +132,7 @@ public interface MqttClientReconnector { /** * Instructs the client to queue pending Publish messages and automatically publish them even if the session expired - * before reconnected. + * before reconnected successfully. *

* When the client reconnected successfully and its session is still present, the client will always queue pending * Publish messages and automatically publish them to ensure the QoS guarantees.