ChannelFactory provides access to tine channels, by using a common tine layer for all requests that are targeted at the same address. More...

Public Member Functions
void	setValue (String address, Object value) throws ConnectionException
	Synchronously sets the value to the given property. More...

void	setValue (String address, Object value, TDataType outValue, int timeout) throws ConnectionException
	Synchronously sets the value to the given property. More...

void	setValueAsync (String address, Object value, ChannelCallback callback) throws ConnectionException
	Asynchronously sets the value to the given property. More...

void	setValueAsync (String address, Object value, TDataType outValue, int timeout, ChannelCallback callback) throws ConnectionException
	Asynchronously sets the value to the given property. More...

void	setRawValue (String address, TDataType value) throws ConnectionException
	Synchronously sets the value to the given property. More...

void	setRawValue (String address, TDataType value, TDataType outValue, int timeout) throws ConnectionException
	Synchronously sets the value to the given property. More...

void	setRawValueAsync (String address, TDataType value, ChannelCallback callback) throws ConnectionException
	Asynchronously sets the value to the given property. More...

void	setRawValueAsync (String address, TDataType value, TDataType outValue, int timeout, ChannelCallback callback) throws ConnectionException
	Asynchronously sets the value to the given property. More...

Object	getValue (String address) throws ConnectionException
	Makes a single synchronous connection to the address specified by parameters and returns the value. More...

Object	getValue (String address, TDataType dataOut, Object dataIn, int timeout) throws ConnectionException
	Makes a single synchronous connection to the address specified by parameters and returns the value. More...

Object	getValueSync (String address) throws ConnectionException
	Makes a true single synchronous connection to the address specified by parameters and returns the value. More...

Object	getValueSync (String address, TDataType dataOut, Object dataIn, int timeout) throws ConnectionException
	Makes a true single synchronous connection to the address specified by parameters and returns the value. More...

void	getValueAsync (String address, ChannelCallback callback) throws ConnectionException
	Makes an asynchronous connection to the tine property specified by the device and property. More...

void	getValueAsync (String address, ChannelCallback callback, Object dataIn) throws ConnectionException
	Makes an asynchronous connection to the tine property specified by the device and property. More...

TDataType	getRawValue (String address) throws ConnectionException
	Makes a single synchronous connection to the address specified by parameters and returns the value. More...

TDataType	getRawValue (String address, TFormat outFormat, int outSize, Object dataIn) throws ConnectionException
	Makes a single synchronous connection to the address specified by parameters and returns the value. More...

TDataType	getRawValueSync (String address) throws ConnectionException
	Makes a true single synchronous connection (TINE synchronous link) to the address specified by parameters and returns the value. More...

TDataType	getRawValueSync (String address, TFormat outFormat, int outSize, Object dataIn) throws ConnectionException
	Makes a true single synchronous connection (TINE synchronous link) to the address specified by parameters and returns the value. More...

TDataType	getRawValue (String address, TFormat outFormat, int outSize, Object dataIn, boolean synchronousCall) throws ConnectionException
	Makes a single synchronous connection to the address specified by parameters and returns the value. More...

Channel	getChannel (String address, ConnectionMode mode, int rate, ChannelCallback callback) throws ConnectionException
	Creates a channel that receives notifications according to the given connection mode and rate. More...

Channel	getChannel (String address, ConnectionMode mode, int rate, ChannelCallback callback, Object dataIn) throws ConnectionException
	Creates a channel that receives notifications according to the given connection mode and rate. More...

Channel	getChannel (String address, TFormat dataOutFormat, int dataOutSize, ConnectionMode mode, int rate, ChannelCallback callback) throws ConnectionException
	Creates a channel that receives notifications according to the given connection mode and rate. More...

Channel	getChannel (String address, TFormat dataOutFormat, int dataOutSize, Object dataIn, ConnectionMode mode, int rate, ChannelCallback callback) throws ConnectionException
	Creates a channel that receives notifications according to the given connection mode and rate. More...

Channel	getChannel (String address, TDataType dataOutObject, Object dataIn, ConnectionMode mode, int rate, ChannelCallback callback) throws ConnectionException
	Creates a channel that receives notifications according to the given connection mode and rate. More...

void	close ()
	Close all active links, interrupt all running threads.

Static Public Member Functions
static synchronized ChannelFactory	getInstance ()

Static Public Attributes
static final String	LINK_KEEP_ALIVE_MSEC = "tine.layer.keepAlive"
	The time for how long single read links are kept alive after no longer needed.

