de.desy.tine.definitions.TMode Class Reference

TINE access modes and modifiers. More...

Static Public Member Functions
static boolean	canClose (int mode)
static boolean	canTimeOut (int mode)
static final short	getBaseMode (int mode)
	The base mode for the specified mode parameter. More...
static String	toString (int mode)
	The string representation for the specified mode parameter. More...
static boolean	isActive (int mode)
static boolean	isConnected (int mode)
static boolean	isStream (int mode)
static boolean	isTcpIp (int mode)
static boolean	isNetwork (int mode)
static boolean	isSynchronous (int mode)
static boolean	isDataChange (int mode)
static boolean	isEvent (int mode)
static boolean	isTimer (int mode)
static boolean	isPlaceHolder (int mode)
static boolean	isGrouped (int mode)
static boolean	isWaiting (int mode)
static boolean	isGlobal (int mode)
static boolean	hasLongDeadband (int mode)

Detailed Description

TINE access modes and modifiers.

Member Function Documentation

canClose()

static boolean de.desy.tine.definitions.TMode.canClose ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is allowed to send a CM_CLOSE signal to a server.

References de.desy.tine.definitions.TMode.getBaseMode().

Referenced by de.desy.tine.client.TLink.execute().

canTimeOut()

static boolean de.desy.tine.definitions.TMode.canTimeOut ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode can generate local timeout signals.

References de.desy.tine.definitions.TMode.getBaseMode().

getBaseMode()

static final short de.desy.tine.definitions.TMode.getBaseMode ( int  mode )

static

The base mode for the specified mode parameter.

Parameters

mode	is the mode parameter for which the base transfer mode (CM_SINGLE to CM_GLOBAL) is desired

Returns

The base mode for the specified mode parameter

Referenced by de.desy.tine.definitions.TMode.canClose(), de.desy.tine.definitions.TMode.canTimeOut(), de.desy.tine.client.TLink.execute(), de.desy.tine.client.TLink.executeAndListen(), and de.desy.tine.definitions.TMode.isActive().

hasLongDeadband()

static boolean de.desy.tine.definitions.TMode.hasLongDeadband ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode has a long deadband before registering a timeout

isActive()

static boolean de.desy.tine.definitions.TMode.isActive ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode designates an active link

References de.desy.tine.definitions.TMode.getBaseMode().

Referenced by de.desy.tine.client.TLink.execute().

isConnected()

static boolean de.desy.tine.definitions.TMode.isConnected ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is using a connected tcp/ip or stream socket.

Referenced by de.desy.tine.client.TLink.execute().

isDataChange()

static boolean de.desy.tine.definitions.TMode.isDataChange ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is of a DATACHANGE type

isEvent()

static boolean de.desy.tine.definitions.TMode.isEvent ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is of an EVENT type

isGlobal()

static boolean de.desy.tine.definitions.TMode.isGlobal ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode designates a globals link (receiving globals multicasts).

isGrouped()

static boolean de.desy.tine.definitions.TMode.isGrouped ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode designates a grouped callback.

isNetwork()

static boolean de.desy.tine.definitions.TMode.isNetwork ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is receiving network multicasts.

isPlaceHolder()

static boolean de.desy.tine.definitions.TMode.isPlaceHolder ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is merely CM_REGISTER

isStream()

static boolean de.desy.tine.definitions.TMode.isStream ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is using a streaming tcp/ip socket.

isSynchronous()

static boolean de.desy.tine.definitions.TMode.isSynchronous ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is of a SINGLE type

Note

this does not necessarily imply 'synchronous' transfer

isTcpIp()

static boolean de.desy.tine.definitions.TMode.isTcpIp ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is using a connected tcp/ip socket.

isTimer()

static boolean de.desy.tine.definitions.TMode.isTimer ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is of a TIMER type

isWaiting()

static boolean de.desy.tine.definitions.TMode.isWaiting ( int  mode )

static

Parameters

mode	is the targeted transfer mode

Returns

true if the transfer mode is starting in a 'wait' state.

toString()

static String de.desy.tine.definitions.TMode.toString ( int  mode )

static

The string representation for the specified mode parameter.

Parameters

mode	is the mode parameter for which the string representation is desired

Returns

The string representation for the specified mode parameter

---

The documentation for this class was generated from the following file:

• TMode.java