org.eclipse.soda.dk.device
Class QueueDevice

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.Control
          org.eclipse.soda.dk.device.Container
              org.eclipse.soda.dk.device.Device
                  org.eclipse.soda.dk.device.TransportDevice
                      org.eclipse.soda.dk.device.QueueDevice

All Implemented Interfaces:

java.lang.Runnable, ControlService, DeviceService, ErrorListener, MessageListener, MultiplexMessageListener, MultiplexTransportListener, TransportListener

public abstract class QueueDevice
extends TransportDevice
implements java.lang.Runnable

The QueueDevice class implements the DeviceService interface.

Since:

1.0

Version:

1.2.0

See Also:

Container, Control, Device, Queue, TransportDevice, ControlService, ErrorListener, MessageHandler, Runnable, Thread, TransportListener

Field Summary

Fields inherited from class org.eclipse.soda.dk.device.Device

channelChanged, channels, closeChannel, openChannel, POLL_COMMAND_NAME, START_COMMAND_NAME, STARTED_MASK, STOP_COMMAND_NAME

Fields inherited from class org.eclipse.soda.dk.device.Container

broadcastCommandCount, broadcastMeasurementCount, broadcastSignalCount, capabilities, CHANNEL_CHANGED_EXCEPTION_RESOURCE, configuration, DEVICE_ACTIVE_STATE_RESOURCE, DEVICE_ALIVE_STATE_RESOURCE, DEVICE_CHANGED_EXCEPTION_RESOURCE, DEVICE_CONNECTED_STATE_RESOURCE, DEVICE_CREATED_STATE_RESOURCE, DEVICE_DEAD_STATE_RESOURCE, DEVICE_STARTED_STATE_RESOURCE, DEVICE_STATE_RESOURCE_TABLE, EXCEPTION_NO_TRANSPORT_RESOURCE, INITIALIZE_CONFIGURATION_EXCEPTION_RESOURCE, INITIALIZE_CONFIGURATION_MISCOMPARE_RESOURCE, INITIALIZE_CONFIGURATION_RESOURCE, INITIALIZE_CONFIGURATION_SAME_RESOURCE, INITIALIZE_READ_EXCEPTION_RESOURCE, INITIALIZE_WRITE_EXCEPTION_RESOURCE, logLevel, MESSAGE_RECEIVED_EXCEPTION_RESOURCE, metrics, NOTIFICATION_PRIORITY_DEFAULT, notificationPriority, PROCESSING_UNABLE_TO_KEEP_UP_EXCEPTION_RESOURCE, RUN_EXCEPTION_RESOURCE, SEND_EXCEPTION_RESOURCE, stateChanged, status, TOPIC_DELIMITER

Fields inherited from class org.eclipse.soda.dk.device.Control

EXCEPTION_READ_FAILED_RESOURCE, SET_VALUE_EXCEPTION_RESOURCE

Fields inherited from class org.eclipse.soda.dk.core.EscObject

CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, ID_NAME_KEY, INTEGER_TABLE, INTEGER_TABLE_SIZE, KEY_KEY, LOG_DEBUG, LOG_DEFAULT, LOG_ERROR, LOG_INFO, LOG_LEVEL_KEY, LOG_TRACE, LOG_WARNING, LONG_TABLE, LONG_TABLE_SIZE, PREFIX_KEY, READONLY_EMPTY_COLLECTION, READONLY_EMPTY_LIST, READONLY_EMPTY_MAP, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE, Unmodifiable

Fields inherited from interface org.eclipse.soda.dk.device.service.DeviceService