static final String	MAX_KEEP_ALIVE_MSEC = "tine.layer.maxKeepAlive"
	The maximum time how long an links are opened after no longer needed.

Detailed Description

ChannelFactory provides access to tine channels, by using a common tine layer for all requests that are targeted at the same address.

Author: Jaka Bobnar

Member Function Documentation

◆ getChannel() [1/5]

Channel de.desy.tine.accesslayer.ChannelFactory.getChannel	(	String	address,
		ConnectionMode	mode,
		int	rate,
		ChannelCallback	callback
	)		throws ConnectionException

Creates a channel that receives notifications according to the given connection mode and rate.

If connection mode is CHANGE the callback will receive a notification every time the value changes, if the connection mod is POLL the callback will receive notifications at the specified rate, if the mode is single the callback will receive a single notification. The connection is created using the default data format and size.

Parameters

address	the property to connect to
mode	the connection mode
rate	the notification rate in milliseconds
callback	the callback to receive notifications

Returns: channel connected to the given property that receives notification according to the policy

Exceptions

ConnectionException if there was an error establishing connection

Referenced by de.desy.tine.accesslayer.ChannelFactory.getChannel(), de.desy.tine.accesslayer.ChannelFactory.getRawValue(), and de.desy.tine.accesslayer.ChannelFactory.getValueAsync().

◆ getChannel() [2/5]

Channel de.desy.tine.accesslayer.ChannelFactory.getChannel	(	String	address,
		ConnectionMode	mode,
		int	rate,
		ChannelCallback	callback,
		Object	dataIn
	)		throws ConnectionException

Creates a channel that receives notifications according to the given connection mode and rate.

If connection mode is CHANGE the callback will receive a notification every time the value changes, if the connection mod is POLL the callback will receive notifications at the specified rate, if the mode is single the callback will receive a single notification. The connection is created using the default data format and size.

Parameters

address	the property to connect to
mode	the connection mode
rate	the notification rate in milliseconds
callback	the callback to receive notifications
dataIn	the input data for the monitor

Returns: channel connected to the given property that receives notification according to the policy

Exceptions

ConnectionException if there was an error establishing connection

References de.desy.tine.accesslayer.ChannelFactory.getChannel().

◆ getChannel() [3/5]

Channel de.desy.tine.accesslayer.ChannelFactory.getChannel	(	String	address,
		TDataType	dataOutObject,
		Object	dataIn,
		ConnectionMode	mode,
		int	rate,
		ChannelCallback	callback
	)		throws ConnectionException

Creates a channel that receives notifications according to the given connection mode and rate.

If connection mode is CHANGE the callback will receive a notification every time the value changes, if the connection mod is POLL the callback will receive notifications at the specified rate, if the mode is single the callback will receive a single notification. The connection is created using the format and size given in the dataOutObject, which will be assigned the output value upon completion.

Parameters

address	the property to connect to
dataOutObject	the object into which the output data will be written
dataIn	some channels require input data to successfully read their values; the data are provided by the given parameter
mode	the connection mode
rate	the notification rate in milliseconds
callback	the callback to receive notifications

Returns: channel connected to the given property that receives notification according to the policy

Exceptions

ConnectionException if there was an error establishing connection

References de.desy.tine.accesslayer.ChannelFactory.getChannel(), and de.desy.tine.definitions.TFormat.valueOf().

◆ getChannel() [4/5]

Channel de.desy.tine.accesslayer.ChannelFactory.getChannel	(	String	address,
		TFormat	dataOutFormat,
		int	dataOutSize,
		ConnectionMode	mode,
		int	rate,
		ChannelCallback	callback
	)		throws ConnectionException

Creates a channel that receives notifications according to the given connection mode and rate.

If connection mode is CHANGE the callback will receive a notification every time the value changes, if the connection mod is POLL the callback will receive notifications at the specified rate, if the mode is single the callback will receive a single notification. The connection is created using the given format and size. Depending on the server, the request might fail if the format and size are not compatible.

Parameters

address	the property to connect to
dataOutFormat	the requested output format; channel will provide data in this format
dataOutSize	the requested output size; channel will provide data of this size
mode	the connection mode
rate	the notification rate in milliseconds
callback	the callback to receive notifications

Returns: channel connected to the given property that receives notification according to the policy

Exceptions

ConnectionException if there was an error establishing connection

References de.desy.tine.accesslayer.ChannelFactory.getChannel().

◆ getChannel() [5/5]

