Specifies the control parameters of a Request Operation. More...
Typedefs | |
| typedef struct DOFOperationControl_t * | DOFOperationControl |
| Configuration for a request operation. | |
Enumerations | |
| enum | DOFOperationResponseLevel { DOFOPERATIONRESPONSELEVEL_ALL, DOFOPERATIONRESPONSELEVEL_EXCEPTION, DOFOPERATIONRESPONSELEVEL_SUCCESS, DOFOPERATIONRESPONSELEVEL_NONE } |
| Predefined response levels for reducing unwanted response traffic. More... | |
Functions | |
| DOFOperationControl | DOFOperationControl_Create (void) |
| Create a new Operation Control for use with an Operation. | |
| DOFOperationControl | DOFOperationControl_Copy (const DOFOperationControl self) |
| Create a new copy of an existing DOFOperationControl. | |
| void | DOFOperationControl_Destroy (DOFOperationControl self) |
| Destroy a DOFOperationControl. | |
| boolean | DOFOperationControl_AddProviderExclusion (DOFOperationControl self, DOFObjectID providerID) |
| Add a Provider to the list of Excluded Providers. | |
| void | DOFOperationControl_ClearProviderExclusions (DOFOperationControl self) |
| Remove all provider exclusions from a DOFOperationControl. | |
| boolean | DOFOperationControl_SetAutoExclude (DOFOperationControl self, boolean isAutoExclude) |
| Set whether or not a multicast or broadcast operation should automatically handle exclusion of providers. | |
| boolean | DOFOperationControl_IsAutoExclude (DOFOperationControl self) |
| Return whether or not the Operation Control is set to automatically handle exclusion of providers. | |
| boolean | DOFOperationControl_SetFloodAllowed (DOFOperationControl self, boolean isFloodAllowed) |
| Set whether or a unicast request can be flooded when there are no known providers. | |
| boolean | DOFOperationControl_IsFloodAllowed (DOFOperationControl self) |
| Return whether or not the Operation Control allows a unicast request to be flooded when there are no known providers. | |
| boolean | DOFOperationControl_SetRetryPeriod (DOFOperationControl self, uint32 period) |
| Set a periodic retry period for a request operation. | |
| boolean | DOFOperationControl_SetRetryCallback (DOFOperationControl self, DOFOperationRetryCallback callback) |
| Set a retry callback to dynamically determine each retry period. | |
| boolean | DOFOperationControl_SetResponseLevel (DOFOperationControl self, DOFOperationResponseLevel level) |
| Set the level of verbosity for responses desired in a DOFOperationControl. | |
| DOFOperationResponseLevel | DOFOperationControl_GetResponseLevel (DOFOperationControl self) |
| Get the level of verbosity for responses desired in a DOFOperationControl. | |
| boolean | DOFOperationControl_SetTargetConnection (DOFOperationControl self, DOFConnection connection) |
| Set the target connection to use for the operation. | |
| DOFConnection | DOFOperationControl_GetTargetConnection (DOFOperationControl self) |
| Get the target connection to use for the operation. | |
| boolean | DOFOperationControl_SetDelay (DOFOperationControl self, boolean isDelay) |
| Set whether or not a DOFOperation using this DOFOperationControl will cause responses to be randomly distributed across the operation's lifetime. | |
| boolean | DOFOperationControl_SetMaxCacheAge (DOFOperationControl self, uint32 cacheAge) |
| Set the maximum acceptable age of a cached value. | |
| uint32 | DOFOperationControl_GetMaxCacheAge (DOFOperationControl self) |
| Get the maximum acceptable age allowed by the DOFOperationControl. | |
| boolean | DOFOperationControl_IsDelay (DOFOperationControl self) |
| Determine if a DOFOperationControl has delay behavior enabled or disabled. | |
| boolean | DOFOperationControl_SetMaxResponderCount (DOFOperationControl self, uint16 count) |
| Sets the maximum number of desired responders. | |
| uint16 | DOFOperationControl_GetMaxResponderCount (DOFOperationControl self) |
| Get the maximum number of desired responders. | |
| boolean | DOFOperationControl_SetHeuristic (DOFOperationControl self, uint16 heuristic) |
| Enable randomized acceptance of the operation. | |
| uint16 | DOFOperationControl_GetHeuristic (DOFOperationControl self) |
| Get the heuristic. | |
| boolean | DOFOperationControl_SetAckTimeout (DOFOperationControl self, uint32 timeout) |
| Enable an acknowledgement timeout for the operation. | |
| uint32 | DOFOperationControl_GetAckTimeout (DOFOperationControl self) |
| Get the acknowledgement timeout. | |
Specifies the control parameters of a Request Operation.
This object is passed to certain request methods to change the default behavior of the request, such as the retry frequency, verbosity, and list of excluded Object IDs. A deep copy of the control is placed into each operation.