org.eclipse.kura.data

Interface DataTransportService

@ProviderType
public interface DataTransportService

DataTransportService implementations provide the ability of connecting to a remote broker, publish messages, subscribe to topics, receive messages on the subscribed topics, and disconnect from the remote message broker. The whiteboard pattern is used to notify the service users about events such as message arrived, connection lost etc. through the DataTransportListener DataTransportListener

Method Summary

Modifier and Type	Method and Description
void	addDataTransportListener(DataTransportListener listener) Adds a listener.
void	connect() Connects to the remote broker.
void	disconnect(long quiesceTimeout) Disconnects from the broker.
java.lang.String	getAccountName() Returns the account name associated with the DataTransportService
java.lang.String	getBrokerUrl()
java.lang.String	getClientId()
java.lang.String	getUsername()
boolean	isConnected() Returns true if the DataTransportService is currently connected to the remote server.
DataTransportToken	publish(java.lang.String topic, byte[] payload, int qos, boolean retain) Enqueues a message for publishing with the underlying transport implementation.
void	removeDataTransportListener(DataTransportListener listener) Removes a listener.
void	subscribe(java.lang.String topic, int qos) Subscribes to a topic on the broker.
void	unsubscribe(java.lang.String topic) Unsubscribes to a topic on the broker.

Method Detail

connect

void connect()
      throws KuraConnectException

Connects to the remote broker. This method will block until the connection is established or a timeout occurs. The actual configuration needed to establish a connection is protocol specific (e.g. MQTT) and is exposed through the ConfigurationAdmin.

Throws:

KuraConnectException - the caller MAY retry connecting a later time.

isConnected

boolean isConnected()

Returns true if the DataTransportService is currently connected to the remote server.

getBrokerUrl

java.lang.String getBrokerUrl()

getAccountName

java.lang.String getAccountName()

Returns the account name associated with the DataTransportService

getUsername

java.lang.String getUsername()

getClientId

java.lang.String getClientId()

disconnect

void disconnect(long quiesceTimeout)

Disconnects from the broker. This method will block, up to the specified duration, allowing the protocol implementation to complete delivery of in-flight messages before actually disconnecting from the broker.

Parameters:

quiesceTimeout - - timeout that will be used before forcing a disconnect

subscribe

void subscribe(java.lang.String topic,
               int qos)
        throws KuraTimeoutException,
               KuraException,
               KuraNotConnectedException

Subscribes to a topic on the broker. This method MAY block until the underlying protocol message (e.g. the MQTT SUBSCRIBE message) is acknowledged by the broker or a timeout occurs. This message is idempotent so the caller may safely retry subscribing. The timeout interval used by the service is configurable through the ConfigurationService.

Parameters:

topic -

qos -

Throws:

KuraTimeoutException - TODO

KuraException

KuraNotConnectedException - TODO

unsubscribe

void unsubscribe(java.lang.String topic)
          throws KuraTimeoutException,
                 KuraException,
                 KuraNotConnectedException

Unsubscribes to a topic on the broker. This method MAY block until the underlying protocol message (e.g. the MQTT UNSUBSCRIBE message) is acknowledged by the broker or a timeout occurs. The timeout interval used by the service is configurable through the ConfigurationService.

Parameters:

topic -

Throws:

KuraTimeoutException

KuraException

KuraNotConnectedException - TODO

publish

DataTransportToken publish(java.lang.String topic,
                           byte[] payload,
                           int qos,
                           boolean retain)
                    throws KuraTooManyInflightMessagesException,
                           KuraException,
                           KuraNotConnectedException

Enqueues a message for publishing with the underlying transport implementation. An active connection to the remote server is required.

Parameters:

topic -

payload -

qos -

retain -

Returns:

Throws:

KuraTooManyInflightMessagesException

KuraException

KuraNotConnectedException - TODO

addDataTransportListener

void addDataTransportListener(DataTransportListener listener)

Adds a listener.

Parameters:

listener -

Since:

1.0.8

removeDataTransportListener

void removeDataTransportListener(DataTransportListener listener)

Removes a listener.

Parameters:

listener -

Since:

1.0.8