org.eclipse.soda.dk.multicast.transport
Class MulticastTransport

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.transport.Transport
          org.eclipse.soda.dk.transport.ThreadTransport
              org.eclipse.soda.dk.udp.transport.UdpTransport
                  org.eclipse.soda.dk.multicast.transport.MulticastTransport

All Implemented Interfaces:

java.lang.Runnable, ConfigurationService, MulticastTransportService, TransportService, UdpTransportService

public class MulticastTransport
extends UdpTransport
implements TransportService, MulticastTransportService

Multicast Transport.

The Device Kit properties keys and default values.

The list of exported services:

Version:

1.1.0

See Also:

MulticastTransportService, TransportService

Field Summary

static java.lang.String	CLASS_NAME Defines the full class name.
static java.lang.String	DEFAULT_LOCAL_HOST Define the default local host (String) constant.
static int	DEFAULT_LOCAL_PORT_NUM Define the default local port num (int) constant.
static java.lang.String	DEFAULT_REMOTE_HOST Define the default remote host (String) constant.
static int	DEFAULT_SIZE Define the default size (int) constant.
static int	DEFAULT_TIMEOUT Define the default timeout (int) constant.

Fields inherited from class org.eclipse.soda.dk.udp.transport.UdpTransport

DEFAULT_LOCALPORT, localPortNum, remoteHostAddress, SOCKET_CONNECT_EXCEPTION_RESOURCE, UNKNOWN_HOST_EXCEPTION_RESOURCE

Fields inherited from class org.eclipse.soda.dk.transport.Transport

BAD_CHECKSUM_RESOURCE, CLONE_EXCEPTION_RESOURCE, CLOSE_EXCEPTION_RESOURCE, CONFIGURATION_ERROR_RESOURCE, CONFIGURATION_MISMATCH_RESOURCE, CONNECTION_IN_USE_EXCEPTION_RESOURCE, CR, DEFAULT_NO_ACTIVITY_TIMEOUT, DEFAULT_RETRY_TIME, ERROR_OCCURRED_EXCEPTION_RESOURCE, ERROR_ON_BUS_RESOURCE, errorCount, EXCEPTION_NO_RESPONSE_RESOURCE, history, inputMessageCount, INTERRUPT_BEFORE_WRITE_RESOURCE, INVALID_MESSAGE_RESOURCE, INVALID_SEQUENCE_RESOURCE, LF, logLevel, MESSAGE_FILTERED_RESOURCE, MESSAGE_RECEIVED_EXCEPTION_RESOURCE, MESSAGE_RECEIVED_RESOURCE, MESSAGE_SENT_RESOURCE, NACK_RECEIVED_RESOURCE, NO_ACTIVITY_RESOURCE, NO_ACTIVITY_STATUS_ERROR, NO_ACTIVITY_STATUS_MESSAGE_SENT, NO_ACTIVITY_STATUS_UNKNOWN, noActivityTimeout, notificationService, prefixMetrics, prefixStatus, PROCESS_INPUT_EXCEPTION_RESOURCE, QUEUE_TOO_BIG_RESOURCE, RECONNECT_RESOURCE, retryTime, RUN_EXCEPTION_RESOURCE, SEND_EXCEPTION_RESOURCE, SEND_NOT_STARTED_EXCEPTION_RESOURCE, sentMessageCount, SHUTDOWN_EXCEPTION_RESOURCE, STARTUP_EXCEPTION_RESOURCE, STARTUP_MESSAGE_RECEIVED_RESOURCE, STATE_STRINGS, stateChanaged, stateChangeCount, TRANSMIT_RETRIES_DEFAULT, TRANSPORT_ACTIVE_STATE_RESOURCE, TRANSPORT_ALIVE_STATE_RESOURCE, TRANSPORT_CHANGED_EXCEPTION_RESOURCE, TRANSPORT_CONNECTED_STATE_RESOURCE, TRANSPORT_CREATED_STATE_RESOURCE, TRANSPORT_DEAD_STATE_RESOURCE, TRANSPORT_ERROR_RESOURCE, TRANSPORT_STARTED_STATE_RESOURCE, TRANSPORT_STARTUP_EXCEPTION_RESOURCE, TRANSPORT_STATE_RESOURCE_TABLE, UNABLE_TO_CONNECTION_TO_BUS_RESOURCE, UNKNOWN_ERROR, WRITE_EXCEPTION_RESOURCE, WRITE_INTERRUPT_PENDING_RESOURCE, WRITE_INTERRUPT_RESOURCE

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

