Share via


Adapter Class

 

Defines the methods and properties that must be implemented by input and output adapters.

Namespace:   Microsoft.ComplexEventProcessing.Adapters
Assembly:  Microsoft.ComplexEventProcessing.Adapters (in Microsoft.ComplexEventProcessing.Adapters.dll)

Inheritance Hierarchy

System.Object
  Microsoft.ComplexEventProcessing.Adapters.Adapter
    Microsoft.ComplexEventProcessing.Adapters.InputAdapterBase
    Microsoft.ComplexEventProcessing.Adapters.OutputAdapterBase

Syntax

public abstract class Adapter : IDisposable
public ref class Adapter abstract : IDisposable
[<AbstractClass>]
type Adapter = 
    class
        interface IDisposable
    end
Public MustInherit Class Adapter
    Implements IDisposable

Constructors

Name Description
System_CAPS_protmethod Adapter()

Initializes a new instance of the Adapter class.

Properties

Name Description
System_CAPS_pubproperty AdapterState

Gets the state of the adapter.

Methods

Name Description
System_CAPS_protmethod CleanupResources()

Specifies an internal virtual function that does cleanup of resources. To be overridden by the input and output adapter base classes.

System_CAPS_pubmethod Dispose()

Releases all of the resources owned by the adapter host.

System_CAPS_protmethod Dispose(Boolean)

Implements the Dispose pattern. To be overridden by derived classes.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod OnStopped()

This function is called when the adapter invokes Stopped to stop itself. It allows derived classes to implement additional behavior besides what the base class does.

System_CAPS_pubmethod Ready()

Invoked by the adapter to signal to the engine that it is ready to be resumed. The engine will invoke Resume() only after the adapter has called Ready().

System_CAPS_pubmethod Resume()

Calls Resume() on its own worker thread.

System_CAPS_pubmethod Start()

Calls Start() on its own worker thread.

System_CAPS_pubmethod Stop()

Notifies the adapter to stop as a result of stopping or aborting the query.

System_CAPS_pubmethod Stopped()

Invoked by the adapter to notify the runtime that the adapter has shut down.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

For more information, see Creating Input and Output Adapters.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.ComplexEventProcessing.Adapters Namespace

Return to top