xml/System.ClientModel.Primitives/PipelinePolicy.xml (200 lines of code) (raw):

<Type Name="PipelinePolicy" FullName="System.ClientModel.Primitives.PipelinePolicy"> <TypeSignature Language="C#" Value="public abstract class PipelinePolicy" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit PipelinePolicy extends System.Object" /> <TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.PipelinePolicy" /> <TypeSignature Language="VB.NET" Value="Public MustInherit Class PipelinePolicy" /> <TypeSignature Language="F#" Value="type PipelinePolicy = class" /> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.1.0.0</AssemblyVersion> <AssemblyVersion>1.2.0.0</AssemblyVersion> <AssemblyVersion>1.2.1.0</AssemblyVersion> <AssemblyVersion>1.3.0.0</AssemblyVersion> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces /> <Docs> <summary> A policy that can be added to a <see cref="T:System.ClientModel.Primitives.ClientPipeline" /> to process a <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> during a call to <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />. Types deriving from <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> can read or modify the <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" />, implement functionality based on <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" />, and must pass control to the next <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> in the pipeline by calling <see cref="M:System.ClientModel.Primitives.PipelinePolicy.ProcessNext(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" />. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected PipelinePolicy ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelinePolicy.#ctor" /> <MemberSignature Language="VB.NET" Value="Protected Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary>To be added.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="Process"> <MemberSignature Language="C#" Value="public abstract void Process (System.ClientModel.Primitives.PipelineMessage message, System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt; pipeline, int currentIndex);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Process(class System.ClientModel.Primitives.PipelineMessage message, class System.Collections.Generic.IReadOnlyList`1&lt;class System.ClientModel.Primitives.PipelinePolicy&gt; pipeline, int32 currentIndex) cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelinePolicy.Process(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" /> <MemberSignature Language="VB.NET" Value="Public MustOverride Sub Process (message As PipelineMessage, pipeline As IReadOnlyList(Of PipelinePolicy), currentIndex As Integer)" /> <MemberSignature Language="F#" Value="abstract member Process : System.ClientModel.Primitives.PipelineMessage * System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt; * int -&gt; unit" Usage="pipelinePolicy.Process (message, pipeline, currentIndex)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="System.ClientModel.Primitives.PipelineMessage" /> <Parameter Name="pipeline" Type="System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt;" /> <Parameter Name="currentIndex" Type="System.Int32" /> </Parameters> <Docs> <param name="message">The <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> to process.</param> <param name="pipeline">The collection of <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> instances in the <see cref="T:System.ClientModel.Primitives.ClientPipeline" /> instance whose <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" /> method was called to invoke this method.</param> <param name="currentIndex">The index of this policy in the <paramref name="pipeline" /> policy list. This value should be passed to <see cref="M:System.ClientModel.Primitives.PipelinePolicy.ProcessNext(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" /> to pass control to the next policy in the pipeline.</param> <summary> Process the provided <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> according to the intended purpose of this <see cref="T:System.ClientModel.Primitives.PipelinePolicy" />instance. Derived types must pass control to the next <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> in the pipeline by calling <see cref="M:System.ClientModel.Primitives.PipelinePolicy.ProcessNext(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" />. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ProcessAsync"> <MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.ValueTask ProcessAsync (System.ClientModel.Primitives.PipelineMessage message, System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt; pipeline, int currentIndex);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask ProcessAsync(class System.ClientModel.Primitives.PipelineMessage message, class System.Collections.Generic.IReadOnlyList`1&lt;class System.ClientModel.Primitives.PipelinePolicy&gt; pipeline, int32 currentIndex) cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelinePolicy.ProcessAsync(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" /> <MemberSignature Language="VB.NET" Value="Public MustOverride Function ProcessAsync (message As PipelineMessage, pipeline As IReadOnlyList(Of PipelinePolicy), currentIndex As Integer) As ValueTask" /> <MemberSignature Language="F#" Value="abstract member ProcessAsync : System.ClientModel.Primitives.PipelineMessage * System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt; * int -&gt; System.Threading.Tasks.ValueTask" Usage="pipelinePolicy.ProcessAsync (message, pipeline, currentIndex)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.ValueTask</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="System.ClientModel.Primitives.PipelineMessage" /> <Parameter Name="pipeline" Type="System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt;" /> <Parameter Name="currentIndex" Type="System.Int32" /> </Parameters> <Docs> <param name="message">The <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> to process.</param> <param name="pipeline">The collection of <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> instances in the <see cref="T:System.ClientModel.Primitives.ClientPipeline" /> instance whose <see cref="M:System.ClientModel.Primitives.ClientPipeline.SendAsync(System.ClientModel.Primitives.PipelineMessage)" /> method was called to invoke this method.</param> <param name="currentIndex">The index of this policy in the <paramref name="pipeline" /> policy list. This value should be passed to <see cref="M:System.ClientModel.Primitives.PipelinePolicy.ProcessNextAsync(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" /> to pass control to the next policy in the pipeline.</param> <summary> Process the provided <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> according to the intended purpose of this <see cref="T:System.ClientModel.Primitives.PipelinePolicy" />instance. Derived types must pass control to the next <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> in the pipeline by calling <see cref="M:System.ClientModel.Primitives.PipelinePolicy.ProcessNextAsync(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" />. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ProcessNext"> <MemberSignature Language="C#" Value="protected static void ProcessNext (System.ClientModel.Primitives.PipelineMessage message, System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt; pipeline, int currentIndex);" /> <MemberSignature Language="ILAsm" Value=".method familystatic hidebysig void ProcessNext(class System.ClientModel.Primitives.PipelineMessage message, class System.Collections.Generic.IReadOnlyList`1&lt;class System.ClientModel.Primitives.PipelinePolicy&gt; pipeline, int32 currentIndex) cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelinePolicy.ProcessNext(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" /> <MemberSignature Language="VB.NET" Value="Protected Shared Sub ProcessNext (message As PipelineMessage, pipeline As IReadOnlyList(Of PipelinePolicy), currentIndex As Integer)" /> <MemberSignature Language="F#" Value="static member ProcessNext : System.ClientModel.Primitives.PipelineMessage * System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt; * int -&gt; unit" Usage="System.ClientModel.Primitives.PipelinePolicy.ProcessNext (message, pipeline, currentIndex)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="System.ClientModel.Primitives.PipelineMessage" /> <Parameter Name="pipeline" Type="System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt;" /> <Parameter Name="currentIndex" Type="System.Int32" /> </Parameters> <Docs> <param name="message">The <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> to process.</param> <param name="pipeline">The collection of <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> instances in the <see cref="T:System.ClientModel.Primitives.ClientPipeline" />.</param> <param name="currentIndex">The index of this policy in the <paramref name="pipeline" /> policy list. The derived-type implementation of <see cref="M:System.ClientModel.Primitives.PipelinePolicy.Process(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" /> should pass the value of <paramref name="currentIndex" /> it received without modifying it.</param> <summary> Passes control to the next <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> in the <see cref="T:System.ClientModel.Primitives.ClientPipeline" />. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ProcessNextAsync"> <MemberSignature Language="C#" Value="protected static System.Threading.Tasks.ValueTask ProcessNextAsync (System.ClientModel.Primitives.PipelineMessage message, System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt; pipeline, int currentIndex);" /> <MemberSignature Language="ILAsm" Value=".method familystatic hidebysig valuetype System.Threading.Tasks.ValueTask ProcessNextAsync(class System.ClientModel.Primitives.PipelineMessage message, class System.Collections.Generic.IReadOnlyList`1&lt;class System.ClientModel.Primitives.PipelinePolicy&gt; pipeline, int32 currentIndex) cil managed" /> <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelinePolicy.ProcessNextAsync(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" /> <MemberSignature Language="VB.NET" Value="Protected Shared Function ProcessNextAsync (message As PipelineMessage, pipeline As IReadOnlyList(Of PipelinePolicy), currentIndex As Integer) As ValueTask" /> <MemberSignature Language="F#" Value="static member ProcessNextAsync : System.ClientModel.Primitives.PipelineMessage * System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt; * int -&gt; System.Threading.Tasks.ValueTask" Usage="System.ClientModel.Primitives.PipelinePolicy.ProcessNextAsync (message, pipeline, currentIndex)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>System.ClientModel</AssemblyName> <AssemblyVersion>1.4.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.ValueTask</ReturnType> </ReturnValue> <Parameters> <Parameter Name="message" Type="System.ClientModel.Primitives.PipelineMessage" /> <Parameter Name="pipeline" Type="System.Collections.Generic.IReadOnlyList&lt;System.ClientModel.Primitives.PipelinePolicy&gt;" /> <Parameter Name="currentIndex" Type="System.Int32" /> </Parameters> <Docs> <param name="message">The <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> to process.</param> <param name="pipeline">The collection of <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> instances in the <see cref="T:System.ClientModel.Primitives.ClientPipeline" />.</param> <param name="currentIndex">The index of this policy in the <paramref name="pipeline" /> policy list. The derived-type implementation of <see cref="M:System.ClientModel.Primitives.PipelinePolicy.ProcessAsync(System.ClientModel.Primitives.PipelineMessage,System.Collections.Generic.IReadOnlyList{System.ClientModel.Primitives.PipelinePolicy},System.Int32)" /> should pass the value of <paramref name="currentIndex" /> it received without modifying it.</param> <summary> Passes control to the next <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> in the <see cref="T:System.ClientModel.Primitives.ClientPipeline" />. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> </Members> </Type>