EMPTY_BYTES, EMPTY_STRING, 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

Fields inherited from interface org.eclipse.soda.dk.multicast.transport.service.MulticastTransportService

FACTORY_SERVICE_NAME, LOCALHOST, LOCALHOST_KEY, LOCALPORT, LOCALPORT_KEY, MANAGED_SERVICE_NAME, PACKETSIZE, PACKETSIZE_KEY, REMOTEHOST, REMOTEHOST_KEY, REMOTEPORT, REMOTEPORT_KEY, SERVICE_NAME

Fields inherited from interface org.eclipse.soda.dk.udp.transport.service.UdpTransportService

FACTORY_SERVICE_NAME, LOCALHOST_KEY, LOCALPORT_KEY, MANAGED_SERVICE_NAME, PACKETSIZE_KEY, REMOTEHOST_KEY, REMOTEPORT_KEY, SERVICE_NAME

Constructor Summary

MulticastTransport()
Constructs a new instance of the MulticastTransport class.

MulticastTransport(java.lang.String remoteHostString, int remotePortNum, java.lang.String localHostString, int localPortNum, int packetSize, int readTimeout)
Constructs an MulticastTransport object using the input parameter(s).

Method Summary

protected java.net.DatagramSocket	createSocket() Perform the createSocket method and return the DatagramSocket result.
java.lang.String	getLocalhost() Gets the value of localhost custom parameter.
int	getLocalport() Gets the value of localport custom parameter.
int	getPacketsize() Gets the value of packetsize custom parameter.
java.lang.String	getRemotehost() Gets the value of remotehost custom parameter.
int	getRemoteport() Gets the value of remoteport custom parameter.
void	setLocalhost(java.lang.String localhost) Sets the value of localhost custom parameter.
void	setLocalport(int localport) Sets the value of localport custom parameter.
void	setPacketsize(int packetsize) Sets the value of packetsize custom parameter.
void	setRemotehost(java.lang.String remotehost) Sets the value of remotehost custom parameter.
void	setRemoteport(int remoteport) Sets the value of remoteport custom parameter.
void	setup() Sets user-defined variables to use in the test.

Methods inherited from class org.eclipse.soda.dk.udp.transport.UdpTransport

attemptRecoveryFromError, close, connect, finalize, getErrorSeverity, getReadTimeout, getResource, getSocket, processInput, setReadTimeout, setSocket, write

Methods inherited from class org.eclipse.soda.dk.transport.ThreadTransport

getBufferSize, getShutdownTimeout, getThread, handleNoData, handleNoInput, isRunning, processInput, processInput, run, setRunning, setThread, shutdown, start, stop

Methods inherited from class org.eclipse.soda.dk.transport.Transport

addHistory, addInterest, addTransportListener, broadcastMetrics, broadcastStatus, configure, createController, exit, fireErrorOccurred, fireMessageReceived, fireTransportChanged, getConfigurationInformation, getConfigurationInformation, getConfigurationService, getConnection, getController, getErrorCount, getHistory, getInformation, getInputMessageCount, getInterestMask, getKey, getLogDetails4, getLogDetails5, getLogLevel, getNoActivityTimeout, getNotificationPriority, getNotificationService, getPrefix, getPriority, getProperties, getQualifiedKey, getRetryTime, getSentMessageCount, getState, getStateChangeCount, getString, getStyle, getTransmitRetries, getTransportListener, handleError, hasListeners, isActive, isEcho, isReceivingData, isReceivingGoodData, isReceivingInput, isStarted, log, noActivityProcessing, noActivityProcessingMessage, prependPrefix, prependPrefix, putConfigurationInformation, read, removeInterest, removeTransportListener, restart, restartProcessing, send, send, setActive, setConfigurationInformation, setController, setEcho, setErrorCount, setHistory, setInformation, setInputMessageCount, setInterestMask, setLogLevel, setNoActivityTimeout, setNotificationService, setReceivingData, setReceivingData, setReceivingGoodData, setReceivingGoodData, setReceivingInput, setReceivingInput, setRetryTime, setSentMessageCount, setState, setStateChangeCount, setStyle, setTransmitRetries, setTransportListener, setupCustom, start, startup, startupMessageReceived, toString, updateErrorCount, updateInputMessageCount, updateSentMessageCount, waitStateChange, waitStateChange, write, writeAndReport, writeAndReport

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.soda.dk.core.service.ConfigurationService

getBoolean, getFloat, getInt, getLong, getObject

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

Defines the full class name.

See Also:

Constant Field Values

DEFAULT_LOCAL_HOST

