org.jlab.coda.emu.support.transport

Interface DataChannel

All Superinterfaces:

CODAStateMachine, StatedObject

All Known Implementing Classes:

DataChannelAdapter, DataChannelImplCmsg, DataChannelImplEmu, DataChannelImplEt, DataChannelImplFifo, DataChannelImplFile

public interface DataChannel
extends CODAStateMachine, StatedObject

This interface defines an object that can send and receive data. It refers to a single, particular connection (eg. a single socket or cMsg connection object).

Author:

heyes, timmer Created on Sep 12, 2008

Method Summary

Modifier and Type	Method and Description
DataTransport	getDataTransport() Get the DataTransport object used to create this data channel.
int	getID() Get the CODA ID number of the CODA component connected to this data channel.
int	getInputLevel() Get the relative fill level (0-100) of the ring of this input channel.
EmuModule	getModule() Get the module which created this channel.
int	getOutputLevel() Get the relative fill level (0-100) of all the rings of this output channel.
int	getOutputRingCount() Get the total number of data-holding output ring buffers.
int	getPrescale() Get the prescale value associated with this channel.
int	getRecordId() Get the record ID number of the latest event through this channel.
com.lmax.disruptor.RingBuffer<RingItem>	getRingBufferIn() Get the one and only input ring buffer of this data channel.
com.lmax.disruptor.RingBuffer<RingItem>[]	getRingBuffersOut() Get the array of output ring buffers.
TransportType	getTransportType() Get the type of transport this channel implements.
boolean	isInput() Get whether this channel is an input channel (true), or it is an output channel (false).
java.lang.String	name() Get the name of this data channel.
void	regulateOutputBufferRate(int eventsPerBuffer, double buffersPerSec) Turn on regulation of the flow of data through an output channel.
void	setDestinationBaList(java.lang.String[] baList) Set the output channel's list of destination broadcast addresses of emu TCP server when using emu sockets to communicate - each corresponding to the same element of the IpList.
void	setDestinationIpList(java.lang.String[] ipList) Set the output channel's list of possible destination IP addresses of emu TCP server when using emu sockets to communicate.
void	setRecordId(int recordId) Set the record ID number of the latest event through this channel.

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

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

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

getError, state

Method Detail

getTransportType

TransportType getTransportType()

Get the type of transport this channel implements.

Returns:

type of transport this channel implements.

getID

int getID()

Get the CODA ID number of the CODA component connected to this data channel. In event building, this is used, for example, to check the ROC id of incoming event which allows consistency checking.

Returns:

the CODA ID number the CODA component connected to this data channel.

getModule

EmuModule getModule()

Get the module which created this channel.

Returns:

module which created this channel.

getRecordId

int getRecordId()

Get the record ID number of the latest event through this channel. In CODA event building this is used, for example, to track the record ids for input events which allows consistency checks of incoming data.

Returns:

the record ID number of the latest event through channel.

setRecordId

void setRecordId(int recordId)

Set the record ID number of the latest event through this channel.

Parameters:

recordId - record ID number of the latest event through channel.

name

java.lang.String name()

Get the name of this data channel.

Returns:

the name of this data channel.

isInput

boolean isInput()

Get whether this channel is an input channel (true), or it is an output channel (false).

Returns:

true if input channel, else false

getDataTransport

DataTransport getDataTransport()

Get the DataTransport object used to create this data channel.

Returns:

the DataTransport object used to create this data channel.

getRingBufferIn

com.lmax.disruptor.RingBuffer<RingItem> getRingBufferIn()

Get the one and only input ring buffer of this data channel.

Returns:

the input ring buffer.

getOutputRingCount

int getOutputRingCount()

Get the total number of data-holding output ring buffers.

Returns:

total number of data-holding output ring buffers.

getRingBuffersOut

com.lmax.disruptor.RingBuffer<RingItem>[] getRingBuffersOut()

Get the array of output ring buffers.

Returns:

array of output ring buffers.

getInputLevel

int getInputLevel()

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

Returns:

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

getOutputLevel

int getOutputLevel()

Get the relative fill level (0-100) of all the rings of this output channel. Module calls this to report its output channels' levels. (Input levels are associated directly with the module).

Returns:

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

setDestinationIpList

void setDestinationIpList(java.lang.String[] ipList)

Set the output channel's list of possible destination IP addresses of emu TCP server when using emu sockets to communicate.

Parameters:

ipList - list of possible destination IP addresses if connecting to server.

setDestinationBaList

void setDestinationBaList(java.lang.String[] baList)

Set the output channel's list of destination broadcast addresses of emu TCP server when using emu sockets to communicate - each corresponding to the same element of the IpList.

Parameters:

baList - list of destination broadcast addresses each corresponding to the same element of the IpList.

getPrescale

int getPrescale()

Get the prescale value associated with this channel. Defaults to 1. Used only for ET output of ER.

Returns:

prescale value associated with this channel.

regulateOutputBufferRate

void regulateOutputBufferRate(int eventsPerBuffer,
                              double buffersPerSec)

Turn on regulation of the flow of data through an output channel. Currently this is implemented only for the emu socket channel - for testing purposes. It sets the rate of output buffers (typically 4MB each) and specifies the number of ROC (entangled) events per buffer.

Parameters:

eventsPerBuffer - events per output 4 MB buffer.

buffersPerSec - desired number of buffers to be sent per second.