Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for Mqtt5BlockingClient #637

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update docs for Mqtt5BlockingClient #637

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions src/main/java/com/hivemq/client/mqtt/mqtt5/Mqtt5BlockingClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down Expand Up @@ -153,10 +160,20 @@ 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 for QoS 1 if the PubAck message contained
* an error code (the PubAck message is
* contained in the exception)
* @throws com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5PubRecException for QoS 2 if the PubRec message contained
* an error code (the PubRec message is
* contained in the exception)
* @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);

Expand Down