DOFObjectEventOperationListenereventSignaled Method OpenDOF Object Access Library

Note: This API is now obsolete.

Process a DOF event.

Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax

C#
[ObsoleteAttribute("Replaced by Listener.eventSignaled(DOFRegistration, DOFObjectID, System.Collections.Generic.IList{E})")]
void eventSignaled(
	DOFOperationRegister operation,
	DOFProviderInfo providerInfo,
	IList<DOFValue> parameters,
	DOFException exception
)

Parameters

operation
Type: org.opendof.core.oalDOFOperationRegister
Information about the operation that was used to register this event handler. This will never be null.
providerInfo
Type: org.opendof.core.oalDOFProviderInfo
Information about the provider of the event. This will never be null.
parameters
Type: System.Collections.GenericIListDOFValue
The event's parameters, if any. May be null. NOTE: If parameters is null AND exception is null, this indicates that the register has been successfully established.
exception
Type: org.opendof.core.oalDOFException
An exception received from the Provider, if any. May be null.
Remarks

Process a DOF event. This method is called when an event occurs.

NOTE: If the primary provider changes during the lifetime of the operation, and the Control response level includes exceptions, then this method will be passed a DOFErrorException.TERMINATED exception. In order to start processing the events from the new source, you may:

  • Cancel and reestablish the registration with DOFObject.beginRegister(Event, int, EventOperationListener, object) .
  • Wait for the operation retry to automatically switch over to the new provider.
  • Or, if you expect this to occur, before calling DOFObject.beginRegister(Event, int, EventOperationListener, object) , you may set a shorter retry period for the operation with Control.setRetryPeriod(int) or Control.setRetryTime(RetryTime) .
See Also

Reference