de.desy.tine.server.properties.TPropertyHandler Class Reference

An abstract handler for property requests. More...

Public Member Functions
final int	callHandler (String devName, TDataType dout, TDataType din, TAccess devAccess)
	Public interface for call(). More...

Protected Member Functions
abstract int	call (String devName, TDataType dout, TDataType din, TAccess devAccess)
	The method which handles all property requests. More...

Detailed Description

An abstract handler for property requests.

When a client requests access for a certain property, the equipment module calls that property's handler. A property handler has to implement the abstract method call().

Member Function Documentation

call()

abstract int de.desy.tine.server.properties.TPropertyHandler.call ( String  devName, TDataType  dout, TDataType  din, TAccess  devAccess  )

abstractprotected

The method which handles all property requests.

This method must be implemented by derived classes.

Parameters

devName	Device name.
dout	Output data buffer.
din	Input data buffer.
devAccess	Access specification.

Returns

0 or some TErrorList constant.

Referenced by de.desy.tine.server.properties.TPropertyHandler.callHandler().

callHandler()

final int de.desy.tine.server.properties.TPropertyHandler.callHandler	(	String	devName,
		TDataType	dout,
		TDataType	din,
		TAccess	devAccess
	)

Public interface for call().

Verifies parameters and calls the abstract method call(). This method is called by the equipment module.

Parameters

devName	Device name.
dout	Output data buffer.
din	Input data buffer.
devAccess	Access specification.

Returns

Returns illegal_format if dout/din are null while the corresponding access is requested. Returns code_failure if an exception occurs in call(). Redirects the return value of call() otherwise. TODO change short devAccess to TAccess devAccess (See TAccess)

References de.desy.tine.server.properties.TPropertyHandler.call(), and de.desy.tine.definitions.TAccess.isWrite().

---

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

• TPropertyHandler.java