InputAdapterBase Class

 

Base class for input 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.TypedInputAdapter<TEvent, TPayload>
      Microsoft.ComplexEventProcessing.Adapters.UntypedInputAdapter<TEvent>

Syntax

public abstract class InputAdapterBase : Adapter
public ref class InputAdapterBase abstract : Adapter
[<AbstractClass>]
type InputAdapterBase = 
    class
        inherit Adapter
    end
Public MustInherit Class InputAdapterBase
    Inherits Adapter

Properties

Name Description
System_CAPS_pubproperty AdapterState

Gets the state of the adapter.(Inherited from Adapter.)

Methods

Name Description
System_CAPS_protmethod CleanupResources()

Cleans up engine resources that are used by the adapter host.(Overrides Adapter.CleanupResources().)

System_CAPS_pubmethod Dispose()

Releases all of the resources owned by the adapter host.(Inherited from Adapter.)

System_CAPS_protmethod Dispose(Boolean)

Implements the Dispose pattern. To be overridden by derived classes.(Inherited from Adapter.)

System_CAPS_pubmethod EnqueueCtiEvent(DateTimeOffset)

Enqueues a Current Time Increment (CTI) event.

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. Enqueue the EndOfStream event and detach from query instance. After this point, the plan manager is free to shut down the query independently of the adapter.(Overrides Adapter.OnStopped().)

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().(Inherited from Adapter.)

System_CAPS_pubmethod Resume()

Calls Resume() on its own worker thread.(Inherited from Adapter.)

System_CAPS_pubmethod Start()

Calls Start() on its own worker thread.(Inherited from Adapter.)

System_CAPS_pubmethod Stop()

Notifies the adapter to stop as a result of stopping or aborting the query.(Inherited from Adapter.)

System_CAPS_pubmethod Stopped()

Invoked by the adapter to notify the runtime that the adapter has shut down.(Inherited from Adapter.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

 

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