de.desy.tine.accesslayer.ChannelCallbackAdapter Class Reference

ChannelCallbackAdapter is an adapter which provides empty implementation of the ChannelCallback. More...

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

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

Detailed Description

ChannelCallbackAdapter is an adapter which provides empty implementation of the ChannelCallback.

Extend this class when you do not want to provide implementation for all 5 methods from the ChannelCallback.

Author

Jaka Bobnar

Member Function Documentation

channelError()

void de.desy.tine.accesslayer.ChannelCallbackAdapter.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

Implements de.desy.tine.accesslayer.ChannelCallback.

updateError()

void de.desy.tine.accesslayer.ChannelCallbackAdapter.updateError

(

ChannelReadEvent

event

)

Called when the channel receives an error value.

Parameters

event

the event describing the change

Implements de.desy.tine.accesslayer.ChannelListener.

updateErrorStatus() [1/2]

void de.desy.tine.accesslayer.ChannelCallbackAdapter.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

Implements de.desy.tine.accesslayer.ChannelCallback.

updateErrorStatus() [2/2]

void de.desy.tine.accesslayer.ChannelCallbackAdapter.updateErrorStatus	(	Channel	channel,
		TDataType	value,
		int	status
	)

The channel status was updated.

The status that triggered the call is given as a parameter.

Parameters

channel	the channel which value was updated
value	the value of the channel at the time when the event was triggered
status	the status that triggered the callback

Deprecated:

use ChannelListener#updateError(ChannelReadEvent) instead

Implements de.desy.tine.accesslayer.ChannelCallback2.

updateValue() [1/3]

void de.desy.tine.accesslayer.ChannelCallbackAdapter.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

Implements de.desy.tine.accesslayer.ChannelCallback.

updateValue() [2/3]

void de.desy.tine.accesslayer.ChannelCallbackAdapter.updateValue	(	Channel	channel,
		TDataType	rawValue
	)

The channel value was updated and is given as a parameter.

Parameters

channel	the channel which value was updated
rawValue	the value of the channel at the time when the event was triggered

Deprecated:

use ChannelListener#updateValue(ChannelReadEvent) instead

Implements de.desy.tine.accesslayer.ChannelCallback2.

updateValue() [3/3]

void de.desy.tine.accesslayer.ChannelCallbackAdapter.updateValue

(

ChannelReadEvent

event

)

Called when a value has been updated.

Parameters

event

the event describing the change

Implements de.desy.tine.accesslayer.ChannelListener.

writeCompleted()

void de.desy.tine.accesslayer.ChannelCallbackAdapter.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

Implements de.desy.tine.accesslayer.ChannelCallback.

writeFailed()

void de.desy.tine.accesslayer.ChannelCallbackAdapter.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)

Implements de.desy.tine.accesslayer.ChannelCallback.

---

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

• ChannelCallbackAdapter.java