DOFSystem is the primary class within DOF for handling DOF objects within a security context.
Inheritance Hierarchy
org.opendof.core.oalDOFSystem
Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax
C#
public sealed class DOFSystem
The DOFSystem type exposes the following members.
Methods
Name | Description | |
---|---|---|
![]() | addActivateInterestListener | Used by a Provider to add an
ActivateInterestListener
to be notified of interest requests.
|
![]() | addRouteListener | Add a route listener to this system. |
![]() | addStateListener | Add a new state listener to the system. |
![]() | beginInterest(DOFInterfaceID, DOFInterestLevel) | Used by a Requestor to request interest with an indefinate duration in a given interface and any object.
|
![]() | beginInterest(DOFObjectID, DOFInterestLevel) | Used by a Requestor to request interest with an indefinate duration in a given object and any interface.
|
![]() | beginInterest(DOFObjectID, DOFInterfaceID, DOFInterestLevel) | Used by a Requestor to request interest with an indefinate duration in a given object and interface combination.
|
![]() | beginInterest(DOFObjectID, DOFInterfaceID, DOFInterestLevel, Int32) | Used by a Requestor to request interest in a given object and interface combination.
|
![]() | beginInterest(DOFObjectID, DOFInterfaceID, DOFInterestLevel, Int32, DOFSystemInterestOperationListener) | Used by a Requestor to request interest in a given object and interface combination.
|
![]() | beginInterest(DOFObjectID, DOFInterfaceID, DOFInterestLevel, Int32, DOFSystemInterestOperationListener, Object) | Used by a Requestor to request interest in a given object and interface combination.
|
![]() | beginInterest(DOFObjectID, DOFInterfaceID, DOFInterestLevel, DOFOperationControl, Int32, DOFSystemInterestOperationListener, Object) | Used by a Requestor to request interest in a given object and interface combination specifying a DOFOperation.Control.
|
![]() | beginProvide(DOFInterface, DOFObjectProvider) | Used by a Provider to begin providing the specified interface indefinitely (equivalent to specifying a timeout of
DOF.TIMEOUT_NEVER
) on all objects.
To quit providing use
DOFOperation.cancel()
.
The Provider will only respond to Get, Set, Invoke, and Define requests. That is, the provider will not respond to any interest-based activity.
You will interact with this Provider only from a Requestor that has no interest, meaning a Requestor that will flood its requests.
NOTE: Since all object IDs are accepted, all attributes are accepted too. In a secure deployment, make sure that where the
org.opendof.core.oal.security.DOFPermission.Binding.ACTION_PROVIDE
action is specified, no objectID is specified and
org.opendof.core.oal.security.DOFPermission.Binding.Builder.setAllAttributesAllowed(bool)
is true. This will allow
the provider to work as an "All Objects" provider.
|
![]() | beginProvide(DOFInterface, Int32, DOFObjectProvider) | Used by a Provider to begin providing the specified interface on all objects.
|
![]() | beginProvide(DOFInterface, Int32, DOFObjectProvider, Object) | Used by a Provider to begin providing the specified interface on all objects.
|
![]() | beginQuery(DOFQuery, DOFSystemQueryOperationListener) | Used by a Requestor to begin an asynchronous query with an indefinate duration for the availability of objects
which provide interfaces that match the specified query.
|
![]() | beginQuery(DOFObjectID, DOFInterfaceID, DOFSystemQueryOperationListener) | Used by a Requestor to begin an asynchronous query with an indefinate duration for the availability of objects which provide interfaces that match the specified query.
|
![]() | beginQuery(DOFQuery, Int32, DOFSystemQueryOperationListener) | Used by a Requestor to begin an asynchronous query for the availability of objects which provide interfaces that match the specified query.
|
![]() | beginQuery(DOFObjectID, DOFInterfaceID, Int32, DOFSystemQueryOperationListener) | Used by a Requestor to begin an asynchronous query for the availability of objects which provide interfaces that match the specified query.
|
![]() | beginQuery(DOFQuery, Int32, DOFSystemQueryOperationListener, Object) | Used by a Requestor to begin an asynchronous query for the availability of objects which provide interfaces that match the specified query.
|
![]() | beginQuery(DOFObjectID, DOFInterfaceID, Int32, DOFSystemQueryOperationListener, Object) | Used by a Requestor to begin an asynchronous query with an indefinate duration for the availability of objects which provide interfaces that match the specified query.
|
![]() | createObject | Create a DOFObject with the specified object identifier. |
![]() | createRegistration(DOFObjectID, DOFInterfaceEvent, DOFRegistrationListener) | Used by a Requestor to begin and maintain an event registration, as specified using a context, to be notified of events and associated value(s).
|
![]() | createRegistration(DOFQuery, DOFInterfaceEvent, DOFRegistrationListener) | Used by a Requestor to begin and maintain an event registration, as specified using a
DOFQuery
and a context, to be notified of events and associated value(s).
DOFRegistration will select one matching provider and register for its matching event.
If there is no matching provider, then DOFRegistration will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the registration, call
DOFRegistration.destroy()
.
NOTE: The listener should be notified very soon through the
Listener.stateChanged(DOFRegistration, State)
method that
the registration is active, but until an event actually occurs,
Listener.eventSignaled(DOFRegistration, DOFObjectID, System.Collections.Generic.IList<E>)
won't be called.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
.
Interest goes out on the network and looks for matching providers. The query, on the other hand, searches through
the local set of known providers (those already found through interest).
If no interest is specified, then no non-local providers will be found.
|
![]() | createRegistration(DOFObjectID, DOFInterfaceEvent, DOFOperationControl, DOFRegistrationListener) | Used by a Requestor to begin and maintain an event registration, as specified using a
Control
and context, to be notified of events and associated value(s).
If oid is
DOFObjectID.BROADCAST
, DOFRegistration will register for all matching providers at the time the registration is created.
Otherwise, it will select one matching provider and register for its matching event.
If there is no matching provider, then DOFRegistration will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the registration, call
DOFRegistration.destroy()
.
NOTE: The listener should be notified very soon through the
Listener.stateChanged(DOFRegistration, State)
method that
the registration is active, but until an event actually occurs,
Listener.eventSignaled(DOFRegistration, DOFObjectID, System.Collections.Generic.IList<E>)
won't be called.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
for unicast registrations in order to determine the primary provider.
If no interest is specified, then no non-local providers will be found.
|
![]() | createRegistration(DOFObjectID, DOFInterfaceEvent, DOFRegistrationListener, Object) | Used by a Requestor to begin and maintain an event registration, as specified using a context, to be notified of events and associated value(s).
|
![]() | createRegistration(DOFQuery, DOFInterfaceEvent, DOFOperationControl, DOFRegistrationListener) | Used by a Requestor to begin and maintain an event registration, as specified using a
DOFQuery
,
Control
, and a context, to be notified of events and associated value(s).
DOFRegistration will select one matching provider and register for its matching event.
If there is no matching provider, then DOFRegistration will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the registration, call
DOFRegistration.destroy()
.
NOTE: The listener should be notified very soon through the
Listener.stateChanged(DOFRegistration, State)
method that
the registration is active, but until an event actually occurs,
Listener.eventSignaled(DOFRegistration, DOFObjectID, System.Collections.Generic.IList<E>)
won't be called.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
.
Interest goes out on the network and looks for matching providers. The query, on the other hand, searches through
the local set of known providers (those already found through interest).
If no interest is specified, then no non-local providers will be found.
|
![]() | createRegistration(DOFQuery, DOFInterfaceEvent, DOFRegistrationListener, Object) | Used by a Requestor to begin and maintain an event registration, as specified using a
DOFQuery
and a context, to be notified of events and associated value(s).
DOFRegistration will select one matching provider and register for its matching event.
If there is no matching provider, then DOFRegistration will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the registration, call
DOFRegistration.destroy()
.
NOTE: The listener should be notified very soon through the
Listener.stateChanged(DOFRegistration, State)
method that
the registration is active, but until an event actually occurs,
Listener.eventSignaled(DOFRegistration, DOFObjectID, System.Collections.Generic.IList<E>)
won't be called.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
.
Interest goes out on the network and looks for matching providers. The query, on the other hand, searches through
the local set of known providers (those already found through interest).
If no interest is specified, then no non-local providers will be found.
|
![]() | createRegistration(DOFObjectID, DOFInterfaceEvent, DOFOperationControl, DOFRegistrationListener, Object) | Used by a Requestor to begin and maintain an event registration, as specified using a
Control
and context, to be notified of events and associated value(s).
If oid is
DOFObjectID.BROADCAST
, DOFRegistration will register for all matching providers at the time the registration is created.
Otherwise, it will select one matching provider and register for its matching event.
If there is no matching provider, then DOFRegistration will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the registration, call
DOFRegistration.destroy()
.
NOTE: The listener should be notified very soon through the
Listener.stateChanged(DOFRegistration, State)
method that
the registration is active, but until an event actually occurs,
Listener.eventSignaled(DOFRegistration, DOFObjectID, System.Collections.Generic.IList<E>)
won't be called.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
for unicast registrations in order to determine the primary provider.
If no interest is specified, then no non-local providers will be found.
|
![]() | createRegistration(DOFQuery, DOFInterfaceEvent, DOFOperationControl, DOFRegistrationListener, Object) | Used by a Requestor to begin and maintain an event registration, as specified using a
DOFQuery
,
Control
, and a context, to be notified of events and associated value(s).
DOFRegistration will select one matching provider and register for its matching event.
If there is no matching provider, then DOFRegistration will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the registration, call
DOFRegistration.destroy()
.
NOTE: The listener should be notified very soon through the
Listener.stateChanged(DOFRegistration, State)
method that
the registration is active, but until an event actually occurs,
Listener.eventSignaled(DOFRegistration, DOFObjectID, System.Collections.Generic.IList<E>)
won't be called.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
.
Interest goes out on the network and looks for matching providers. The query, on the other hand, searches through
the local set of known providers (those already found through interest).
If no interest is specified, then no non-local providers will be found.
|
![]() | createSubscription(DOFObjectID, DOFInterfaceProperty, Int32, DOFSubscriptionListener) | Used by a Requestor to begin and maintain a subscription, as specified using a context, to be notified of changes to a
property's value.
|
![]() | createSubscription(DOFQuery, DOFInterfaceProperty, Int32, DOFSubscriptionListener) | Used by a Requestor to begin and maintain a subscription, as specified using a
DOFQuery
and a context, to be notified of changes to a
property's value.
DOFSubscription will select one matching provider and subscribe to its matching property.
If there is no matching provider, then DOFSubscription will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the subscription, call
DOFSubscription.destroy()
.
NOTE: The Property's current value is always returned when the subscription is started.
NOTE: Intermediate changes that occur more frequently than minPeriod may be dropped to save bandwidth, but the
most current value of the Property is always returned.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
.
Interest goes out on the network and looks for matching providers. The query, on the other hand, searches through
the local set of known providers (those already found through interest).
If no interest is specified, then no non-local providers will be found.
|
![]() | createSubscription(DOFObjectID, DOFInterfaceProperty, Int32, DOFOperationControl, DOFSubscriptionListener) | Used by a Requestor to begin and maintain a subscription, as specified using a
Control
and a context, to be notified of changes to a
property's value.
If oid is
DOFObjectID.BROADCAST
, DOFSubscription will subscribe to all matching providers at the time the subscription is created.
Otherwise, it will select one matching provider and subscribe to its matching property.
If there is no matching provider, then DOFSubscription will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the subscription, call
DOFSubscription.destroy()
.
NOTE: The Property's current value is always returned when the subscription is started.
NOTE: Intermediate changes that occur more frequently than minPeriod may be dropped to save bandwidth, but the
most current value of the Property is always returned.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
for unicast subscriptions in order to determine the primary provider.
If no interest is specified, then no non-local providers will be found.
|
![]() | createSubscription(DOFObjectID, DOFInterfaceProperty, Int32, DOFSubscriptionListener, Object) | Used by a Requestor to begin and maintain a subscription, as specified using a context, to be notified of changes to a
property's value.
|
![]() | createSubscription(DOFQuery, DOFInterfaceProperty, Int32, DOFOperationControl, DOFSubscriptionListener) | Used by a Requestor to begin and maintain a subscription, as specified using a
DOFQuery
,
Control
, and a context, to be notified of changes to a
property's value.
DOFSubscription will select one matching provider and subscribe to its matching property.
If there is no matching provider, then DOFSubscription will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the subscription, call
DOFSubscription.destroy()
.
NOTE: The Property's current value is always returned when the subscription is started.
NOTE: Intermediate changes that occur more frequently than minPeriod may be dropped to save bandwidth, but the
most current value of the Property is always returned.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
.
Interest goes out on the network and looks for matching providers. The query, on the other hand, searches through
the local set of known providers (those already found through interest).
If no interest is specified, then no non-local providers will be found.
|
![]() | createSubscription(DOFQuery, DOFInterfaceProperty, Int32, DOFSubscriptionListener, Object) | Used by a Requestor to begin and maintain a subscription, as specified using a
DOFQuery
and a context, to be notified of changes to a
property's value.
DOFSubscription will select one matching provider and subscribe to its matching property.
If there is no matching provider, then DOFSubscription will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the subscription, call
DOFSubscription.destroy()
.
NOTE: The Property's current value is always returned when the subscription is started.
NOTE: Intermediate changes that occur more frequently than minPeriod may be dropped to save bandwidth, but the
most current value of the Property is always returned.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
.
Interest goes out on the network and looks for matching providers. The query, on the other hand, searches through
the local set of known providers (those already found through interest).
If no interest is specified, then no non-local providers will be found.
|
![]() | createSubscription(DOFObjectID, DOFInterfaceProperty, Int32, DOFOperationControl, DOFSubscriptionListener, Object) | Used by a Requestor to begin and maintain a subscription, as specified using a
Control
and a context, to be notified of changes to a
property's value.
If oid is
DOFObjectID.BROADCAST
, DOFSubscription will subscribe to all matching providers at the time the subscription is created.
Otherwise, it will select one matching provider and subscribe to its matching property.
If there is no matching provider, then DOFSubscription will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the subscription, call
DOFSubscription.destroy()
.
NOTE: The Property's current value is always returned when the subscription is started.
NOTE: Intermediate changes that occur more frequently than minPeriod may be dropped to save bandwidth, but the
most current value of the Property is always returned.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
for unicast subscriptions in order to determine the primary provider.
If no interest is specified, then no non-local providers will be found.
|
![]() | createSubscription(DOFQuery, DOFInterfaceProperty, Int32, DOFOperationControl, DOFSubscriptionListener, Object) | Used by a Requestor to begin and maintain a subscription, as specified using a
DOFQuery
,
Control
, and a context, to be notified of changes to a
property's value.
DOFSubscription will select one matching provider and subscribe to its matching property.
If there is no matching provider, then DOFSubscription will wait for one.
If the provider goes away, then the search will resume for a matching provider.
To cancel the subscription, call
DOFSubscription.destroy()
.
NOTE: The Property's current value is always returned when the subscription is started.
NOTE: Intermediate changes that occur more frequently than minPeriod may be dropped to save bandwidth, but the
most current value of the Property is always returned.
NOTE: An application must first express interest by calling
beginInterest(DOFObjectID, DOFInterestLevel)
.
Interest goes out on the network and looks for matching providers. The query, on the other hand, searches through
the local set of known providers (those already found through interest).
If no interest is specified, then no non-local providers will be found.
|
![]() | destroy | Destroys a DOFSystem. |
![]() | Equals | (Overrides ObjectEquals(Object).) |
![]() | GetHashCode | (Overrides ObjectGetHashCode.) |
![]() | getProviderInterfaces | Used by a Requestor (typically) to get all the interfaces currently provided by the specified object in this System.
|
![]() | getProviderRoute | Return current route information for the best, compatible provider (if any).
|
![]() | getRemoteDomainID | Get the remote domain identifier of the given scope with the system domain as a parent.
|
![]() | getState | Get the current instantaneous state of the system. |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | isInterestRequested | Used by a Provider to determine if interest being requested for the specified object and interface.
|
![]() | query(DOFQuery) | Used by a Requestor to query for the set of currently available objects, which provide interfaces that match the specified query.
|
![]() | query(DOFObjectID, DOFInterfaceID) | Used by a Requestor to query for the set of currently available objects, which provide interfaces that match the specified query.
|
![]() | removeActivateInterestListener | Used by a Provider to remove an
ActivateInterestListener
.
|
![]() | removeRouteListener | Remove a route listener for this system. |
![]() | removeStateListener | Remove a state listener from the system. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | waitAuthorized | Wait until a system is authorized or the timeout is up. |
![]() | waitProvider(DOFInterfaceID, Int32) | Used by a Requestor to block the caller and wait until the first available provider becomes available that provides the specified interface.
|
![]() | waitProvider(IListDOFInterfaceID, Int32) | Used by a Requestor to block the caller and wait until the first provider becomes available that provides all of the specified interfaces.
|
![]() | waitProvider(DOFObjectID, DOFInterfaceID, Int32) | Used by a Requestor to block the caller and wait until a provider becomes available with a matching object identifier and that provides the specified interface.
|
![]() | waitProvider(DOFObjectID, IListDOFInterfaceID, Int32) | Used by a Requestor to block the caller and wait until a provider becomes available with a matching identifier and that provides all of the specified interfaces.
|
Remarks
See Also