Channel de.desy.tine.accesslayer.ChannelFactory.getChannel	(	String	address,
		TFormat	dataOutFormat,
		int	dataOutSize,
		Object	dataIn,
		ConnectionMode	mode,
		int	rate,
		ChannelCallback	callback
	)		throws ConnectionException

Creates a channel that receives notifications according to the given connection mode and rate.

If connection mode is CHANGE the callback will receive a notification every time the value changes, if the connection mod is POLL the callback will receive notifications at the specified rate, if the mode is single the callback will receive a single notification. The connection is created using the given format and size. Depending on the server, the request might fail if the format and size are not compatible with property type.

Parameters

address	the property to connect to
dataOutFormat	the requested output format; channel will provide data in this format
dataOutSize	the requested output size; channel will provide data of this size
dataIn	some channels require input data to successfully read their values; the data are provided by the given parameter
mode	the connection mode
rate	the notification rate in milliseconds
callback	the callback to receive notifications

Returns: channel connected to the given property that receives notification according to the policy

Exceptions

ConnectionException if there was an error establishing connection

References de.desy.tine.accesslayer.ChannelFactory.getChannel(), and de.desy.tine.definitions.TFormat.valueOf().

◆ getInstance()

static synchronized ChannelFactory de.desy.tine.accesslayer.ChannelFactory.getInstance ( )

static

Returns: the singleton instance of the factory

◆ getRawValue() [1/3]

TDataType de.desy.tine.accesslayer.ChannelFactory.getRawValue ( String address ) throws ConnectionException

Makes a single synchronous connection to the address specified by parameters and returns the value.

If the value read failed a ConnectionException is thrown.

Parameters

device	device name to connect to
property	property name to connect to

Returns: the value of the property

Exceptions

ConnectionException if connection failed

Referenced by de.desy.tine.accesslayer.ChannelFactory.getRawValue(), and de.desy.tine.accesslayer.ChannelFactory.getRawValueSync().

◆ getRawValue() [2/3]

TDataType de.desy.tine.accesslayer.ChannelFactory.getRawValue	(	String	address,
		TFormat	outFormat,
		int	outSize,
		Object	dataIn
	)		throws ConnectionException

Makes a single synchronous connection to the address specified by parameters and returns the value.

If the value read failed a ConnectionException is thrown.

Parameters

address	property name to connect to
outFormat	requested data out format
outSize	requested data out size
dataIn	input data of the read request
mode	the connection mode used

Returns: the value of the property

Exceptions

ConnectionException if connection failed

References de.desy.tine.accesslayer.ChannelFactory.getRawValue().

◆ getRawValue() [3/3]

TDataType de.desy.tine.accesslayer.ChannelFactory.getRawValue	(	String	address,
		TFormat	outFormat,
		int	outSize,
		Object	dataIn,
		boolean	synchronousCall
	)		throws ConnectionException

Makes a single synchronous connection to the address specified by parameters and returns the value.

If the value read failed a ConnectionException is thrown.

Parameters

address	property name to connect to
outFormat	requested data out format
outSize	requested data out size
dataIn	input data of the read request
mode	the connection mode used
synchronousCall	true to use a synchronous TINE link or false to use asynchronous link but still blocking this thread

Returns: the value of the property

Exceptions

ConnectionException if connection failed

References de.desy.tine.accesslayer.ChannelFactory.getChannel(), de.desy.tine.accesslayer.Channel.getRawValue(), de.desy.tine.accesslayer.Channel.getStatus(), de.desy.tine.accesslayer.Channel.getStatusString(), de.desy.tine.definitions.TErrorList.hasData(), and de.desy.tine.definitions.TErrorList.toString().

◆ getRawValueSync() [1/2]

TDataType de.desy.tine.accesslayer.ChannelFactory.getRawValueSync ( String address ) throws ConnectionException

Makes a true single synchronous connection (TINE synchronous link) to the address specified by parameters and returns the value.

If the value read failed a ConnectionException is thrown.

Parameters

device	device name to connect to
property	property name to connect to

Returns: the value of the property

Exceptions

ConnectionException if connection failed

References de.desy.tine.accesslayer.ChannelFactory.getRawValue().

◆ getRawValueSync() [2/2]

TDataType de.desy.tine.accesslayer.ChannelFactory.getRawValueSync	(	String	address,
		TFormat	outFormat,
		int	outSize,
		Object	dataIn
	)		throws ConnectionException

Makes a true single synchronous connection (TINE synchronous link) to the address specified by parameters and returns the value.

