org.eclipse.paho.mqttv5.client.MqttClientException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.paho.mqttv5.client
The newest version!
package org.eclipse.paho.mqttv5.client;

import org.eclipse.paho.mqttv5.common.MqttException;
import org.eclipse.paho.mqttv5.common.MqttMessage;

public class MqttClientException {

	/**
	 * The Server sent a publish message with an invalid topic alias.
	 */
	public static final short REASON_CODE_INVALID_TOPIC_ALAS = 32301;

	/**
	 * The Server sent a publish message with an unknown topic alias and no topic
	 * string.
	 */
	public static final short REASON_CODE_UNKNOWN_TOPIC_ALIAS = 32302;

	/**
	 * Client timed out while waiting for a response from the server. The server is
	 * no longer responding to keep-alive messages.
	 */
	public static final short REASON_CODE_CLIENT_TIMEOUT = 32000;

	/**
	 * Internal error, caused by no new message IDs being available.
	 */
	public static final short REASON_CODE_NO_MESSAGE_IDS_AVAILABLE = 32001;

	/**
	 * Client timed out while waiting to write messages to the server.
	 */
	public static final short REASON_CODE_WRITE_TIMEOUT = 32002;

	/**
	 * The client is already connected.
	 */
	public static final short REASON_CODE_CLIENT_CONNECTED = 32100;

	/**
	 * The client is already disconnected.
	 */
	public static final short REASON_CODE_CLIENT_ALREADY_DISCONNECTED = 32101;
	/**
	 * The client is currently disconnecting and cannot accept any new work. This
	 * can occur when waiting on a token, and then disconnecting the client. If the
	 * message delivery does not complete within the quiesce timeout period, then
	 * the waiting token will be notified with an exception.
	 */
	public static final short REASON_CODE_CLIENT_DISCONNECTING = 32102;

	/** Unable to connect to server */
	public static final short REASON_CODE_SERVER_CONNECT_ERROR = 32103;

	/**
	 * The client is not connected to the server. The {@link IMqttClient#connect()}
	 * or {@link IMqttClient#connect(MqttConnectionOptions)} method must be called
	 * first. It is also possible that the connection was lost - see
	 * {@link IMqttClient#setCallback(MqttCallback)} for a way to track lost
	 * connections.
	 */
	public static final short REASON_CODE_CLIENT_NOT_CONNECTED = 32104;

	/**
	 * Server URI and supplied SocketFactory do not match. URIs
	 * beginning tcp:// must use a
	 * javax.net.SocketFactory, and URIs beginning ssl://
	 * must use a javax.net.ssl.SSLSocketFactory.
	 */
	public static final short REASON_CODE_SOCKET_FACTORY_MISMATCH = 32105;

	/**
	 * SSL configuration error.
	 */
	public static final short REASON_CODE_SSL_CONFIG_ERROR = 32106;

	/**
	 * Thrown when an attempt to call {@link IMqttClient#disconnect()} has been made
	 * from within a method on {@link MqttCallback}. These methods are invoked by
	 * the client's thread, and must not be used to control disconnection.
	 * 
	 * @see MqttCallback#messageArrived(String, MqttMessage)
	 */
	public static final short REASON_CODE_CLIENT_DISCONNECT_PROHIBITED = 32107;

	/**
	 * Protocol error: the message was not recognized as a valid MQTT packet.
	 * Possible reasons for this include connecting to a non-MQTT server, or
	 * connecting to an SSL server port when the client isn't using SSL.
	 */
	public static final short REASON_CODE_INVALID_MESSAGE = 32108;

	/**
	 * The client has been unexpectedly disconnected from the server. The
	 * {@link MqttException#getCause() cause} will provide more details.
	 */
	public static final short REASON_CODE_CONNECTION_LOST = 32109;

	/**
	 * A connect operation in already in progress, only one connect can happen at a
	 * time.
	 */
	public static final short REASON_CODE_CONNECT_IN_PROGRESS = 32110;

	/**
	 * The client is closed - no operations are permitted on the client in this
	 * state. New up a new client to continue.
	 */
	public static final short REASON_CODE_CLIENT_CLOSED = 32111;

	/**
	 * A request has been made to use a token that is already associated with
	 * another action. If the action is complete the reset() can ve called on the
	 * token to allow it to be reused.
	 */
	public static final short REASON_CODE_TOKEN_INUSE = 32201;

	/**
	 * A request has been made to send a message but the maximum number of inflight
	 * messages has already been reached. Once one or more messages have been moved
	 * then new messages can be sent.
	 */
	public static final short REASON_CODE_MAX_INFLIGHT = 32202;

	/**
	 * The Client has attempted to publish a message whilst in the 'resting' /
	 * offline state with Disconnected Publishing enabled, however the buffer is
	 * full and deleteOldestMessages is disabled, therefore no more messages can be
	 * published until the client reconnects, or the application deletes buffered
	 * message manually.
	 */
	public static final short REASON_CODE_DISCONNECTED_BUFFER_FULL = 32203;

	public static final short REASON_CODE_SERVER_DISCONNECTED = 32204;

	/**
	 * The server has been sent an MQTT packet that was larger than the client
	 * defined value.
	 */
	public static final int REASON_CODE_INCOMING_PACKET_TOO_LARGE = 51001;
	public static final int REASON_CODE_OUTGOING_PACKET_TOO_LARGE = 51002;

	// CONNACK return codes
	/** The protocol version requested is not supported by the server. */
	public static final short REASON_CODE_INVALID_PROTOCOL_VERSION = 0x01;
	/** The server has rejected the supplied client ID */
	public static final short REASON_CODE_INVALID_CLIENT_ID = 0x02;
	/** The broker was not available to handle the request. */
	public static final short REASON_CODE_BROKER_UNAVAILABLE = 0x03;
	/**
	 * Authentication with the server has failed, due to a bad user name or
	 * password.
	 */
	public static final short REASON_CODE_FAILED_AUTHENTICATION = 0x04;
	/** Not authorized to perform the requested operation */
	public static final short REASON_CODE_NOT_AUTHORIZED = 0x05;

	/** An unexpected error has occurred. */
	public static final short REASON_CODE_UNEXPECTED_ERROR = 0x06;

	/** Error from subscribe - returned from the server. */
	public static final short REASON_CODE_SUBSCRIBE_FAILED = 0x80;

}