xml/System.ClientModel.Primitives/PipelineMessageClassifier.xml

<Type Name="PipelineMessageClassifier" FullName="System.ClientModel.Primitives.PipelineMessageClassifier">
  <TypeSignature Language="C#" Value="public abstract class PipelineMessageClassifier" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit PipelineMessageClassifier extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.PipelineMessageClassifier" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class PipelineMessageClassifier" />
  <TypeSignature Language="F#" Value="type PipelineMessageClassifier = 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 classifier that can evaluate a <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> in two ways.
            First, given an HTTP message, the <see cref="T:System.ClientModel.Primitives.PipelineMessageClassifier" />
            can determine whether the service response it holds should be considered an
            error response.  Second, given an HTTP message and an optional pipeline
            exception, the classifier can determine whether or not the
            <see cref="T:System.ClientModel.Primitives.ClientPipeline" /> should retry the request.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected PipelineMessageClassifier ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessageClassifier.#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="Create">
      <MemberSignature Language="C#" Value="public static System.ClientModel.Primitives.PipelineMessageClassifier Create (ReadOnlySpan&lt;ushort&gt; successStatusCodes);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.ClientModel.Primitives.PipelineMessageClassifier Create(valuetype System.ReadOnlySpan`1&lt;unsigned int16&gt; successStatusCodes) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessageClassifier.Create(System.ReadOnlySpan{System.UInt16})" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function Create (successStatusCodes As ReadOnlySpan(Of UShort)) As PipelineMessageClassifier" />
      <MemberSignature Language="F#" Value="static member Create : ReadOnlySpan&lt;uint16&gt; -&gt; System.ClientModel.Primitives.PipelineMessageClassifier" Usage="System.ClientModel.Primitives.PipelineMessageClassifier.Create successStatusCodes" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.PipelineMessageClassifier</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="successStatusCodes" Type="System.ReadOnlySpan&lt;System.UInt16&gt;" />
      </Parameters>
      <Docs>
        <param name="successStatusCodes">The status codes that the returned
            classifier instance will classifiy as success codes.</param>
        <summary>
            Create an instance of a <see cref="T:System.ClientModel.Primitives.PipelineMessageClassifier" /> from a
            collection of success status codes.
            </summary>
        <returns>A <see cref="T:System.ClientModel.Primitives.PipelineMessageClassifier" /> instance that
            classifies the status codes provided by
            <paramref name="successStatusCodes" /> as success codes.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Default">
      <MemberSignature Language="C#" Value="public static System.ClientModel.Primitives.PipelineMessageClassifier Default { get; }" />
      <MemberSignature Language="ILAsm" Value=".property class System.ClientModel.Primitives.PipelineMessageClassifier Default" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.PipelineMessageClassifier.Default" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Default As PipelineMessageClassifier" />
      <MemberSignature Language="F#" Value="static member Default : System.ClientModel.Primitives.PipelineMessageClassifier" Usage="System.ClientModel.Primitives.PipelineMessageClassifier.Default" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.PipelineMessageClassifier</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            A default classifier instance. This classifier will classify a
            <see cref="T:System.ClientModel.Primitives.PipelineResponse" /> with a status code of <c>4xx</c> or
            <c>5xx</c> as an error, and with a status code of <c>408</c>,
            <c>429</c>, <c>500</c>, <c>502</c>, <c>503</c> and <c>504</c> as
            retriable.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TryClassify">
      <MemberSignature Language="C#" Value="public abstract bool TryClassify (System.ClientModel.Primitives.PipelineMessage message, out bool isError);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryClassify(class System.ClientModel.Primitives.PipelineMessage message, [out] bool&amp; isError) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessageClassifier.TryClassify(System.ClientModel.Primitives.PipelineMessage,System.Boolean@)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function TryClassify (message As PipelineMessage, ByRef isError As Boolean) As Boolean" />
      <MemberSignature Language="F#" Value="abstract member TryClassify : System.ClientModel.Primitives.PipelineMessage * bool -&gt; bool" Usage="pipelineMessageClassifier.TryClassify (message, isError)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.ClientModel.Primitives.PipelineMessage" />
        <Parameter Name="isError" Type="System.Boolean" RefType="out" />
      </Parameters>
      <Docs>
        <param name="message">The <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> to classify.</param>
        <param name="isError">
          <c>true</c> if the
            <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" /> should be considered an error
            response.</param>
        <summary>
            Attempt to evaluate whether the provided <see cref="T:System.ClientModel.Primitives.PipelineMessage" />
            contains a <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" /> that the client should
            consider an error response.
            </summary>
        <returns>
          <c>true</c> if the classifier had an opinion regarding whether
            the service response was an error response; <c>false</c> otherwise.
            </returns>
        <remarks>
            Not all classifiers derived from <see cref="T:System.ClientModel.Primitives.PipelineMessageClassifier" />
            will classify a given <see cref="T:System.ClientModel.Primitives.PipelineMessage" />. Returning
            <c>false</c> from <see cref="M:System.ClientModel.Primitives.PipelineMessageClassifier.TryClassify(System.ClientModel.Primitives.PipelineMessage,System.Boolean@)" />
            allows a classifier instance to compose with other classifiers by
            passing the classification decision to a later instance.
            <see cref="P:System.ClientModel.Primitives.PipelineMessageClassifier.Default" /> will always return <c>true</c> from
            <see cref="M:System.ClientModel.Primitives.PipelineMessageClassifier.TryClassify(System.ClientModel.Primitives.PipelineMessage,System.Boolean@)" /> and may be used as
            the last classifier in any composed classifier collection.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="TryClassify">
      <MemberSignature Language="C#" Value="public abstract bool TryClassify (System.ClientModel.Primitives.PipelineMessage message, Exception? exception, out bool isRetriable);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryClassify(class System.ClientModel.Primitives.PipelineMessage message, class System.Exception exception, [out] bool&amp; isRetriable) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.PipelineMessageClassifier.TryClassify(System.ClientModel.Primitives.PipelineMessage,System.Exception,System.Boolean@)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function TryClassify (message As PipelineMessage, exception As Exception, ByRef isRetriable As Boolean) As Boolean" />
      <MemberSignature Language="F#" Value="abstract member TryClassify : System.ClientModel.Primitives.PipelineMessage * Exception * bool -&gt; bool" Usage="pipelineMessageClassifier.TryClassify (message, exception, isRetriable)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.ClientModel.Primitives.PipelineMessage" />
        <Parameter Name="exception" Type="System.Exception" />
        <Parameter Name="isRetriable" Type="System.Boolean" RefType="out" />
      </Parameters>
      <Docs>
        <param name="message">The <see cref="T:System.ClientModel.Primitives.PipelineMessage" /> to classify.</param>
        <param name="exception">An <see cref="T:System.Exception" />, if any, that will
            also be used in the retry classification. Callers are intended to
            provide any exception thrown during the attempt to send the prior
            request.</param>
        <param name="isRetriable">
          <c>true</c> if the
            <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> should be retried.</param>
        <summary>
            Attempt to evaluate whether the provided <see cref="T:System.ClientModel.Primitives.PipelineMessage" />
            contains a <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" /> that indicates the
            client should retry the <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" />.
            </summary>
        <returns>
          <c>true</c> if the classifier had an opinion regarding whether
            the service request should be retried; <c>false</c> otherwise.
            </returns>
        <remarks>
            Not all classifiers derived from <see cref="T:System.ClientModel.Primitives.PipelineMessageClassifier" />
            will classify a given <see cref="T:System.ClientModel.Primitives.PipelineMessage" />. Returning
            <c>false</c> from <see cref="M:System.ClientModel.Primitives.PipelineMessageClassifier.TryClassify(System.ClientModel.Primitives.PipelineMessage,System.Boolean@)" />
            allows a classifier instance to compose with other classifiers by
            passing the classification decision to a later instance.
            <see cref="P:System.ClientModel.Primitives.PipelineMessageClassifier.Default" /> will always return <c>true</c> from
            <see cref="M:System.ClientModel.Primitives.PipelineMessageClassifier.TryClassify(System.ClientModel.Primitives.PipelineMessage,System.Boolean@)" /> and may be used as
            the last classifier in any composed classifier collection.
            </remarks>
      </Docs>
    </Member>
  </Members>
</Type>