TypedEdgeOutputAdapter<TPayload>.Dequeue Method (EdgeEvent<TPayload>)

Dequeues events from the stream associated with this adapter.

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

Syntax

public DequeueOperationResult Dequeue(
    out EdgeEvent<TPayload> eventInstance
)

public:
virtual DequeueOperationResult Dequeue(
    [OutAttribute] EdgeEvent<TPayload>^% eventInstance
) sealed

abstract Dequeue : 
        eventInstance:EdgeEvent<'TPayload> byref -> DequeueOperationResult
override Dequeue : 
        eventInstance:EdgeEvent<'TPayload> byref -> DequeueOperationResult

Public Function Dequeue (
    <OutAttribute> ByRef eventInstance As EdgeEvent(Of TPayload)
) As DequeueOperationResult

Parameters

• eventInstance
  Type: Microsoft.ComplexEventProcessing.EdgeEvent<TPayload>

  Event instance

Return Value

Type: Microsoft.ComplexEventProcessing.Adapters.DequeueOperationResult

DequeueOperationResult.Success if the operation succeeded.

DequeueOperationResult.Empty if the operation did not succeed and the adapter needs to wait with further Dequeue calls.

Type Parameters

• TPayload
  Type of the event payload.

See Also

TypedEdgeOutputAdapter<TPayload> Class
Microsoft.ComplexEventProcessing.Adapters Namespace

Return to top