The property signal handler interface. More...

Public Member Functions
void	handler (int signal, String property, TContract con, int status)
	The property signal handler function. More...

void	setMask (int mask)
	Sets the mask of property signals which should be used to raise the signal. More...

int	getMask ()

Detailed Description

The property signal handler interface.

A property signal handler can be registered for a given equipment module in order to intercept and react to various processing signals relevant to the property being accessed.

Author: duval

Member Function Documentation

◆ getMask()

int de.desy.tine.server.equipment.TPropertySignalHandler.getMask ( )

Returns: the mask of property signals which should be used to raise the signal. This should be one of or a combination of the signal bit definitions in TPropertySignal:

TPropertySignal.PS_ACCESS,
TPropertySignal.PS_RETRY,
TPropertySignal.PS_LATE,
TPropertySignal.PS_PENDING,
TPropertySignal.PS_SENT,
TPropertySignal.PS_CALLED,
TPropertySignal.PS_PROCESSED,
TPropertySignal.PS_SCHEDULED,
or TPropertySignal.PS_ALL

◆ handler()

void de.desy.tine.server.equipment.TPropertySignalHandler.handler	(	int	signal,
		String	property,
		TContract	con,
		int	status
	)

The property signal handler function.

Parameters

signal	is the specific signal bit(s) causing the signal to be raised.
property	is the property string being accessed.
con	is the contract being accessed (if known at the time of the signal, otherwise a null variable).
status	is the call status at the time of the signal.

See also: TEquipmentModule.registerPropertySignalHandler(); TPropertySignal for definitions of the property signal bits

◆ setMask()

void de.desy.tine.server.equipment.TPropertySignalHandler.setMask ( int mask )

Sets the mask of property signals which should be used to raise the signal.

This should be one of or a combination of the signal bit definitions in TPropertySignal: