DOFObjectProvider Struct Reference

The callback interface structure used to Provide information to a Requestor. More...

Data Fields
void(*	Complete )(DOFObjectProvider self, DOFOperation operation, DOFException except)
	Callback for a Provider when the DOFOperation, representing the act of Providing, has timed out or is cancelled.
void(*	Invoke )(DOFObjectProvider self, DOFOperation operation, DOFRequest request, DOFInterfaceMethod method, uint16 parameterCount, const DOFValue parameters[])
	Callback for a Provider when a DOFInterfaceMethod is to be invoked.
void(*	Get )(DOFObjectProvider self, DOFOperation operation, DOFRequest request, DOFInterfaceProperty property)
	Callback for a Provider when a DOFInterfaceProperty is to be read.
void(*	Set )(DOFObjectProvider self, DOFOperation operation, DOFRequest request, DOFInterfaceProperty property, DOFValue value)
	Callback for a Provider when a DOFInterfaceProperty is to be set.
void(*	Subscribe )(DOFObjectProvider self, DOFOperation operation, DOFRequest request, DOFInterfaceProperty property, uint32 minPeriod)
	Callback for a Provider when a DOFInterfaceProperty is to be subscribed.
void(*	SubscribeComplete )(DOFObjectProvider self, DOFOperation operation, DOFRequest request, DOFInterfaceProperty property)
	Callback for a Provider when a subscription is removed for a DOFInterfaceProperty.
void(*	Register )(DOFObjectProvider self, DOFOperation operation, DOFRequest request, DOFInterfaceEvent evt)
	Callback for a Provider when a DOFInterfaceEvent handler is registered.
void(*	RegisterComplete )(DOFObjectProvider self, DOFOperation operation, DOFRequest request, DOFInterfaceEvent evt)
	Callback for a Provider when an event handler is removed for a DOFInterfaceEvent.
void(*	Session )(DOFObjectProvider self, DOFOperation operation, DOFRequest request, DOFObject object, DOFInterfaceID interfaceID, DOFObjectID sessionID, DOFInterfaceID sessionType)
	Callback for a Provider when a session is requested.
void(*	SessionComplete )(DOFObjectProvider self, DOFOperation operation, DOFRequest request, DOFObject object, DOFInterfaceID interfaceID, DOFObjectID sessionID, DOFInterfaceID sessionType)
	Callback for a Provider when a session request is completed and the session should be terminated.

Detailed Description

The callback interface structure used to Provide information to a Requestor.

The Provider Callback interface.

All of the functions in this structure take a pointer to this structure (a DOFObjectProvider) as their first argument. This structure may be placed as the first element in a larger structure that stores additional state, allowing the functions to access the additional state by casting the structure pointer to a pointer to the larger structure. If no additional state is required, this structure may be used directly.

Threading:

Functions in this interface may be called by multiple threads simultaneously. You must manage thread-safety.

See Also

DOFObject_BeginProvide

Defined as a pointer to the DOFObjectProvider_t structure. Refer to the structure for more information.