org.eclipse.paho.client.eclipse.view

Class MqttClientView

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.ViewPart

org.eclipse.paho.client.eclipse.view.MqttClientView

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, MqttCallback, org.eclipse.ui.IPersistable, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public class MqttClientView
extends org.eclipse.ui.part.ViewPart
implements MqttCallback

An MQTT client view. The top half provides three tabs for Connecting to an MQTT broker, publishing messages, and subscribing on topics. The bottom half of the view contains a log of all MQTT connections, publications, and subscription events.

Field Summary

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
MqttClientView() Constructor

Method Summary

Modifier and Type	Method and Description
void	connectionLost(Throwable cause) Logs a message that the broker connection has been lost and attempts to reconnect.
void	createPartControl(org.eclipse.swt.widgets.Composite parent) Create the control
void	deliveryComplete(IMqttDeliveryToken token) Called when delivery for a message has been completed, and all acknowledgments have been received.
void	deliveryComplete(MqttDeliveryToken token) Logs that a publish has completed (an acknowledgement has been received from the broker
static byte[]	getBytesFromFile(File file) Return the bytes from a file
static String	getHexString(byte[] b) Returns a hex string representation of the byte array
void	messageArrived(String topic, MqttMessage message) This method is called when a message arrives from the server.
void	setFocus() Sets the focus
void	valueChanged(org.eclipse.swt.widgets.Text text) A parameter's value has changed, update info

Methods inherited from class org.eclipse.ui.part.ViewPart

checkSite, getViewSite, init, init, saveState, setContentDescription, setInitializationData, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, dispose, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Constructor Detail

MqttClientView

public MqttClientView()

Constructor

Method Detail

setFocus

public void setFocus()

Sets the focus

Specified by:

setFocus in interface org.eclipse.ui.IWorkbenchPart

Specified by:

setFocus in class org.eclipse.ui.part.WorkbenchPart

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite parent)

Create the control

Specified by:

createPartControl in interface org.eclipse.ui.IWorkbenchPart

Specified by:

createPartControl in class org.eclipse.ui.part.WorkbenchPart

valueChanged

public void valueChanged(org.eclipse.swt.widgets.Text text)

A parameter's value has changed, update info

connectionLost

public void connectionLost(Throwable cause)

Logs a message that the broker connection has been lost and attempts to reconnect.

Specified by:

connectionLost in interface MqttCallback

Parameters:

cause - the reason behind the loss of connection.

messageArrived

public void messageArrived(String topic,
                           MqttMessage message)
                    throws Exception

Description copied from interface: MqttCallback

This method is called when a message arrives from the server.

This method is invoked synchronously by the MQTT client. An acknowledgment is not sent back to the server until this method returns cleanly.

If an implementation of this method throws an Exception, then the client will be shut down. When the client is next re-connected, any QoS 1 or 2 messages will be redelivered by the server.

Any additional messages which arrive while an implementation of this method is running, will build up in memory, and will then back up on the network.

If an application needs to persist data, then it should ensure the data is persisted prior to returning from this method, as after returning from this method, the message is considered to have been delivered, and will not be reproducible.

It is possible to send a new message within an implementation of this callback (for example, a response to this message), but the implementation must not disconnect the client, as it will be impossible to send an acknowledgment for the message being processed, and a deadlock will occur.

Specified by:

messageArrived in interface MqttCallback

Parameters:

topic - name of the topic on the message was published to

message - the actual message.

Throws:

Exception - if a terminal error has occurred, and the client should be shut down.

deliveryComplete

public void deliveryComplete(MqttDeliveryToken token)

Logs that a publish has completed (an acknowledgement has been received from the broker

getHexString

public static String getHexString(byte[] b)

Returns a hex string representation of the byte array

getBytesFromFile

public static byte[] getBytesFromFile(File file)
                               throws IOException

Return the bytes from a file

Throws:

IOException

deliveryComplete

public void deliveryComplete(IMqttDeliveryToken token)

Description copied from interface: MqttCallback

Called when delivery for a message has been completed, and all acknowledgments have been received. For QoS 0 messages it is called once the message has been handed to the network for delivery. For QoS 1 it is called when PUBACK is received and for QoS 2 when PUBCOMP is received. The token will be the same token as that returned when the message was published.

Specified by:

deliveryComplete in interface MqttCallback

Parameters:

token - the delivery token associated with the message.