ACTIVE, ALIVE, ALL_COMMANDS, ALL_MEASUREMENTS, ALL_SIGNALS, AUTOSTART, BLOCKPROCESSING, BROADCAST_COMMAND_COUNT_DATA_KEY, BROADCAST_MEASUREMENT_COUNT_DATA_KEY, BROADCAST_SIGNAL_COUNT_DATA_KEY, Capabilities, CAPABILITIES_EXTERNAL_KEY, CAPABILITIES_GET_EXTERNAL_KEY, CAPABILITIES_READ_EXTERNAL_KEY, CAPABILITIES_WRITE_EXTERNAL_KEY, CHANNEL_CHANGED_EXTERNAL_KEY, CHANNEL_EXTERNAL_ID_DATA_KEY, CHANNEL_ID_DATA_KEY, ChannelChanged, Channels, CHANNELS_EXTERNAL_KEY, CHANNELS_GET_EXTERNAL_KEY, CHANNELS_READ_EXTERNAL_KEY, CHANNELS_WRITE_EXTERNAL_KEY, CLOSE_CHANNEL_EXTERNAL_KEY, CloseChannel, Configuration, CONFIGURATION_DATA_KEY, CONFIGURATION_EXTERNAL_KEY, CONFIGURATION_GET_EXTERNAL_KEY, CONFIGURATION_READ_EXTERNAL_KEY, CONFIGURATION_WRITE_EXTERNAL_KEY, CONNECTED, CREATED, DEAD, ERROR_EXTERNAL_KEY, EVENPROCESSING, EXECUTE_EXTERNAL_KEY, GET_EXTERNAL_KEY, INITIALIZEMEASUREMENTS, KEYS_DATA_KEY, Metrics, METRICS_EXTERNAL_KEY, METRICS_GET_EXTERNAL_KEY, NULL, OPEN_CHANNEL_EXTERNAL_KEY, OpenChannel, READ_EXTERNAL_KEY, RECEIVED_KEY_DATA_KEY, SERVICE_NAME, SET_EXTERNAL_KEY, SOURCE_DATA_KEY, STARTED, STATE_DATA_KEY, STATE_OLD_DATA_KEY, Status, STATUS_EXTERNAL_KEY, STATUS_GET_EXTERNAL_KEY, STATUS_READ_EXTERNAL_KEY, STATUS_WRITE_EXTERNAL_KEY, TIMESTAMP_DATA_KEY, TRIGGER_EXTERNAL_KEY, VALUE_DATA_KEY, VALUE_OLD_DATA_KEY, WRITE_EXTERNAL_KEY

Constructor Summary

protected

QueueDevice() Constructs an BaseQueueDevice object.

Method Summary

Queue	getReceivedQueue() Gets the Queue receivedQueue property value.
void	messageReceived(TransportService transportService, java.lang.Object timestamp, MessageService message) This API will be called each time the TransportService receives a valid message.
void	run() Perform the run action method.
void	send(ChannelService channel, MessageService message) Send with the specified channel and message parameters.
void	send(ChannelService channel, MessageService message, ResponseListener responseListener) Send with the specified channel, message and response listener parameters.
void	send(MessageService message) Perform the send action method.
void	send(MessageService message, ResponseListener responseListener) Send with the specified message and response listener parameters.
void	start() Perform the start action method.
void	stop() Perform the stop action method.

Methods inherited from class org.eclipse.soda.dk.device.TransportDevice

activate, errorOccurred, exit, getDefaultTransport, getInterest, getMessageListeners, getTransport, load, messageReceived, register, registerMessageHandler, registerMessageHandler, setState, setTransport, setup, transportChanged, unregister

Methods inherited from class org.eclipse.soda.dk.device.Device

addDeviceListener, channelChanged, channelChanged, closeChannel, controlAdded, controlRemoved, finalize, fireChannelChanged, fireContainerChanged, fireErrorOccurred, getCapabilities, getChannel, getChannelChanged, getChannels, getCloseChannel, getConfiguration, getDefaultKey, getDeviceListener, getMessageCapacity, getMessageKey, getMultiplexDeviceListener, getNotificationPriorityDefault, getOpenChannel, getPriority, getReadTimeout, getStatus, getThread, handleMethodChannels, handleMethodCloseChannel, handleMethodMetrics, handleMethodOpenChannel, hasListeners, initialize, initialize, isAutoStart, isBlockProcessing, isEvenProcessing, isRunning, isStarted, isThreadNeeded, openChannel, put, remove, removeDeviceListener, restart, setDeviceListener, setReadTimeout, setRunning, setStarted, setThread, startup

Methods inherited from class org.eclipse.soda.dk.device.Container

activate, addData, addQualifiedKeys, attemptRecoveryFromError, broadcast, broadcastStatus, broadcastStatus, changeIds, collectMetrics, createFilter, deactivate, deactivate, elements, get, getBroadcastCommandCount, getBroadcastMeasurementCount, getBroadcastSignalCount, getBundleContext, getCommand, getConfigurationInformation, getConfigurationInformation, getConfigurationService, getControlCapacity, getControls, getDefaultStyle, getErrorSeverity, getInformation, getLogDetails4, getLogDetails5, getLogDetails6, getLogLevel, getMeasurement, getMetrics, getNotificationController, getNotificationPriority, getNotificationService, getNumberValue, getPrefix, getSignal, getState, getStatusDictionary, getString, getStyle, handleMethodMetrics, initializeMeasurements, initializeMeasurements, isInitializeMeasurements, keys, notificationReceived, prependPrefix, prependPrefix, put, putConfigurationInformation, register, register, removeListeners, removeQualifiedKeys, setBroadcastCommandCount, setBroadcastMeasurementCount, setBroadcastSignalCount, setBundleContext, setConfigurationInformation, setInformation, setListenersNull, setLogLevel, setMetrics, setNotificationController, setNotificationPriority, setNotificationService, setStateLocal, setStyle, setupCustom, setupNotification, setupNotificationCustom, startupCommands, startupCommands, toString, toStringInfo, transportStartedWait, unregister, unsubscribe, updateBroadcastCommandCount, updateBroadcastMeasurementCount, updateBroadcastSignalCount, validConfigurationId

