com.esf.net.mqtt.client.service

Interface IEsfMqttClient

All Known Subinterfaces:

IEsfMqttCloudClient

public interface 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
java.lang.String	getClientId() Returns the last unique ID given to the MQtt agent.
java.lang.String	getPassword() Returns the client's password.
com.eurotech.cloud.message.EdcSubscription[]	getSubscriptions() Returns an array of EdcSubscriptions objects representing the current subscriptions of the client.
java.lang.String	getUsername() Returns the client's username.
java.lang.String	getWillMessage() Reports Will Message
int	getWillQos() Reports Will QoS
java.lang.String	getWillTopic() Reports Will Topic
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.
void	registerCallback(IEsfMqttCallbackHandler esfMqttCallbackHandler) Register an IEsfMqttCallbackHandler with the IEsfMqttClient.
void	setBrokerUrl(java.lang.String brokerUrl) The URL of the MQtt broker.
void	setCleanStart(boolean cleanStart) The clean start flag for the MQtt client.
void	setClientId(java.lang.String clientId) The MQtt user ID sent to the broker when a new connection is established.
void	setKeepAlive(short seconds) Set the service MQtt ping interval.
void	setPassword(java.lang.String password) Returns the client's password.
void	setUsername(java.lang.String username) Sets the client's username.
void	startSession() Connects to the MQtt broker.
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 topic, int qos) Subscribes to a topic with the MQtt broker.
void	terminateSession() Disconnects from 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.

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

Reports the class name representing this interface.

Method Detail

setKeepAlive

void setKeepAlive(short seconds)
                  throws EsfMqttException

Set the service MQtt ping interval. This value is sent to the MQtt broker, as the MQtt keep-alive value for the connection.

Parameters:

seconds - Ping interval, in units of seconds.

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

getSubscriptions

com.eurotech.cloud.message.EdcSubscription[] getSubscriptions()

Returns an array of EdcSubscriptions objects representing the current subscriptions of the client.

Returns:

An array of EdcSubscription objects.

setUsername

void setUsername(java.lang.String username)
                 throws EsfMqttException

Sets the client's username.

Parameters:

username - A String object specifying the username.

Throws:

EsfMqttException

getUsername

java.lang.String getUsername()
                             throws EsfMqttException

Returns the client's username.

Returns:

A String object specifying the username.

Throws:

EsfMqttException

setPassword

void setPassword(java.lang.String password)
                 throws EsfMqttException

Returns the client's password.

Parameters:

password - A String object specifying the password.

Throws:

EsfMqttException

getPassword

java.lang.String getPassword()
                             throws EsfMqttException

Returns the client's password.

Returns:

A String object specifying the password.

Throws:

EsfMqttException

setClientId

void setClientId(java.lang.String clientId)
                 throws EsfMqttException

The MQtt user ID sent to the broker when a new connection is established. This ID should be unique for any connection to the broker, across all clients. This string should be more than one character, and no more than 23 characters in length.

Parameters:

clientId - A String representing the Client's ID.

Throws:

EsfMqttException

getClientId

java.lang.String getClientId()
                             throws EsfMqttException

Returns the last unique ID given to the MQtt agent. This represents the MQtt client ID that is used in the MQtt CONNECT command.

Returns:

string A String representing the Client'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 IEsfMqttCallbackHandler 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.

setBrokerUrl

void setBrokerUrl(java.lang.String brokerUrl)
                  throws EsfMqttException

The URL of the MQtt broker.

Parameters:

brokerUrl - A String representing the broker URL

Throws:

EsfMqttException

setCleanStart

void setCleanStart(boolean cleanStart)
                   throws EsfMqttException

The clean start flag for the MQtt client. The default value is true.

Parameters:

cleanStart - The clean start flag.

Throws:

EsfMqttException

startSession

void startSession()
                  throws EsfMqttException

Connects to the MQtt broker.

Throws:

EsfMqttException

terminateSession

void terminateSession()
                      throws EsfMqttException

Disconnects from the MQtt broker.

Throws:

EsfMqttException

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

getWillTopic

java.lang.String getWillTopic()
                              throws EsfMqttException

Reports Will Topic

Returns:

Will Topic as String

Throws:

EsfMqttException

getWillQos

int getWillQos()
               throws EsfMqttException

Reports Will QoS

Returns:

Will QoS as int

Throws:

EsfMqttException

getWillMessage

java.lang.String getWillMessage()
                                throws EsfMqttException

Reports Will Message

Returns:

Will Message as String

Throws:

EsfMqttException