TypedEdgeOutputAdapter<TPayload> Class

 

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

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

Inheritance Hierarchy

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

Syntax

public abstract class TypedEdgeOutputAdapter<TPayload> : TypedOutputAdapter<EdgeEvent<TPayload>, TPayload>
generic<typename TPayload>
public ref class TypedEdgeOutputAdapter abstract : TypedOutputAdapter<EdgeEvent<TPayload>^, TPayload>
[<AbstractClass>]
type TypedEdgeOutputAdapter<'TPayload> = 
    class
        inherit TypedOutputAdapter<EdgeEvent<'TPayload>, 'TPayload>
    end
Public MustInherit Class TypedEdgeOutputAdapter(Of TPayload)
    Inherits TypedOutputAdapter(Of EdgeEvent(Of TPayload), TPayload)

Type Parameters

  • TPayload
    Payload type. Must have default constructor.

Constructors

Name Description
System_CAPS_protmethod TypedEdgeOutputAdapter<TPayload>()

Initializes a new instance of the TypedEdgeOutputAdapter<TPayload> class.

Properties

Name Description
System_CAPS_pubproperty AdapterState

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

System_CAPS_pubproperty OutputEventType

Gets the event type that the output adapter will receive.(Inherited from OutputAdapterBase.)

Methods

Name Description
System_CAPS_protmethod CleanupResources()

Cleans up engine resources that are used by the adapter host.(Inherited from OutputAdapterBase.)

System_CAPS_pubmethod Dequeue(EdgeEvent<TPayload>)

Dequeues events from the stream associated with this adapter.

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

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 ReleaseEvent(TEvent)

Releases the memory occupied by an event.(Inherited from TypedOutputAdapter<TEvent, TPayload>.)

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

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 Event Structure.

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