org.maestro.client.exchange

Class MaestroMqttClient

java.lang.Object

org.maestro.client.exchange.MaestroMqttClient

All Implemented Interfaces:

MaestroClient

Direct Known Subclasses:

MaestroReceiverClient

public class MaestroMqttClient
extends Object
implements MaestroClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MaestroMqttClient(org.eclipse.paho.client.mqttv3.MqttClient mqttClient) Constructor (for testing)
	MaestroMqttClient(String url) Constructor

Method Summary

Modifier and Type	Method and Description
void	connect() Connect to the maestro broker
void	disconnect() Disconnects from the maestro broker
void	publish(String topic, MaestroNote note) Publishes a message in the broker
protected void	publish(String topic, MaestroNote note, int qos, boolean retained) Publishes a message in the broker.
protected void	publish(String topic, MaestroNote note, int qos, boolean retained, MaestroNoteCallback postProcessCallback) Publishes a message in the broker.
void	subscribe(String topic, int qos) Subscribe to a topic
void	unsubscribe(String topic) Unsubscribe from a topic

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaestroMqttClient

public MaestroMqttClient(String url)
                  throws MaestroException

Constructor

Parameters:

url - Maestro broker URL

Throws:

MaestroException - if unable to create the client

MaestroMqttClient

protected MaestroMqttClient(org.eclipse.paho.client.mqttv3.MqttClient mqttClient)
                     throws MaestroException

Constructor (for testing)

Parameters:

mqttClient - Maestro broker URL

Throws:

MaestroException - if unable to create the client

Method Detail

connect

public void connect()
             throws MaestroConnectionException

Connect to the maestro broker

Specified by:

connect in interface MaestroClient

Throws:

MaestroConnectionException - if unable to connect to the broker

disconnect

public void disconnect()
                throws MaestroConnectionException

Disconnects from the maestro broker

Specified by:

disconnect in interface MaestroClient

Throws:

MaestroConnectionException - if failed to disconnect cleanly (should be safe to ignore in most cases)

publish

protected void publish(String topic,
                       MaestroNote note,
                       int qos,
                       boolean retained)
                throws MalformedNoteException,
                       MaestroConnectionException

Publishes a message in the broker. This is normally used for publishing notifications, because some of them are set as retained in the broker

Parameters:

topic - the topic to publish the message

note - the maestro note to publish

qos - MQTT QoS

retained - MQTT retained flag

Throws:

MaestroConnectionException - if failed to publish the message

MalformedNoteException - in case of other I/O errors

publish

protected void publish(String topic,
                       MaestroNote note,
                       int qos,
                       boolean retained,
                       MaestroNoteCallback postProcessCallback)
                throws MalformedNoteException,
                       MaestroConnectionException

Publishes a message in the broker. This is normally used for publishing notifications, because some of them are set as retained in the broker

Parameters:

topic - the topic to publish the message

note - the maestro note to publish

qos - MQTT QoS

retained - MQTT retained flag

postProcessCallback - A call back action to be executed after the message was sent

Throws:

MaestroConnectionException - if failed to publish the message

MalformedNoteException - in case of other I/O errors

publish

public void publish(String topic,
                    MaestroNote note)
             throws MalformedNoteException,
                    MaestroConnectionException

Publishes a message in the broker

Specified by:

publish in interface MaestroClient

Parameters:

topic - the topic to publish the message

note - the maestro note to publish

Throws:

MaestroConnectionException - if failed to publish the message

MalformedNoteException - in case of other I/O errors

subscribe

public void subscribe(String topic,
                      int qos)

Subscribe to a topic

Parameters:

topic - the topic to subscribe

qos - the QOS for the topic

unsubscribe

public void unsubscribe(String topic)

Unsubscribe from a topic

Parameters:

topic - the topic to unsubscribe from