com.esf.net.mqtt.client.service

Interface IEsfMqttMasterClient

public interface IEsfMqttMasterClient

Method Summary

Methods

Modifier and Type	Method and Description
int	controlSubscribe(java.lang.String topic, int qos) Subscribes to a topic with the MQtt broker.
boolean	isConnected() Returns an indication of whether the MQtt connection to the broker is established.
int	publish(java.lang.String topic, byte[] payload, int qos, boolean retain) Publishes a message to the MQtt broker.
int	publish(java.lang.String assetId, java.lang.String topic, byte[] payload, int qos, boolean retain) Publishes a message to the MQtt broker.
void	registerCallback(IEsfMqttCallbackHandler esfMqttCallbackHandler) Register an IEsfMqttCallback with the IEsfMqttClient.
void	release() Releases this handle to the master client.
int	subscribe(com.eurotech.cloud.message.EdcSubscription subscription) Subscribes to a topic with the MQtt broker.
int	subscribe(com.eurotech.cloud.message.EdcSubscription[] subscriptions) Subscribes to one or more topics with 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 topic, int qos) Subscribes to a topic 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(com.eurotech.cloud.message.EdcSubscription subscription) Unsubscribes from a topic with the MQtt broker.
int	unsubscribe(java.lang.String topic) Unsubscribes from 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.

Method Detail

publish

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

Publishes a message to the MQtt broker.

Parameters:

topic - A String specifying the 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

publish

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

Publishes a message to the MQtt broker.

Parameters:

assetId - A String specifying the asset ID.

topic - A String specifying the 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

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

unsubscribe

int unsubscribe(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:

subscription - A EdcSubscription object containing the topic.

Returns:

The unsubscribe message's ID.

Throws:

EsfMqttException

unsubscribe

int unsubscribe(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:

topic - A String object containing the topic.

Returns:

The unsubscribe message's ID.

Throws:

EsfMqttException

subscribe

int subscribe(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:

subscriptions - An array of EdcSubscription objects.

Returns:

The subscribe message's ID.

Throws:

EsfMqttException

subscribe

int subscribe(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:

subscription - An EdcSubscription object.

Returns:

The subscribe message's ID.

Throws:

EsfMqttException

subscribe

int subscribe(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:

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 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:

topic - A String object containing the topic.

qos - An int containing the Quality of Service.

Returns:

The subscribe message's ID.

Throws:

EsfMqttException

isConnected

boolean isConnected()

Returns an indication of whether the MQtt connection to the broker is established.

Returns:

boolean, whether connection to broker is established.

registerCallback

void registerCallback(IEsfMqttCallbackHandler esfMqttCallbackHandler)

Register an IEsfMqttCallback with the IEsfMqttClient. This handler will receive events when a client publication has arrived, and when a publish (QoS > 0) has been fully acknowledged by the broker.

Parameters:

esfMqttCallbackHandler - An implementation of the IEsfMqttCallbackHandler interface.

release

void release()

Releases this handle to the master client. This instance should no longer be used. The application will need to get another IEsfMqttMasterClient instance from the IESfMqttService.