Server.CancelCheckpoint Method (IAsyncResult)

  • Article

 

Cancels a pending asynchronous checkpoint.

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

Syntax

public void CancelCheckpoint(
    IAsyncResult asyncResult
)

public:
void CancelCheckpoint(
    IAsyncResult^ asyncResult
)

member CancelCheckpoint : 
        asyncResult:IAsyncResult -> unit

Public Sub CancelCheckpoint (
    asyncResult As IAsyncResult
)

Parameters

  • asyncResult
    Type: System.IAsyncResult

    The reference to the pending asynchronous request to cancel.

Remarks

This is an asynchronous operation. It initiates the cancelation of the checkpoint. The completion of the cancel still happens through the IAsyncResult received by the BeginCheckpoint call. That is, the IAsyncResult from a BeginCheckpoint can have 3 possible outcomes:

  1. The checkpoint completes. The value returned by EndCheckpoint is true.

  2. The checkpoint is canceled by the user. The value returned by EndCheckpoint is false.

  3. The checkpoint fails. An exception is raised by EndCheckpoint.

    For more information, see Building Resilient StreamInsight Applications.

See Also

Server Class
Microsoft.ComplexEventProcessing Namespace

Return to top