com.oracle.iot.client.device.util

Class MessageDispatcher

java.lang.Object

com.oracle.iot.client.device.util.MessageDispatcher

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public abstract class MessageDispatcher
extends java.lang.Object
implements java.io.Closeable

The MessageDispatcher queues messages for automatic dispatching to the for the Oracle IoT Cloud Service. The MessageDispatcher prioritizes message dispatching to ensure high priority messages are dispatched ahead of lower priority messages. There is one MessageDispatcher instance per client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageDispatcher.DeliveryCallback A callback interface for successful delivery of messages.
static interface	MessageDispatcher.ErrorCallback A callback interface for errors in delivery of messages.

Constructor Summary

Constructors

Constructor and Description
MessageDispatcher()

Method Summary

Modifier and Type	Method and Description
static MessageDispatcher	getMessageDispatcher(DirectlyConnectedDevice directlyConnectedDevice) Get the instance of a MessageDispatcher for the DirectlyConnectedDevice.
abstract RequestDispatcher	getRequestDispatcher() Get the RequestDispatcher that is used by this MessageDispatcher for handling RequestMessages.
abstract void	offer(Message... messages) Offer messages to be queued.
void	offer(Message message) Offer a message to be queued.
abstract void	queue(Message... messages) Add the messages to the outgoing message queue if it is possible to do so without violating capacity restrictions.
void	queue(Message message) Add the message to the outgoing message queue if it is possible to do so without violating capacity restrictions.
static MessageDispatcher	removeMessageDispatcher(DirectlyConnectedDevice directlyConnectedDevice) Remove the instance of a MessageDispatcher for the DirectlyConnectedDevice.
static void	setMessageDispatcher(DirectlyConnectedDevice directlyConnectedDevice, MessageDispatcher messageDispatcher) Set the instance of a MessageDispatcher for the DirectlyConnectedDevice.
abstract void	setOnDelivery(MessageDispatcher.DeliveryCallback callback) Set a callback to be notified if message is successfully delivered.
abstract void	setOnError(MessageDispatcher.ErrorCallback callback) Set a callback to be notified if there is an error in dispatching.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

MessageDispatcher

public MessageDispatcher()

Method Detail

getMessageDispatcher

public static MessageDispatcher getMessageDispatcher(DirectlyConnectedDevice directlyConnectedDevice)

Get the instance of a MessageDispatcher for the DirectlyConnectedDevice. This is an implementation detail and is called from the implementation of the virtualization API.

Parameters:

directlyConnectedDevice - is a gateway or directly connected device

Returns:

A MessageDispatcher for the DirectlyConnectedDevice.

setMessageDispatcher

public static void setMessageDispatcher(DirectlyConnectedDevice directlyConnectedDevice,
                                        MessageDispatcher messageDispatcher)

Set the instance of a MessageDispatcher for the DirectlyConnectedDevice. This is an implementation detail and is called from the implementation of the virtualization API.

Parameters:

directlyConnectedDevice - is a gateway or directly connected device

messageDispatcher - is the MessageDispatcher for the directly connected device

removeMessageDispatcher

public static MessageDispatcher removeMessageDispatcher(DirectlyConnectedDevice directlyConnectedDevice)

Remove the instance of a MessageDispatcher for the DirectlyConnectedDevice. After calling removeMessageDispatcher, a call to getMessageDispatcher(DirectlyConnectedDevice) will return null. This is an implementation detail and is called from the implementation of the virtualization API.

Parameters:

directlyConnectedDevice - is a gateway or directly connected device

Returns:

the MessageDispatcher for the DirectlyConnectedDevice, or null

getRequestDispatcher

public abstract RequestDispatcher getRequestDispatcher()

Get the RequestDispatcher that is used by this MessageDispatcher for handling RequestMessages.

Returns:

a RequestDispatcher

See Also:

RequestDispatcher

queue

public abstract void queue(Message... messages)

Add the messages to the outgoing message queue if it is possible to do so without violating capacity restrictions.

Parameters:

messages - The messages to be queued

Throws:

java.lang.ArrayStoreException - if all the messages cannot be added to the queue

java.lang.IllegalArgumentException - if messages is null or empty

queue

public void queue(Message message)

Add the message to the outgoing message queue if it is possible to do so without violating capacity restrictions.

Parameters:

message - The message to be queued

Throws:

java.lang.ArrayStoreException - if the message cannot be added to the queue

java.lang.IllegalArgumentException - if the message is null

offer

public abstract void offer(Message... messages)

Offer messages to be queued. Depending on the policies, if any, the messages will be queued if it is possible to do so without violating capacity restrictions.

Parameters:

messages - The messages to be queued

Throws:

java.lang.ArrayStoreException - if all the messages cannot be added to the queue

java.lang.IllegalArgumentException - if messages is null or empty

offer

public void offer(Message message)

Offer a message to be queued. Depending on the policies, if any, the message will be queued if it is possible to do so without violating capacity restrictions.

Parameters:

message - The message to be queued

Throws:

java.lang.ArrayStoreException - if all the messages cannot be added to the queue

java.lang.IllegalArgumentException - if messages is null or empty

setOnError

public abstract void setOnError(MessageDispatcher.ErrorCallback callback)

Set a callback to be notified if there is an error in dispatching.

Parameters:

callback - callback to invoke, if null, the existing callback will be removed

setOnDelivery

public abstract void setOnDelivery(MessageDispatcher.DeliveryCallback callback)

Set a callback to be notified if message is successfully delivered.

Parameters:

callback - callback to invoke, if null, the existing callback will be removed