org.jlab.coda.emu.support.transport

Class DataChannelImplFifo

java.lang.Object

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

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

org.jlab.coda.emu.support.transport.DataChannelImplFifo

All Implemented Interfaces:

CODAStateMachine, StatedObject, DataChannel

public class DataChannelImplFifo
extends DataChannelAdapter

This class implements a DataChannel to act as a fifo. The FIFO channel is unlike other channels. Other channels are either input or output meaning they either supply data to a module or allow a module to write data out. The FIFO channel acts as both. On one side of a FIFO is a module which produces data and expects the FIFO to accept it into ring buffers (like a standard output channel), and on the other is a module which reads data from the FIFO (like a standard input channel). Thus the FIFO is both an input and output channel. The thread which this class contains moves the data from the output side to the input side - seems backwards doesn't it?.

Author:

heyes, timmer (Nov 10, 2008)

Nested Class Summary

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

DataChannelAdapter.ThreadState

Field Summary

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, pause, prescale, prestartCallback, recordId, regulateBufferRate, ringBufferIn, ringBuffersOut, ringIndex, sequenceBarriers, sequences, singleEventOut, totalRingCapacity

Constructor Summary

Constructors

Constructor and Description
DataChannelImplFifo(java.lang.String name, DataTransportImplFifo transport, java.util.Map<java.lang.String,java.lang.String> attributeMap, boolean input, Emu emu, EmuModule module) Constructor DataChannelImplFifo creates a new DataChannelImplFifo instance.

Method Summary

Modifier and Type	Method and Description
void	end() This method implements the END transition of the CODA run control state machine.
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	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, getInputLevel, getModule, getNextOutputRingItem, getNextSequence, getOutputLevel, getOutputRingCount, getPrescale, getPrestartCallback, getRecordId, getRingBufferIn, getRingBuffersOut, gotoNextRingItem, isInput, name, prestart, 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

Constructor Detail

DataChannelImplFifo

DataChannelImplFifo(java.lang.String name,
                    DataTransportImplFifo transport,
                    java.util.Map<java.lang.String,java.lang.String> attributeMap,
                    boolean input,
                    Emu emu,
                    EmuModule module)

Constructor DataChannelImplFifo creates a new DataChannelImplFifo instance.

Parameters:

name - of type String

transport - of type DataTransport

attributeMap - the hashmap of config file attributes for this channel

input - true if this is an input

emu - Emu owning this channel

module - module this channel belongs to

Method Detail

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.

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.

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.

Specified by:

reset in interface CODAStateMachine

Overrides:

reset in class CODAStateMachineAdapter