com.esf.net.mqtt.client.service

Interface IEsfMqttCloudClient

All Superinterfaces:

IEsfMqttClient

public interface IEsfMqttCloudClient
extends IEsfMqttClient

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERVICE_NAME Reports the class name representing this interface.

Method Summary

Methods

Modifier and Type	Method and Description
int	controlSubscribe(java.lang.String assetId, java.lang.String topic, int qos) Subscribes to a control topic with the MQtt broker.
void	disableConnectionLostTimeout() Disables the connection lost timeout option.
void	enableConnectionLostTimeout(long timeout) Enables the connection lost timeout option within the client.
java.lang.String	getAssetId() Returns the Asset ID of the device
int	publish(java.lang.String assetId, java.lang.String semanticTopic, byte[] payload, int qos, boolean retain) Publishes a message to the MQtt broker.
int	subscribe(java.lang.String assetId, com.eurotech.cloud.message.EdcSubscription subscription) Subscribes to a topic with the MQtt broker.
int	subscribe(java.lang.String assetId, com.eurotech.cloud.message.EdcSubscription[] subscriptions) Subscribes to one or more topics with the MQtt broker.
int	subscribe(java.lang.String assetId, java.lang.String topic, int qos) Subscribes to a topic with the MQtt broker.
int	unsubscribe(java.lang.String assetId, com.eurotech.cloud.message.EdcSubscription subscription) Unsubscribes from a topic with the MQtt broker.
int	unsubscribe(java.lang.String assetId, java.lang.String topic) Unsubscribes from a topic with the MQtt broker.

Methods inherited from interface com.esf.net.mqtt.client.service.IEsfMqttClient

getClientId, getPassword, getSubscriptions, getUsername, getWillMessage, getWillQos, getWillTopic, isConnected, publish, registerCallback, setBrokerUrl, setCleanStart, setClientId, setKeepAlive, setPassword, setUsername, startSession, subscribe, subscribe, subscribe, terminateSession, unsubscribe, unsubscribe

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Reports the class name representing this interface.

Method Detail

publish

int publish(java.lang.String assetId,
          java.lang.String semanticTopic,
          byte[] payload,
          int qos,
          boolean retain)
            throws EsfMqttException

Publishes a message to the MQtt broker.

Parameters:

assetId - A String specifying the asset ID.

semanticTopic - A String specifying the semantic topic the message was published on.

payload - An array of bytes containing the payload of the message.

qos - An integer specifying the quality of service the message was published on.

retain - Whether or not the broker should retain the message

Returns:

The published message's ID.

Throws:

EsfMqttException

subscribe

int subscribe(java.lang.String assetId,
            com.eurotech.cloud.message.EdcSubscription[] subscriptions)
              throws EsfMqttException

Subscribes to one or more topics with the MQtt broker. The topics are specified as an array of EdcSubscription objects. If the subscribe fails, an exception will be thrown that will contain information about the cause of the failure.

Parameters:

assetId - A String specifying the asset ID.

subscriptions - An array of EdcSubscription objects.

Returns:

The subscribe message's ID.

Throws:

EsfMqttException

subscribe

int subscribe(java.lang.String assetId,
            com.eurotech.cloud.message.EdcSubscription subscription)
              throws EsfMqttException

Subscribes to a topic with the MQtt broker. The topic and QoS are specified in an EdcSubscription object. If the subscribe fails, an exception will be thrown that will contain information about the cause of the failure.

Parameters:

assetId - A String specifying the asset ID.

subscription - An EdcSubscription object.

Returns:

The subscribe message's ID.

Throws:

EsfMqttException

subscribe

int subscribe(java.lang.String assetId,
            java.lang.String topic,
            int qos)
              throws EsfMqttException

Subscribes to a topic with the MQtt broker. The topic is specified as a String object and the QoS is specified as an interger. If the subscribe fails, an exception will be thrown that will contain information about the cause of the failure.

Parameters:

assetId - A String specifying the asset ID.

topic - A String object containing the topic.

qos - An int containing the Quality of Service.

Returns:

The subscribe message's ID.

Throws:

EsfMqttException

controlSubscribe

int controlSubscribe(java.lang.String assetId,
                   java.lang.String topic,
                   int qos)
                     throws EsfMqttException

Subscribes to a control topic with the MQtt broker. The topic is specified as a String object and the QoS is specified as an interger. If the subscribe fails, an exception will be thrown that will contain information about the cause of the failure.

Parameters:

assetId - A String specifying the asset ID.

topic - A String object containing the topic.

qos - An int containing the Quality of Service.

Returns:

The subscribe message's ID.

Throws:

EsfMqttException

unsubscribe

int unsubscribe(java.lang.String assetId,
              com.eurotech.cloud.message.EdcSubscription subscription)
                throws EsfMqttException

Unsubscribes from a topic with the MQtt broker. An EdcSubscription topic is specified that contains the topic in which to unsubscribe from. If the unsubscribe fails, an exception will be thrown that will contain information about the cause of the failure.

Parameters:

assetId - A String specifying the asset ID.

subscription - A EdcSubscription object containing the topic.

Returns:

The unsubscribe message's ID.

Throws:

EsfMqttException

unsubscribe

int unsubscribe(java.lang.String assetId,
              java.lang.String topic)
                throws EsfMqttException

Unsubscribes from a topic with the MQtt broker. A String object is specified which contains the topic in which to unsubscribe from. If the unsubscribe fails, an exception will be thrown that will contain information about the cause of the failure.

Parameters:

assetId - A String specifying the asset ID.

topic - A String object containing the topic.

Returns:

The unsubscribe message's ID.

Throws:

EsfMqttException

enableConnectionLostTimeout

void enableConnectionLostTimeout(long timeout)

Enables the connection lost timeout option within the client. When a connection with the broker is lost, a thread will start that will reboot the unit if the connection is not restablished within the specified timeout (in seconds).

Parameters:

timeout - The number of seconds the unit can be disconnected before rebooting.

disableConnectionLostTimeout

void disableConnectionLostTimeout()

Disables the connection lost timeout option.

getAssetId

java.lang.String getAssetId()
                            throws EsfMqttException

Returns the Asset ID of the device

Returns:

the asset ID as a String

Throws:

EsfMqttException