Update docs for Mqtt5BlockingClient

hivemq · Aug 12, 2024 · 9f29dbc · 9f29dbc
1 parent bb5dee5
commit 9f29dbc
Showing 1 changed file with 19 additions and 4 deletions.
diff --git a/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5BlockingClient.java b/src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5BlockingClient.java
@@ -60,8 +60,15 @@ public interface Mqtt5BlockingClient extends Mqtt5Client {
      *
      * @param connect the Connect message sent to the broker.
      * @return the ConnAck message if it does not contain an Error Code (connected successfully).
+     * @throws com.hivemq.client.mqtt.exceptions.ConnectionFailedException   if an error occurs before the Connect
+     *                                                                       message could be sent.
+     * @throws com.hivemq.client.mqtt.exceptions.ConnectionClosedException   if the connection is closed after the
+     *                                                                       Connect message has been sent but before a
+     *                                                                       ConnAck message has been received
      * @throws com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5ConnAckException wrapping the ConnAck message if it contains
      *                                                                       an Error Code.
+     * @throws com.hivemq.client.mqtt.exceptions.MqttClientStateException    if the client is already connecting or
+     *                                                                       connected
      */
     @NotNull Mqtt5ConnAck connect(@NotNull Mqtt5Connect connect);
 
@@ -153,10 +160,18 @@ public interface Mqtt5BlockingClient extends Mqtt5Client {
      * @param publish the Publish message sent to the broker.
      * @return the {@link Mqtt5PublishResult} if the Publish message was successfully published (no acknowledgement
      *         message contains an Error Code, {@link Mqtt5PublishResult#getError()} will always be absent).
-     * @throws com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubAckException wrapping the corresponding PubAck message if
-     *                                                                      it contains an Error Code.
-     * @throws com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubRecException wrapping the corresponding PubRec message if
-     *                                                                      it contains an Error Code.
+     * @throws com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubAckException  wrapping the corresponding PubAck message
+     *                                                                       if it contains an Error Code.
+     * @throws com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubRecException  wrapping the corresponding PubRec message
+     *                                                                       if it contains an Error Code.
+     * @throws com.hivemq.client.mqtt.exceptions.ConnectionClosedException   for QoS 0 if the connection was closed
+     *                                                                       during writing the message to the
+     *                                                                       transport
+     * @throws com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException if the session expired before the message
+     *                                                                       has been acknowledged completely
+     * @throws com.hivemq.client.mqtt.exceptions.MqttEncodeException         if the maximum packet size was exceeded
+     * @throws com.hivemq.client.mqtt.exceptions.MqttClientStateException    if the client is not connected and also not
+     *                                                                       reconnecting
      */
     @NotNull Mqtt5PublishResult publish(@NotNull Mqtt5Publish publish);