Methods inherited from class org.eclipse.soda.dk.device.Control

equalsValue, findMethod, getCodeKey, getKey, getQualifiedKey, getResource, setKey, setQualifiedKey

Methods inherited from class org.eclipse.soda.dk.core.EscObject

createBoolean, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getByte, getChar, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getDouble, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails7, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getShort, getSimpleClassName, getStaticBoolean, getStaticByte, getStaticChar, getStaticDouble, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticShort, getStaticString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isBackward, isDebug, isLogging, isTrace, isUnmodifiable, loadService, log, log, log, report, report, report, report, report, report, report, reportError, reportSystemInfo, setBackward, setDebug, setDefaultLogService, setLogService, setTraceLevel, setUnmodifiable, shouldLog, sleep, startupEscStatic, toStringConfigurationKeys

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.soda.dk.transport.service.MultiplexTransportListener

channelChanged

Methods inherited from interface org.eclipse.soda.dk.device.service.DeviceService

elements, get, getCommand, getConfigurationInformation, getMeasurement, getNotificationService, getSignal, getState, setConfigurationInformation, setNotificationService

Methods inherited from interface org.eclipse.soda.dk.device.service.ControlService

getKey

Constructor Detail

QueueDevice

protected QueueDevice()

Constructs an BaseQueueDevice object.

Method Detail

getReceivedQueue

public Queue getReceivedQueue()

Gets the Queue receivedQueue property value.

Returns:

Results of the get received queue (Queue) value.

messageReceived

public void messageReceived(TransportService transportService,
                            java.lang.Object timestamp,
                            MessageService message)

This API will be called each time the TransportService receives a valid message. Since other notifications are blocked until this method returns, implementors of this method should:

• Not cause the device or transport to be blocked (e.g. calling read on a measurement).
• Handle this call quickly and return.

Specified by:

messageReceived in interface MessageListener

Overrides:

messageReceived in class TransportDevice

Parameters:

transportService - The transport service (TransportService) parameter.

timestamp - The time stamp (Object) parameter.

message - The message (MessageService) parameter.

See Also:

TransportDevice.messageReceived(TransportService,Object,ChannelService,MessageService)

run

public void run()

Perform the run action method.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class Device

See Also:

Runnable.run()

send

public void send(MessageService message)

Perform the send action method.

Specified by:

send in interface DeviceService

Overrides:

send in class TransportDevice

Parameters:

message - The message (MessageService) parameter.

See Also:

DeviceService.send(org.eclipse.soda.dk.multiplex.connection.service.ChannelService, org.eclipse.soda.dk.message.service.MessageService), send(ChannelService,MessageService), send(ChannelService,MessageService,ResponseListener), send(MessageService,ResponseListener)

send

public void send(ChannelService channel,
                 MessageService message)

Send with the specified channel and message parameters.

Specified by:

send in interface DeviceService

Overrides:

send in class TransportDevice

Parameters:

channel - The channel (ChannelService) parameter.

message - The message (MessageService) parameter.

See Also:

send(MessageService), send(ChannelService,MessageService,ResponseListener), send(MessageService,ResponseListener)

send

public void send(ChannelService channel,
                 MessageService message,
                 ResponseListener responseListener)

Send with the specified channel, message and response listener parameters.

Specified by:

send in interface DeviceService

Overrides:

send in class TransportDevice

Parameters:

channel - The channel (ChannelService) parameter.

message - The message (MessageService) parameter.

responseListener - The response listener (ResponseListener) parameter.

See Also:

send(MessageService), send(ChannelService,MessageService), send(MessageService,ResponseListener)

send

public void send(MessageService message,
                 ResponseListener responseListener)

Send with the specified message and response listener parameters.

Specified by:

send in interface DeviceService

Overrides:

send in class TransportDevice

Parameters:

message - The message (MessageService) parameter.

responseListener - The response listener (ResponseListener) parameter.

See Also:

send(MessageService), send(ChannelService,MessageService), send(ChannelService,MessageService,ResponseListener)

start

public void start()

Perform the start action method.

Specified by:

start in interface DeviceService

Overrides:

start in class TransportDevice

See Also:

DeviceService.start()

stop

public void stop()

Perform the stop action method.

Specified by:

stop in interface DeviceService

Overrides:

stop in class TransportDevice

See Also:

DeviceService.stop()