The Control class is used with DOFRequestors for controlling the behavior of request operations.
Inheritance Hierarchy
org.opendof.core.oalDOFOperationControl
Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax
C#
[SerializableAttribute] public sealed class Control
The DOFOperationControl type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | DOFOperationControl | Create a default instance not for unmarshalling. |
| DOFOperationControl(DOFOperationControl) | Copy constructor. |
| DOFOperationControl(DOFMarshalContext, Object, DOFPacket) | Create an instance from serial form. |
Methods
| Name | Description | |
|---|---|---|
| addProviderExclusion |
Add a variable number of providers to the list of providers who should not respond to
requests made using this Control.
|
| addProviderExclusions |
Add to the list of providers (DOFObjectID's) who should not respond to
requests made using this Control.
|
| clearProviderExclusions | Clear the list of provider exclusions. |
| Equals | (Overrides ObjectEquals(Object).) |
| getAckTimeout | Get the maximum time allowed for this operation to be acknowledged. |
| GetHashCode | (Overrides ObjectGetHashCode.) |
| getHeuristic | Get the value indicating randomized acceptance of the operation. |
| getMaxCacheAge | Return the maximum acceptable age of a cached value. |
| getMaxResponderCount | Get the maximum number of desired responders. |
| getProviderExclusions | Get provider exclusions. |
| getResponseLevel | Get the operation's level of verbosity for responses. |
| getRetryPeriod | Get the retry period. |
| getRetryTime | Get the RetryTime. |
| getTargetConnection | Get the target connection. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| isAutoExclude |
Is the operation auto exclude?
NOTE: This is ignored for OAP Unicast operations (see
DOFObjectID.isUnicast()
,
and DOFOperation.Session, DOFOperation.Register and DOFOperation.Subscribe.
|
| isDefault | Check whether this Control is equal to the default Control. |
| isDelay | Return whether or not receiving nodes should cause responses to be randomly distributed across the operation's lifetime.
|
| isFloodAllowed | Get whether the operation allows broadcast. |
| marshal | |
| setAckTimeout | Set the maximum time to allow for the operation to be acknowledged. |
| setAutoExclude |
Set whether or not providers, who have previously responded, are automatically
excluded when a request made using this Control is retried.
|
| setDelay | Set whether or not receiving nodes should cause responses to be randomly distributed across the operation's lifetime.
|
| setFloodAllowed |
Set whether or not unicast requests (requests made on an object with a specific object ID,
not DOFObjectID.BROADCAST |
| setHeuristic | Set randomized acceptance of the operation. |
| setMaxCacheAge | Set the maximum acceptable age of a cached value. |
| setMaxResponderCount | Sets the maximum number of desired responders. |
| setResponseLevel | Set the level of verbosity for responses for requests made using this Control.
|
| setRetryPeriod | Set a periodic retry period for requests made using this Control. |
| setRetryTime | Set a retry retryTime to dynamically determine each retry period. |
| setTargetConnection | Set the connection that the request must use. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | DEFAULT_RETRY_PERIOD | The default retry period for an operation. |
| HEURISTIC_ALL | A value indicating randomized acceptance of the operation. |
| RESPONDERS_ALL | A number that captures *all* responses. |
Remarks
See Also
Reference
DOFObject.get(Property, int)
DOFObject.beginGet(Property, int)
DOFObject.set(Property, DOFValue, int)
DOFObject.beginSet(Property, DOFValue, int)
DOFObject.invoke(Method, System.Collections.Generic.IList<E>, int)
DOFObject.beginInvoke(Method, int, DOFValue[])
DOFSystem.createSubscription(DOFObjectID, Property, int, Listener)
DOFSystem.createRegistration(DOFObjectID, Event, Listener)