org.eclipse.soda.dk.transport
Class MessageListeners

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.transport.MessageListeners

All Implemented Interfaces:

ErrorListener, MessageListener

public class MessageListeners
extends EscObject
implements MessageListener

The MessageListeners class implements the MessageListener interface.

Version:

1.0.0

See Also:

ErrorListener, MessageListener

Field Summary

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, INTEGER_TABLE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, 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

Constructor Summary

MessageListeners(MessageListener[] objects)
Constructs an MessageListeners object using the input parameter(s).

MessageListeners(MessageListener currentObject, MessageListener newObject)
Constructs an MessageListeners object using the input parameter(s).

Method Summary

static MessageListener	add(MessageListener currentObject, MessageListener newObject) Perform the add method and return the MessageListener result.
void	errorOccurred(java.lang.Object source, java.lang.Object timestamp, java.lang.Object data) The errorOccurred method is called when an error has occurred.
MessageListener[]	getObjects() Gets the MessageListener [] objects 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.
protected MessageListener	remove(MessageListener removeHandler) Perform the remove method and return the MessageListener result.
static MessageListener	remove(MessageListener currentObject, MessageListener removeObject) Perform the remove method and return the MessageListener result.

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

attemptRecoveryFromError, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getConfigurationService, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getErrorSeverity, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, getResource, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleStaticError, handleStaticException, isDebug, isTrace, loadService, log, log, report, report, report, report, report, report, reportError, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageListeners

public MessageListeners(MessageListener[] objects)

Constructs an MessageListeners object using the input parameter(s). MessageListener[]

Parameters:

objects - The objects (MessageListener[]) parameter.

See Also:

MessageListeners(MessageListener,MessageListener)

MessageListeners

public MessageListeners(MessageListener currentObject,
                        MessageListener newObject)

Constructs an MessageListeners object using the input parameter(s). MessageListener MessageListener

Parameters:

currentObject - The current object (MessageListener) parameter.

newObject - The new object (MessageListener) parameter.

See Also:

MessageListeners(MessageListener[])

Method Detail

add

public static MessageListener add(MessageListener currentObject,
                                  MessageListener newObject)

Perform the add method and return the MessageListener result. MessageListener MessageListener

Parameters:

currentObject - The current object (MessageListener) parameter.

newObject - The new object (MessageListener) parameter.

Returns:

Results of the add (MessageListener) value.

remove

public static MessageListener remove(MessageListener currentObject,
                                     MessageListener removeObject)

Perform the remove method and return the MessageListener result. MessageListener MessageListener

Parameters:

currentObject - The current object (MessageListener) parameter.

removeObject - The remove object (MessageListener) parameter.

Returns:

Results of the remove (MessageListener) value.

See Also:

remove(MessageListener)

errorOccurred

public void errorOccurred(java.lang.Object source,
                          java.lang.Object timestamp,
                          java.lang.Object data)

The errorOccurred method is called when an error has occurred. Since other notifications are blocked until this method returns, implementors of this method should:

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

The source object that detected the error. The time at which the error was detected. Contains any data about the error.

Specified by:

errorOccurred in interface ErrorListener

Parameters:

source - The source (Object) parameter.

timestamp - The timestamp (Object) parameter.

data - The data (Object) parameter.

getObjects

public MessageListener[] getObjects()

Gets the MessageListener [] objects property value.

Returns:

Results of the get objects (MessageListener[]) 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 (eg calling read on a measuremnt).
• Handle this call quickly and return.

The transport that received the message. The timestamp when the message was detected. The message received.

Specified by:

messageReceived in interface MessageListener

Parameters:

transportService - The transport service (TransportService) parameter.

timestamp - The timestamp (Object) parameter.

message - The message (MessageService) parameter.

remove

protected MessageListener remove(MessageListener removeHandler)

Perform the remove method and return the MessageListener result. MessageListener

Parameters:

removeHandler - The remove handler (MessageListener) parameter.

Returns:

Results of the remove (MessageListener) value.

See Also:

remove(MessageListener,MessageListener)