org.jlab.coda.emu.support.transport

Class DataChannelImplEmu

java.lang.Object

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

org.jlab.coda.emu.support.transport.DataChannelAdapter

org.jlab.coda.emu.support.transport.DataChannelImplEmu

All Implemented Interfaces:

CODAStateMachine, StatedObject, DataChannel

public class DataChannelImplEmu
extends DataChannelAdapter

This class implement a data channel which gets-data-from/sends-data-to an Emu domain client/server.

Author:

timmer (4/23/2014)

Nested Class Summary

Nested classes/interfaces inherited from class org.jlab.coda.emu.support.transport.DataChannelAdapter

DataChannelAdapter.ThreadState

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteBufferSupply[]	bbInSupply Ring buffer holding ByteBuffers when using EvioCompactEvent reader for incoming events.

Fields inherited from class org.jlab.coda.emu.support.transport.DataChannelAdapter

availableSequences, bAddrList, buffersPerSec, byteOrder, channelState, dataTransport, emu, endCallback, errorMsg, eventsPerBuffer, gotEndCmd, gotResetCmd, id, ignoreDataErrors, input, inputRingItemCount, ipAddrList, isFifo, logger, module, name, nanoSecPerBuf, nextEvent, nextSequences, outputChannelCount, outputChannelFill, outputIndex, outputModuleInternalRingCount, outputRingCount, outputRingItemCount, prescale, prestartCallback, regulateBufferRate, ringBufferIn, ringBuffersOut, ringIndex, sequenceBarriers, sequences, singleEventOut, totalRingCapacity

Constructor Summary

Constructors

Constructor and Description
DataChannelImplEmu(java.lang.String name, DataTransportImplEmu transport, java.util.Map<java.lang.String,java.lang.String> attributeMap, boolean input, Emu emu, EmuModule module, int outputIndex) Constructor to create a new DataChannelImplEt instance.

Method Summary

Modifier and Type	Method and Description
(package private) void	attachToInput(java.nio.channels.SocketChannel channel, int sourceId, int maxBufferSize, int socketCount, int socketPosition) Once a client connects to the Emu domain server in the Emu transport object, that socket is passed to this method and a thread is spawned to handle all communications over it.
void	end() This method implements the END transition of the CODA run control state machine.
int	getInputLevel() Get the relative fill level (0-100) of the ring of this input channel.
TransportType	getTransportType() Get the type of transport this channel implements.
void	go() This method implements the GO transition of the CODA run control state machine.
void	pause() This method implements the PAUSE transition of the CODA run control state machine.
void	prestart() This method implements the PRESTART transition of the CODA run control state machine.
void	reset() This method implements the RESET transition of the CODA run control state machine.

Methods inherited from class org.jlab.coda.emu.support.transport.DataChannelAdapter

getDataTransport, getEndCallback, getError, getID, getModule, getNextOutputRingItem, getNextSequence, getOutputLevel, getOutputRingCount, getPrescale, getPrestartCallback, getRecordId, getRingBufferIn, getRingBuffersOut, gotoNextRingItem, isInput, name, registerEndCallback, registerPrestartCallback, regulateOutputBufferRate, releaseCurrentAndGoToNextOutputRingItem, releaseOutputRingItem, sequentialReleaseOutputRingItem, setDestinationBaList, setDestinationIpList, setNextEventAndRing, setRecordId, setupInputRingBuffers, setupOutputRingBuffers, state

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

download

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.codaComponent.CODAStateMachine

download

Field Detail

bbInSupply

protected ByteBufferSupply[] bbInSupply

Ring buffer holding ByteBuffers when using EvioCompactEvent reader for incoming events. One per socket (socketCount total).

Constructor Detail

DataChannelImplEmu

DataChannelImplEmu(java.lang.String name,
                   DataTransportImplEmu transport,
                   java.util.Map<java.lang.String,java.lang.String> attributeMap,
                   boolean input,
                   Emu emu,
                   EmuModule module,
                   int outputIndex)
            throws DataTransportException

Constructor to create a new DataChannelImplEt instance. Used only by DataTransportImplEt.createChannel(String, Map, boolean, Emu, EmuModule, int) which is only used during PRESTART in Emu.

Parameters:

name - the name of this channel

transport - the DataTransport object that this channel belongs to

attributeMap - the hashmap of config file attributes for this channel

input - true if this is an input data channel, otherwise false

emu - emu this channel belongs to

module - module this channel belongs to

outputIndex - order in which module's events will be sent to this output channel (0 for first output channel, 1 for next, etc.).

Throws:

DataTransportException - - unable to create buffers or socket.

Method Detail

attachToInput

final void attachToInput(java.nio.channels.SocketChannel channel,
                         int sourceId,
                         int maxBufferSize,
                         int socketCount,
                         int socketPosition)
                  throws java.io.IOException

Once a client connects to the Emu domain server in the Emu transport object, that socket is passed to this method and a thread is spawned to handle all communications over it. Only used for input channel.

This method is called synchronously by a single thread in the EmuDomainTcpServer class.

Parameters:

channel - data input socket/channel

sourceId - CODA id # of data source

maxBufferSize - biggest chunk of data expected to be sent by data producer

socketCount - total # of sockets data producer will be making

socketPosition - position with respect to other data producers: 1, 2 ...

Throws:

java.io.IOException - if exception dealing with socket or input stream

getTransportType

public TransportType getTransportType()

Get the type of transport this channel implements.

Specified by:

getTransportType in interface DataChannel

Specified by:

getTransportType in class DataChannelAdapter

Returns:

type of transport this channel implements.

getInputLevel

public int getInputLevel()

Get the relative fill level (0-100) of the ring of this input channel.

Specified by:

getInputLevel in interface DataChannel

Overrides:

getInputLevel in class DataChannelAdapter

Returns:

relative fill level (0-100) of all the ring.

prestart

public void prestart()
              throws CmdExecException

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

Specified by:

prestart in interface CODAStateMachine

Overrides:

prestart in class DataChannelAdapter

Throws:

CmdExecException - if error during command execution.

go

public void go()

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

Specified by:

go in interface CODAStateMachine

Overrides:

go in class CODAStateMachineAdapter

pause

public void pause()

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

Specified by:

pause in interface CODAStateMachine

Overrides:

pause in class CODAStateMachineAdapter

end

public void end()

This method implements the END transition of the CODA run control state machine.. Formerly this code was the close() method.

Specified by:

end in interface CODAStateMachine

Overrides:

end in class CODAStateMachineAdapter

reset

public void reset()

This method implements the RESET transition of the CODA run control state machine. Reset this channel by interrupting the data sending threads and closing ET system.

Specified by:

reset in interface CODAStateMachine

Overrides:

reset in class CODAStateMachineAdapter