public static final java.lang.String DEFAULT_LOCAL_HOST

Define the default local host (String) constant.

See Also:

Constant Field Values

DEFAULT_LOCAL_PORT_NUM

public static final int DEFAULT_LOCAL_PORT_NUM

Define the default local port num (int) constant.

See Also:

Constant Field Values

DEFAULT_REMOTE_HOST

public static final java.lang.String DEFAULT_REMOTE_HOST

Define the default remote host (String) constant.

See Also:

Constant Field Values

DEFAULT_SIZE

public static final int DEFAULT_SIZE

Define the default size (int) constant.

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

Define the default timeout (int) constant.

See Also:

Constant Field Values

Constructor Detail

MulticastTransport

public MulticastTransport()

Constructs a new instance of the MulticastTransport class.

MulticastTransport

public MulticastTransport(java.lang.String remoteHostString,
                          int remotePortNum,
                          java.lang.String localHostString,
                          int localPortNum,
                          int packetSize,
                          int readTimeout)

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

Parameters:

remoteHostString - java.lang.String

remotePortNum - int

localHostString - java.lang.String

localPortNum - int

packetSize - int

readTimeout - int

See Also:

MulticastTransport()

Method Detail

createSocket

protected java.net.DatagramSocket createSocket()
                                        throws java.io.IOException

Perform the createSocket method and return the DatagramSocket result.

Overrides:

createSocket in class UdpTransport

Returns:

Results of the create socket (DatagramSocket) value.

Throws:

java.io.IOException - IOException.

See Also:

UdpTransport.getSocket(), UdpTransport.setSocket(DatagramSocket)

getLocalhost

public java.lang.String getLocalhost()

Gets the value of localhost custom parameter.

Overrides:

getLocalhost in class UdpTransport

Returns:

localhost custom parameter.

See Also:

setLocalhost(java.lang.String)

getLocalport

public int getLocalport()

Gets the value of localport custom parameter.

Overrides:

getLocalport in class UdpTransport

Returns:

localport custom parameter.

See Also:

setLocalport(int)

getPacketsize

public int getPacketsize()

Gets the value of packetsize custom parameter.

Overrides:

getPacketsize in class UdpTransport

Returns:

packetsize custom parameter.

See Also:

setPacketsize(int)

getRemotehost

public java.lang.String getRemotehost()

Gets the value of remotehost custom parameter.

Overrides:

getRemotehost in class UdpTransport

Returns:

remotehost custom parameter.

See Also:

setRemotehost(java.lang.String)

getRemoteport

public int getRemoteport()

Gets the value of remoteport custom parameter.

Overrides:

getRemoteport in class UdpTransport

Returns:

remoteport custom parameter.

See Also:

setRemoteport(int)

setLocalhost

public void setLocalhost(java.lang.String localhost)

Sets the value of localhost custom parameter.

Overrides:

setLocalhost in class UdpTransport

Parameters:

localhost - The localhost custom parameter.

See Also:

getLocalhost()

setLocalport

public void setLocalport(int localport)

Sets the value of localport custom parameter.

Overrides:

setLocalport in class UdpTransport

Parameters:

localport - The localport custom parameter.

See Also:

getLocalport()

setPacketsize

public void setPacketsize(int packetsize)

Sets the value of packetsize custom parameter.

Overrides:

setPacketsize in class UdpTransport

Parameters:

packetsize - The packetsize custom parameter.

See Also:

getPacketsize()

setRemotehost

public void setRemotehost(java.lang.String remotehost)

Sets the value of remotehost custom parameter.

Overrides:

setRemotehost in class UdpTransport

Parameters:

remotehost - The remotehost custom parameter.

See Also:

getRemotehost()

setRemoteport

public void setRemoteport(int remoteport)

Sets the value of remoteport custom parameter.

Overrides:

setRemoteport in class UdpTransport

Parameters:

remoteport - The remoteport custom parameter.

See Also:

getRemoteport()

setup

public void setup()

Sets user-defined variables to use in the test.

User defined properties and default values.

multicasttransport.remotehost
multicasttransport.remoteport
multicasttransport.localhost
multicasttransport.localport
multicasttransport.packetsize
retrytime	DEFAULT_RETRY_TIME
noactivitytimeout	DEFAULT_NO_ACTIVITY_TIMEOUT

multicasttransport.remotehost= multicasttransport.remoteport= multicasttransport.localhost= multicasttransport.localport= multicasttransport.packetsize=

Overrides:

setup in class UdpTransport

See Also:

Transport.setup()