DOFSubscription ClassOpenDOF Object Access Library
This class maintains a subscription.
Inheritance Hierarchy

SystemObject
  org.opendof.core.oalDOFSubscription

Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax

C#
public sealed class DOFSubscription

The DOFSubscription type exposes the following members.

Methods

  NameDescription
Public methodaddListener
Add a listener that will receive an update every time the subscribed property changes.
Public methoddestroy
Destroy the DOFSubscription.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodgetContext
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodgetMinPeriod
Public methodgetObjectID
Public methodgetProperty
Public methodgetQuery
Public methodgetState
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodremoveListener
Remove a previously added listener.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

This class maintains a subscription. You can start just one subscription with a single instance.

There are 3 ways to use this class:

  • Unicast - Use a specific DOFObjectID to subscribe to just one provider. The subscribe operation is not flooded. Interest is required because this case uses an internal query to find the provider.
  • Multicast - Use DOFObjectID.BROADCAST to subscribe to all providers of the specified DOFInterface . The subscribe operation is flooded. Interest is not required because no internal query is used.
  • Query - Use a DOFQuery to specify what to subscribe to. Only one subscription is maintained at a time.
See Also

Reference