TypedEdgeOutputAdapter<TPayload> Class

Represents the base class for an output adapter that receives edge events.

Inheritance Hierarchy

System.Object
  Microsoft.ComplexEventProcessing.Adapters.Adapter
    Microsoft.ComplexEventProcessing.Adapters.OutputAdapterBase
      Microsoft.ComplexEventProcessing.Adapters.TypedOutputAdapter<EdgeEvent<TPayload>, TPayload>
        Microsoft.ComplexEventProcessing.Adapters.TypedEdgeOutputAdapter<TPayload>

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

Syntax

public abstract class TypedEdgeOutputAdapter<TPayload> : TypedOutputAdapter<EdgeEvent<TPayload>, TPayload>

Type Parameters

  • TPayload
    Payload type. Must have default constructor.

The TypedEdgeOutputAdapter<TPayload> type exposes the following members.

Constructors

  Name Description
Protected method TypedEdgeOutputAdapter<TPayload> Initializes a new instance of the TypedEdgeOutputAdapter<TPayload> class.

Top

Properties

  Name Description
Public property AdapterState Gets the state of the adapter. (Inherited from Adapter.)
Public property OutputEventType Gets the event type that the output adapter will receive. (Inherited from OutputAdapterBase.)

Top

Methods

  Name Description
Protected method CleanupResources Cleans up engine resources that are used by the adapter host. (Inherited from OutputAdapterBase.)
Public method Dequeue Dequeues events from the stream associated with this adapter.
Public method Dispose() Releases all of the resources owned by the adapter host. (Inherited from Adapter.)
Protected method Dispose(Boolean) Implements the Dispose pattern. To be overridden by derived classes (Inherited from Adapter.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnStopped This function is called when the adapter invokes Stopped() to stop itself. (Inherited from OutputAdapterBase.)
Public method 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.)
Public method ReleaseEvent Releases the memory occupied by an event. (Inherited from TypedOutputAdapter<TEvent, TPayload>.)
Public method Resume Calls Resume() on its own worker thread. (Inherited from Adapter.)
Public method Start Calls Start() on its own worker thread. (Inherited from Adapter.)
Public method Stop Notifies the adapter to stop as a result of stopping or aborting the query. (Inherited from Adapter.)
Public method Stopped Invoked by the adapter to notify the runtime that the adapter has shut down. (Inherited from Adapter.)
Public method ToString (Inherited from Object.)

Top

Remarks

Events can be typed or untyped. A typed event is one in which you know the structure of the event payload provided by the source or consumed by the sink, and you intend to design the input or output adapter around this specific event structure. For more information, see Creating Event Types.

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

Reference

Microsoft.ComplexEventProcessing.Adapters Namespace