OpenDOF Project
void(* DOFObjectProvider::Subscribe)(DOFObjectProvider self, DOFOperation operation, DOFRequest request, DOFInterfaceProperty property, uint32 minPeriod)

Callback for a Provider when a DOFInterfaceProperty is to be subscribed.

This callback must decide whether or not to accept the new subscription. The Provider may choose to not allow the subscription by throwing an exception on the request (see DOFRequest_Throw). The request will remain valid until the SubscribeComplete callback is called. If the application chooses not to supply a SubscribeComplete callback, then the subscription request must be accepted or rejected synchronously inside this callback. If the application initially accepts the subscription, the application can terminate it (as long as the request remains valid) by calling DOFRequest_Throw.

This callback may be NULL if the application does not monitor nor control subscriptions to any Property (subscriptions to any readable properties will be automatically accepted).

Parameters
selfThe callback object. This will never be NULL.
operationThe Provide Operation. This will never be NULL.
propertyThe Property being Subscribed. This will never be NULL.
minPeriodThe minimum period between updates.
requestA representation of the requestor. This will never be NULL.
Note
The request must be accepted by calling DOFRequestSubscribe_Return, or rejected via DOFRequest_Throw. All parameters to this callback remain valid and may be referenced by the application until either the end of the callback or the SubscribeComplete callback is called, whichever is LATER.
core-c-dof-oal Version 8.0.1 Build 0
2018-01-22