org.jlab.coda.emu.support.transport

Class DataChannelImplCmsg

java.lang.Object

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

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

org.jlab.coda.emu.support.transport.DataChannelImplCmsg

All Implemented Interfaces:

CODAStateMachine, StatedObject, DataChannel

public class DataChannelImplCmsg
extends DataChannelAdapter

This class implement a data channel which gets data from or sends data to a cMsg server.

Author:

timmer (Dec 2, 2009)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	DataChannelImplCmsg.ReceiveMsgCallback This class defines the callback to be run when a message matching the subscription arrives.

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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	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, 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

DataChannelImplCmsg

DataChannelImplCmsg(java.lang.String name,
                    DataTransportImplCmsg 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 DataChannelImplCmsg instance. Used only by DataTransportImplCmsg.createChannel(String, Map, boolean, Emu, EmuModule, int) which is only used during PRESTART in the EmuModuleFactory.

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

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.

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.. Reset this channel by interrupting the message sending threads and unsubscribing.

Specified by:

reset in interface CODAStateMachine

Overrides:

reset in class CODAStateMachineAdapter