de.desy.tine.accesslayer.ChannelCallback Interface Reference

ChannelCallback is the callback interface that receives updates when a channel receives a new value or goes into an error state. More...

Inheritance diagram for de.desy.tine.accesslayer.ChannelCallback:

Public Member Functions
void	writeFailed (String address, Object value, int linkStatus)
	An asynchronous write was attempted and failed with the given status. More...
void	writeCompleted (String address, Object value)
	Asynchronouse write completed successfully. More...
void	updateValue (Channel channel)
	The channel value was updated. More...
void	updateErrorStatus (Channel channel)
	The channel status was updated. More...
void	channelError (String message, Throwable cause)
	Called when the an error happened in the channels callback call. More...

Detailed Description

ChannelCallback is the callback interface that receives updates when a channel receives a new value or goes into an error state.

See also

ChannelCallbackAdapter

Author

Jaka Bobnar

Member Function Documentation

channelError()

void de.desy.tine.accesslayer.ChannelCallback.channelError	(	String	message,
		Throwable	cause
	)

Called when the an error happened in the channels callback call.

Parameters

message	message describing the situation
cause	the cause of the error

Implemented in de.desy.tine.accesslayer.ChannelCallbackAdapter.

updateErrorStatus()

void de.desy.tine.accesslayer.ChannelCallback.updateErrorStatus

(

Channel

channel

)

The channel status was updated.

The current status can be obtained by Channel#getStatus(). If another update has been received while this callback is handled the Channel#getStatus() will return the newest value.

Parameters

channel

the channel which value was updated

Deprecated:

use ChannelCallback2#updateErrorStatus(Channel, int) instead

Implemented in de.desy.tine.accesslayer.ChannelCallbackAdapter.

updateValue()

void de.desy.tine.accesslayer.ChannelCallback.updateValue

(

Channel

channel

)

The channel value was updated.

The current value can be obtained by Channel#getValue(), but the value is not guaranteed to be the value that triggered this update. If another value was received while this callback is being handled the Channel#getValue() will return the new value.

Parameters

channel

the channel which value was updated

Deprecated:

use ChannelCallback2#updateValue(Channel, Object) instead

Implemented in de.desy.tine.accesslayer.ChannelCallbackAdapter.

writeCompleted()

void de.desy.tine.accesslayer.ChannelCallback.writeCompleted	(	String	address,
		Object	value
	)

Asynchronouse write completed successfully.

Parameters

address	the name of the property to which the values was written
value	the value that was written

Implemented in de.desy.tine.accesslayer.ChannelCallbackAdapter.

writeFailed()

void de.desy.tine.accesslayer.ChannelCallback.writeFailed	(	String	address,
		Object	value,
		int	linkStatus
	)

An asynchronous write was attempted and failed with the given status.

Parameters

address	the name of the property to which the values was written
value	the value that was written
linkStatus	the status (can be converted to string by TErrorList#toString(int)

Implemented in de.desy.tine.accesslayer.ChannelCallbackAdapter.

---

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

• ChannelCallback.java