org.jlab.coda.emu.support.transport

Class DataTransportAdapter

java.lang.Object

org.jlab.coda.emu.support.codaComponent.CODAStateMachineAdapter

org.jlab.coda.emu.support.transport.DataTransportAdapter

All Implemented Interfaces:

CODAStateMachine, StatedObject, DataTransport

Direct Known Subclasses:

DataTransportImplCmsg, DataTransportImplEmu, DataTransportImplEt, DataTransportImplFifo, DataTransportImplFile

public abstract class DataTransportAdapter
extends CODAStateMachineAdapter
implements DataTransport

This class provides a bare-bones implementation of the DataTransport interface (which includes the CODAStateMachine interface). Extending this class implements the DataTransport interface and frees any subclass from having to implement common methods or those that aren't used. The only exception is the abstract DataTransport.createChannel(java.lang.String, java.util.Map<java.lang.String, java.lang.String>, boolean, org.jlab.coda.emu.Emu, org.jlab.coda.emu.EmuModule, int) method which must be provided in subclasses.

Author:

heyes, timmer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	attr Map of attributes.
protected boolean	connected Is this object connected?
protected Emu	emu Emu object that created this transport.
protected java.util.concurrent.atomic.AtomicReference<java.lang.String>	errorMsg Possible error message.
protected boolean	isServer Does this DataTransport object receive data (server = true) or does it send data (server = false)?
protected Logger	logger Logging object associated with the emu that created this transport.
protected java.lang.String	name Name of this DataTransport object.
protected java.lang.String	transportClass Name of class extending this class.
protected CODAStateIF	transportState DataTransport object's state.

Constructor Summary

Constructors

Constructor and Description
DataTransportAdapter(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> attrib, Emu emu) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttr(java.lang.String name) This method gets an attribute as a String object.
java.lang.String	getError() Get any available error information.
int	getIntAttr(java.lang.String name) This method gets an attribute as an int.
java.lang.String	getTransportClass() This method gets the name of the transport class implementing this interface.
boolean	isConnected() This method tells if this DataTransport object is connected.
boolean	isServer() This method returns true if this DataTransport object is a server (sends data) or false if it is a client (receives data).
java.lang.String	name() This method gets the name of this DataTransport object.
void	reset() This method implements the RESET transition of the CODA run control state machine.
void	setAttr(java.lang.String name, java.lang.String value) This method sets an attribute.
void	setConnected(boolean connected) This method sets if this DataTransport object is connected or not.
void	setName(java.lang.String name) This method sets the name of this DataTransport object.
CODAStateIF	state() Get the state of this object.

Methods inherited from class org.jlab.coda.emu.support.codaComponent.CODAStateMachineAdapter

download, end, getEndCallback, getPrestartCallback, go, pause, prestart, registerEndCallback, registerPrestartCallback

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jlab.coda.emu.support.transport.DataTransport

createChannel

Methods inherited from interface org.jlab.coda.emu.support.codaComponent.CODAStateMachine

download, end, getEndCallback, getPrestartCallback, go, pause, prestart, registerEndCallback, registerPrestartCallback

Field Detail

name

protected java.lang.String name

Name of this DataTransport object.

transportState

protected CODAStateIF transportState

DataTransport object's state.

errorMsg

protected java.util.concurrent.atomic.AtomicReference<java.lang.String> errorMsg

Possible error message. reset() sets it back to null. Making this an atomically settable String ensures that only 1 thread at a time can change its value. That way it's only set once per error.

emu

protected Emu emu

Emu object that created this transport.

logger

protected Logger logger

Logging object associated with the emu that created this transport.

isServer

protected boolean isServer

Does this DataTransport object receive data (server = true) or does it send data (server = false)?

connected

protected boolean connected

Is this object connected?

transportClass

protected java.lang.String transportClass

Name of class extending this class.

attr

protected final java.util.Map<java.lang.String,java.lang.String> attr

Map of attributes.

Constructor Detail

DataTransportAdapter

public DataTransportAdapter(java.lang.String name,
                            java.util.Map<java.lang.String,java.lang.String> attrib,
                            Emu emu)
                     throws DataNotFoundException

Constructor.

Parameters:

name - name of this transport object

attrib - Map of attributes of this transport

emu - emu that created this transport

Throws:

DataNotFoundException - when "server" and "class" attributes are missing from attrib map.

Method Detail

getTransportClass

public java.lang.String getTransportClass()

This method gets the name of the transport class implementing this interface.

Specified by:

getTransportClass in interface DataTransport

Returns:

the name of the transport class implementing this interface

setName

public void setName(java.lang.String name)

This method sets the name of this DataTransport object.

Specified by:

setName in interface DataTransport

Parameters:

name - the name of this DataTransport object.

name

public java.lang.String name()

This method gets the name of this DataTransport object.

Specified by:

name in interface DataTransport

Returns:

the name of this DataTransport object.

state

public CODAStateIF state()

Get the state of this object.

Specified by:

state in interface StatedObject

Returns:

the state of this object

getError

public java.lang.String getError()

Get any available error information.

Specified by:

getError in interface StatedObject

Returns:

any available error information; null if none

setAttr

public void setAttr(java.lang.String name,
                    java.lang.String value)

This method sets an attribute.

Specified by:

setAttr in interface DataTransport

Parameters:

name - name of attribute (key)

value - value of attribute (val)

getAttr

public java.lang.String getAttr(java.lang.String name)
                         throws DataNotFoundException

This method gets an attribute as a String object.

Specified by:

getAttr in interface DataTransport

Parameters:

name - name of attribute

Returns:

value of attribute

Throws:

DataNotFoundException - if cannot find named attribute

getIntAttr

public int getIntAttr(java.lang.String name)
               throws DataNotFoundException

This method gets an attribute as an int.

Specified by:

getIntAttr in interface DataTransport

Parameters:

name - name of attribute

Returns:

value of attribute

Throws:

DataNotFoundException - if couldn't find named attribute

isServer

public boolean isServer()

This method returns true if this DataTransport object is a server (sends data) or false if it is a client (receives data).

Specified by:

isServer in interface DataTransport

Returns:

true if this DataTransport object sends data, else false

isConnected

public boolean isConnected()

This method tells if this DataTransport object is connected.

Specified by:

isConnected in interface DataTransport

Returns:

true if this object is connected, else false

setConnected

public void setConnected(boolean connected)

This method sets if this DataTransport object is connected or not.

Parameters:

connected - boolean: true if connected else false

reset

public void reset()

This method implements the RESET transition of the CODA run control state machine.

Specified by:

reset in interface CODAStateMachine

Overrides:

reset in class CODAStateMachineAdapter