If the value read failed a ConnectionException is thrown.

Parameters

address	property name to connect to
outFormat	requested data out format
outSize	requested data out size
dataIn	input data of the read request
mode	the connection mode used

Returns: the value of the property

Exceptions

ConnectionException if connection failed

References de.desy.tine.accesslayer.ChannelFactory.getRawValue().

◆ getValue() [1/2]

Object de.desy.tine.accesslayer.ChannelFactory.getValue ( String address ) throws ConnectionException

Makes a single synchronous connection to the address specified by parameters and returns the value.

If the value read failed a ConnectionException is thrown.

Parameters

address property name to connect to

Returns: the value of the property

Exceptions

ConnectionException if connection failed

Referenced by de.desy.tine.accesslayer.ChannelFactory.getValue(), and de.desy.tine.accesslayer.ChannelFactory.getValueSync().

◆ getValue() [2/2]

Object de.desy.tine.accesslayer.ChannelFactory.getValue	(	String	address,
		TDataType	dataOut,
		Object	dataIn,
		int	timeout
	)		throws ConnectionException

Makes a single synchronous connection to the address specified by parameters and returns the value.

If the value read failed a ConnectionException is thrown.

Parameters

address	property name to connect to
dataout	the object to received the output data
dataIn	input data of the read request
timeout	the timeout in milliseconds after which the call will return terminated

Returns: the value of the property

Exceptions

ConnectionException if connection failed

References de.desy.tine.accesslayer.ChannelFactory.getValue().

◆ getValueAsync() [1/2]

void de.desy.tine.accesslayer.ChannelFactory.getValueAsync	(	String	address,
		ChannelCallback	callback
	)		throws ConnectionException

Makes an asynchronous connection to the tine property specified by the device and property.

When the value is received it is forwarded to the given callback. If the connection could not be established an exception is thrown.

Parameters

address	the property name
callback	callback to receive notifications

Exceptions

ConnectionException if there was an error establishing the connection

References de.desy.tine.accesslayer.ChannelFactory.getChannel().

◆ getValueAsync() [2/2]

void de.desy.tine.accesslayer.ChannelFactory.getValueAsync	(	String	address,
		ChannelCallback	callback,
		Object	dataIn
	)		throws ConnectionException

Makes an asynchronous connection to the tine property specified by the device and property.

When the value is received it is forwarded to the given callback. If the connection could not be established an exception is thrown.

Parameters

address	the full property name
dataIn	the input object of the read request
callback	callback to receive notifications

Exceptions

ConnectionException if there was an error establishing the connection

References de.desy.tine.accesslayer.ChannelFactory.getChannel().

◆ getValueSync() [1/2]

Object de.desy.tine.accesslayer.ChannelFactory.getValueSync ( String address ) throws ConnectionException

Makes a true single synchronous connection to the address specified by parameters and returns the value.

If the value read failed a ConnectionException is thrown.

Parameters

address property name to connect to

Returns: the value of the property

Exceptions

ConnectionException if connection failed

References de.desy.tine.accesslayer.ChannelFactory.getValue().

◆ getValueSync() [2/2]

Object de.desy.tine.accesslayer.ChannelFactory.getValueSync	(	String	address,
		TDataType	dataOut,
		Object	dataIn,
		int	timeout
	)		throws ConnectionException

Makes a true single synchronous connection to the address specified by parameters and returns the value.

If the value read failed a ConnectionException is thrown.

Parameters

address	property name to connect to
dataout	the object to received the output data
dataIn	input data of the read request
timeout	the timeout in milliseconds after which the call will return terminated

Returns: the value of the property

Exceptions

ConnectionException if connection failed

References de.desy.tine.accesslayer.ChannelFactory.getValue().

◆ setRawValue() [1/2]

void de.desy.tine.accesslayer.ChannelFactory.setRawValue	(	String	address,
		TDataType	value
	)		throws ConnectionException

Synchronously sets the value to the given property.

Upon success method does not return anything. If the write fails an exception si thrown, describing the error.

Parameters

address	the proeprty to write to
value	the value to write

Exceptions

ConnectionException if write failed for any reason

◆ setRawValue() [2/2]

void de.desy.tine.accesslayer.ChannelFactory.setRawValue	(	String	address,
		TDataType	value,
		TDataType	outValue,
		int	timeout
	)		throws ConnectionException

Synchronously sets the value to the given property.

Upon success method does not return anything; however the outValue does receive the readback value. If the write fails an exception si thrown, describing the error.

