org.eclipse.soda.dk.transport
Class TransportListeners

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

All Implemented Interfaces:

ErrorListener, MessageListener, TransportListener

public class TransportListeners
extends EscObject
implements TransportListener

The TransportListeners class implements the TransportListener interface.

Version:

1.0.0

See Also:

ErrorListener, TransportListener

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

TransportListeners(TransportListener[] objects)
Constructs an TransportListeners object using the input parameter(s).

TransportListeners(TransportListener currentObject, TransportListener newObject)
Constructs an TransportListeners object using the input parameter(s).

Method Summary

static TransportListener	add(TransportListener currentObject, TransportListener newObject) Perform the add method and return the Object 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.
TransportListener[]	getObjects() Gets the TransportListener [] 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 TransportListener	remove(TransportListener removeHandler) Perform the remove method and return the Object result.
static TransportListener	remove(TransportListener currentObject, TransportListener removeObject) Perform the remove method and return the Object result.
void	transportChanged(TransportService transportService, java.lang.Object timestamp, int newState, int oldState) This method will be called when the state of the TransportService changes.

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

TransportListeners

public TransportListeners(TransportListener[] objects)

Constructs an TransportListeners object using the input parameter(s). TransportListener[]

Parameters:

objects - The objects (TransportListener[]) parameter.

See Also:

TransportListeners(TransportListener,TransportListener)

TransportListeners

public TransportListeners(TransportListener currentObject,
                          TransportListener newObject)

Constructs an TransportListeners object using the input parameter(s). TransportListener TransportListener

Parameters:

currentObject - The current object (TransportListener) parameter.

newObject - The new object (TransportListener) parameter.

See Also:

TransportListeners(TransportListener[])

Method Detail

add

public static TransportListener add(TransportListener currentObject,
                                    TransportListener newObject)

Perform the add method and return the Object result. TransportListener TransportListener

Parameters:

currentObject - The current object (TransportListener) parameter.

newObject - The new object (TransportListener) parameter.

Returns:

Results of the add (TransportListener) value.

remove

public static TransportListener remove(TransportListener currentObject,
                                       TransportListener removeObject)

Perform the remove method and return the Object result. TransportListener TransportListener

Parameters:

currentObject - The current object (TransportListener) parameter.

removeObject - The remove object (TransportListener) parameter.

Returns:

Results of the remove (TransportListener) value.

See Also:

remove(TransportListener)

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 TransportListener[] getObjects()

Gets the TransportListener [] objects property value.

Returns:

Results of the get objects (TransportListener[]) 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 TransportListener remove(TransportListener removeHandler)

Perform the remove method and return the Object result. TransportListener

Parameters:

removeHandler - The remove handler (TransportListener) parameter.

Returns:

Results of the remove (TransportListener) value.

See Also:

remove(TransportListener,TransportListener)

transportChanged

public void transportChanged(TransportService transportService,
                             java.lang.Object timestamp,
                             int newState,
                             int oldState)

This method will be called when the state of the TransportService changes. 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.

Because of the multiple threads and quickly changing states, the current state of the transport may not be the same as the newState input parameter. org.eclipse.soda.dk.transport.service.TransportService java.lang.Object The new state of the TransportService when the notification process started. The old state of the TransportService.

Specified by:

transportChanged in interface TransportListener

Parameters:

transportService - The transport service (TransportService) parameter.

timestamp - The timestamp (Object) parameter.

newState - The new state (int) parameter.

oldState - The old state (int) parameter.