Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFEventSource Class

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFEventSource Class
The AFEventSource is a base class that can be used for data references which need to provide streaming events for an AFDataPipe.

Inheritance Hierarchy

SystemObject
  OSIsoft.AF.DataAFEventSource

Namespace:  OSIsoft.AF.Data
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public abstract class AFEventSource : IDisposable
Public MustInherit Class AFEventSource
	Implements IDisposable

Dim instance As AFEventSource
public ref class AFEventSource abstract : IDisposable
[<AbstractClassAttribute>]
type AFEventSource =  
    class
        interface IDisposable
    end

The AFEventSource type exposes the following members.

Methods

  NameDescription
Public method
Dispose
Cleans up resources
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
ToString
Returns a string that represents the current object.
(Inherited from Object.)

Remarks

Data Reference needs to provide a static method CreateDataPipe that returns an AFEventSource object. The AFEventSource has the following abstract methods that the implementor has to provide: AddSignup, RemoveSignup, GetEvents() and Dispose(bool). AFEventSource base class has methods to publish data pipe events and report errors. The base class also maintains a dictionary of the AFAttributes being monitored by the eventsource. The AddSignup and RemoveSignup are methods that allow the implementor to handle adding and removing data streams for the pipe from the system of record. The GetEvents method is to get data pipe events from the system of record. The event source also supports an option to return current events for each AFAttribute as the first data pipe event. The base class has implementation for handling the initialization option if the system of record does not have native support for such option. The implementor can override the virtual method GenerateInitialEvents if the system of record has native support to return current event as initial event.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in