org.eclipse.soda.dk.signal
Class MessageSignal

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.device.Control
          org.eclipse.soda.dk.signal.Signal
              org.eclipse.soda.dk.signal.MessageSignal

All Implemented Interfaces:

MessageHandler, ControlService, SignalService, ErrorListener, MessageListener, MultiplexMessageListener

Direct Known Subclasses:

DataSignal

public class MessageSignal
extends Signal
implements MessageHandler

The MessageSignal class implements the SignalService interface.

Since:

1.0

Version:

1.2.0

See Also:

Control, Signal, ControlService, ErrorListener, MessageService, MessageHandler, SignalService, TransportListener

Field Summary

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

Constructor Summary

MessageSignal(java.lang.String key, MessageService message)
Constructs an MessageSignal object using the input parameter(s).

Method Summary

MessageService	getMessage() Gets the MessageService message property value.
void	messageReceived(TransportService transportService, java.lang.Object timestamp, ChannelService channel, MessageService message) Message received with the specified transport service, timestamp, channel and message parameters.
void	messageReceived(TransportService transportService, java.lang.Object timestamp, MessageService message) This API will be called each time the TransportService receives a valid message.
void	setMessage(MessageService message) Sets the message value.

Methods inherited from class org.eclipse.soda.dk.signal.Signal

addSignalListener, fireErrorOccurred, fireErrorOccurred, fireSignalOccurred, fireSignalOccurred, fireSignalOccurred, fireSignalOccurred, getSignalListener, removeSignalListener, reportError, setSignalListener, trigger, trigger, trigger, trigger, trigger, trigger

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

attemptRecoveryFromError, equalsValue, errorOccurred, findMethod, getCodeKey, getErrorSeverity, getKey, getQualifiedKey, getResource, setKey, setQualifiedKey, toString

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

createBoolean, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getByte, getChar, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getDouble, getFloat, getId, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogLevel, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getShort, getSimpleClassName, getStaticBoolean, getStaticByte, getStaticChar, getStaticDouble, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticShort, getStaticString, getString, 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, reportSystemInfo, setBackward, setDebug, setDefaultLogService, setLogService, setTraceLevel, setUnmodifiable, shouldLog, sleep, startupEscStatic, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

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

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

errorOccurred

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

getKey

Constructor Detail

MessageSignal

public MessageSignal(java.lang.String key,
                     MessageService message)

Constructs an MessageSignal object using the input parameter(s).

Parameters:

key - The key (String) parameter.

message - The message (MessageService) parameter.

Method Detail

getMessage

public MessageService getMessage()

Gets the MessageService message property value.

Specified by:

getMessage in interface MessageHandler

Returns:

Results of the get message (MessageService) value.

See Also:

setMessage(MessageService)

messageReceived

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

Message received with the specified transport service, timestamp, channel and message parameters.

Specified by:

messageReceived in interface MultiplexMessageListener

Parameters:

transportService - The transport service (TransportService) parameter.

timestamp - The time stamp (Object) parameter.

channel - The channel (ChannelService) parameter.

message - The message (MessageService) parameter.

Since:

1.2

See Also:

messageReceived(TransportService,Object,MessageService)

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

Parameters:

transportService - The transport service (TransportService) parameter.

timestamp - The time stamp (Object) parameter.

message - The message (MessageService) parameter.

See Also:

messageReceived(TransportService,Object,ChannelService,MessageService)

setMessage

public void setMessage(MessageService message)

Sets the message value.

Parameters:

message - The message (MessageService) parameter.

See Also:

getMessage()