Container+ChangeFeedStreamHandlerWithManualCheckpoint.xml

<Type Name="Container+ChangeFeedStreamHandlerWithManualCheckpoint" FullName="Microsoft.Azure.Cosmos.Container+ChangeFeedStreamHandlerWithManualCheckpoint">
  <TypeSignature Language="C#" Value="public delegate System.Threading.Tasks.Task Container.ChangeFeedStreamHandlerWithManualCheckpoint(ChangeFeedProcessorContext context, Stream changes, Func&lt;Task&gt; checkpointAsync, CancellationToken cancellationToken);" />
  <TypeSignature Language="ILAsm" Value=".class nested public auto ansi sealed Container/ChangeFeedStreamHandlerWithManualCheckpoint extends System.MulticastDelegate" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.Container.ChangeFeedStreamHandlerWithManualCheckpoint" />
  <TypeSignature Language="VB.NET" Value="Public Delegate Function Container.ChangeFeedStreamHandlerWithManualCheckpoint(context As ChangeFeedProcessorContext, changes As Stream, checkpointAsync As Func(Of Task), cancellationToken As CancellationToken) As Task " />
  <TypeSignature Language="F#" Value="type Container.ChangeFeedStreamHandlerWithManualCheckpoint = delegate of ChangeFeedProcessorContext * Stream * Func&lt;Task&gt; * CancellationToken -&gt; Task" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
    <AssemblyVersion>3.36.0.0</AssemblyVersion>
    <AssemblyVersion>3.38.1.0</AssemblyVersion>
    <AssemblyVersion>3.39.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Delegate</BaseTypeName>
  </Base>
  <Parameters>
    <Parameter Name="context" Type="Microsoft.Azure.Cosmos.ChangeFeedProcessorContext" />
    <Parameter Name="changes" Type="System.IO.Stream" />
    <Parameter Name="checkpointAsync" Type="System.Func&lt;System.Threading.Tasks.Task&gt;" />
    <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
  </Parameters>
  <ReturnValue>
    <ReturnType>System.Threading.Tasks.Task</ReturnType>
  </ReturnValue>
  <Docs>
    <param name="context">The context related to the changes.</param>
    <param name="changes">The changes that happened.</param>
    <param name="checkpointAsync">A task representing an asynchronous checkpoint on the progress of a lease.</param>
    <param name="cancellationToken">A cancellation token representing the current cancellation status of the <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessor" /> instance.</param>
    <summary>
            Delegate to receive the changes within a <see cref="T:Microsoft.Azure.Cosmos.ChangeFeedProcessor" /> execution with manual checkpoint.
            </summary>
    <returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation that is going to be done with the changes.</returns>
    <remarks>To be added.</remarks>
    <example>
      <code language="c#"><![CDATA[
            (ChangeFeedProcessorContext context, Stream stream, Func<Task> checkpointAsync, CancellationToken cancellationToken) =>
            {
                // consume stream
                
                // On certain condition, we can checkpoint
                await checkpointAsync();
            }
            ]]></code>
    </example>
  </Docs>
</Type>