Parameters

address	the proeprty to write to
value	the value to write
outValue	the data type that will receive the readback value after write is completed
timeout	the timeout in milliseconds

Exceptions

ConnectionException if write failed for any reason

◆ setRawValueAsync() [1/2]

void de.desy.tine.accesslayer.ChannelFactory.setRawValueAsync	(	String	address,
		TDataType	value,
		ChannelCallback	callback
	)		throws ConnectionException

Asynchronously sets the value to the given property.

Upon completed write the callback is notified, either through ChannelCallback#writeCompleted(Object) or ChannelCallback#writeFailed(Object, int).

Parameters

address	the property to connect to
value	the value to set
callback	the callback to be notified

Exceptions

ConnectionException if establishing the connection failed

◆ setRawValueAsync() [2/2]

void de.desy.tine.accesslayer.ChannelFactory.setRawValueAsync	(	String	address,
		TDataType	value,
		TDataType	outValue,
		int	timeout,
		ChannelCallback	callback
	)		throws ConnectionException

Asynchronously sets the value to the given property.

Upon completed write the callback is notified, either through ChannelCallback#writeCompleted(Object) or ChannelCallback#writeFailed(Object, int). The readback value is also applied to the given outValue parameter.

Parameters

address	the property to connect to
value	the value to set
outValue	the data type that will receive the readback value after write is completed
timeout	the timeout in milliseconds
callback	the callback to be notified

Exceptions

ConnectionException if establishing the connection failed

◆ setValue() [1/2]

void de.desy.tine.accesslayer.ChannelFactory.setValue	(	String	address,
		Object	value
	)		throws ConnectionException

Synchronously sets the value to the given property.

Upon success method does not return anything. If the write fails an exception si thrown, describing the error.

Parameters

address	the proeprty to write to
value	the value to write

Exceptions

ConnectionException if write failed for any reason

◆ setValue() [2/2]

void de.desy.tine.accesslayer.ChannelFactory.setValue	(	String	address,
		Object	value,
		TDataType	outValue,
		int	timeout
	)		throws ConnectionException

Synchronously sets the value to the given property.

Upon success method does not return anything, but it does read the value and applies it to the given outValue parameter (the action is atomic). If the write fails an exception is thrown, describing the error.

Parameters

address	the proeprty to write to
value	the value to write
outValue	the data type that will receive the readback value after write is completed
timeout	the timeout in milliseconds

Exceptions

ConnectionException if write failed for any reason

◆ setValueAsync() [1/2]

void de.desy.tine.accesslayer.ChannelFactory.setValueAsync	(	String	address,
		Object	value,
		ChannelCallback	callback
	)		throws ConnectionException

Asynchronously sets the value to the given property.

Upon completed write the callback is notified, either through ChannelCallback#writeCompleted(Object) or ChannelCallback#writeFailed(Object, int).

Parameters

address	the property to connect to
value	the value to set
callback	the callback to be notified

Exceptions

ConnectionException if establishing the connection failed

◆ setValueAsync() [2/2]

void de.desy.tine.accesslayer.ChannelFactory.setValueAsync	(	String	address,
		Object	value,
		TDataType	outValue,
		int	timeout,
		ChannelCallback	callback
	)		throws ConnectionException

Asynchronously sets the value to the given property.

Upon completed write the callback is notified, either through ChannelCallback#writeCompleted(Object) or ChannelCallback#writeFailed(Object, int). The outValue also receives the readback value.

Parameters

address	the property to connect to
value	the value to set
outValue	the data type that will receive the readback value after write is completed
callback	the callback to be notified
timeout	the timeout in milliseconds

Exceptions

ConnectionException if establishing the connection failed

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

ChannelFactory.java

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getChannel() [1/5]

◆ getChannel() [2/5]

◆ getChannel() [3/5]

◆ getChannel() [4/5]

◆ getChannel() [5/5]

◆ getInstance()

◆ getRawValue() [1/3]

◆ getRawValue() [2/3]

◆ getRawValue() [3/3]

◆ getRawValueSync() [1/2]

◆ getRawValueSync() [2/2]

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getValueAsync() [1/2]

◆ getValueAsync() [2/2]

◆ getValueSync() [1/2]

◆ getValueSync() [2/2]

◆ setRawValue() [1/2]

◆ setRawValue() [2/2]

◆ setRawValueAsync() [1/2]

◆ setRawValueAsync() [2/2]

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ setValueAsync() [1/2]

◆ setValueAsync() [2/2]