xml/System.ClientModel.Primitives/ClientPipelineOptions.xml

<Type Name="ClientPipelineOptions" FullName="System.ClientModel.Primitives.ClientPipelineOptions">
  <TypeSignature Language="C#" Value="public class ClientPipelineOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ClientPipelineOptions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.ClientPipelineOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class ClientPipelineOptions" />
  <TypeSignature Language="F#" Value="type ClientPipelineOptions = 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>
            Options that control the creation of a <see cref="T:System.ClientModel.Primitives.ClientPipeline" /> used
            by a service client to send and receive HTTP messages.
            Service clients must create a client-specific subtype of this class
            to pass to their constructors to allow for service-specific options
            with a client-wide scope.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientPipelineOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientPipelineOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public 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="AddPolicy">
      <MemberSignature Language="C#" Value="public void AddPolicy (System.ClientModel.Primitives.PipelinePolicy policy, System.ClientModel.Primitives.PipelinePosition position);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddPolicy(class System.ClientModel.Primitives.PipelinePolicy policy, valuetype System.ClientModel.Primitives.PipelinePosition position) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientPipelineOptions.AddPolicy(System.ClientModel.Primitives.PipelinePolicy,System.ClientModel.Primitives.PipelinePosition)" />
      <MemberSignature Language="VB.NET" Value="Public Sub AddPolicy (policy As PipelinePolicy, position As PipelinePosition)" />
      <MemberSignature Language="F#" Value="member this.AddPolicy : System.ClientModel.Primitives.PipelinePolicy * System.ClientModel.Primitives.PipelinePosition -&gt; unit" Usage="clientPipelineOptions.AddPolicy (policy, position)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="policy" Type="System.ClientModel.Primitives.PipelinePolicy" />
        <Parameter Name="position" Type="System.ClientModel.Primitives.PipelinePosition" />
      </Parameters>
      <Docs>
        <param name="policy">The <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to add to the
            pipeline.</param>
        <param name="position">The position of the policy in the pipeline.</param>
        <summary>
            Adds the provided <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to the default
            <see cref="T:System.ClientModel.Primitives.ClientPipeline" />.
            </summary>
        <remarks>
            For a policy to run once per invocation of
            <see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />, use
            <see cref="F:System.ClientModel.Primitives.PipelinePosition.PerCall" />, which will insert the policy
            before the pipeline's <see cref="P:System.ClientModel.Primitives.ClientPipelineOptions.RetryPolicy" />. For a policy to run
            once per retry attempt, use <see cref="F:System.ClientModel.Primitives.PipelinePosition.PerTry" />, which
            will insert the policy after the pipeline's <see cref="P:System.ClientModel.Primitives.ClientPipelineOptions.RetryPolicy" />.
            To ensure that a policy runs after all other policies in the pipeline
            have viewed the <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> and before all
            other policies view the <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" />, use
            <see cref="F:System.ClientModel.Primitives.PipelinePosition.BeforeTransport" />. Changes made to
            <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> by a before-transport policy will
            not be visible to any logging policies that come before it in the
            pipeline.
            </remarks>
        <exception cref="T:System.ArgumentException">Thrown when the provided policy
            is <c>null</c>.</exception>
      </Docs>
    </Member>
    <Member MemberName="AssertNotFrozen">
      <MemberSignature Language="C#" Value="protected void AssertNotFrozen ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void AssertNotFrozen() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientPipelineOptions.AssertNotFrozen" />
      <MemberSignature Language="VB.NET" Value="Protected Sub AssertNotFrozen ()" />
      <MemberSignature Language="F#" Value="member this.AssertNotFrozen : unit -&gt; unit" Usage="clientPipelineOptions.AssertNotFrozen " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Assert that <see cref="M:System.ClientModel.Primitives.ClientPipelineOptions.Freeze" /> has not been called on this
            <see cref="T:System.ClientModel.Primitives.ClientPipelineOptions" /> instance.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.InvalidOperationException">Thrown when an attempt is
            made to change the state of this <see cref="T:System.ClientModel.Primitives.ClientPipelineOptions" />
            instance after <see cref="M:System.ClientModel.Primitives.ClientPipelineOptions.Freeze" /> has been called.</exception>
      </Docs>
    </Member>
    <Member MemberName="ClientLoggingOptions">
      <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.ClientLoggingOptions? ClientLoggingOptions { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.ClientLoggingOptions ClientLoggingOptions" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientPipelineOptions.ClientLoggingOptions" />
      <MemberSignature Language="VB.NET" Value="Public Property ClientLoggingOptions As ClientLoggingOptions" />
      <MemberSignature Language="F#" Value="member this.ClientLoggingOptions : System.ClientModel.Primitives.ClientLoggingOptions with get, set" Usage="System.ClientModel.Primitives.ClientPipelineOptions.ClientLoggingOptions" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.ClientLoggingOptions</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The options to be used to configure logging within the
            <see cref="T:System.ClientModel.Primitives.ClientPipeline" />.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EnableDistributedTracing">
      <MemberSignature Language="C#" Value="public bool? EnableDistributedTracing { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; EnableDistributedTracing" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientPipelineOptions.EnableDistributedTracing" />
      <MemberSignature Language="VB.NET" Value="Public Property EnableDistributedTracing As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.EnableDistributedTracing : Nullable&lt;bool&gt; with get, set" Usage="System.ClientModel.Primitives.ClientPipelineOptions.EnableDistributedTracing" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets whether distributed tracing should be enabled. If <c>null</c>, this
            value will be treated as <c>true</c>. The default is <c>null</c>.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Freeze">
      <MemberSignature Language="C#" Value="public virtual void Freeze ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Freeze() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientPipelineOptions.Freeze" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Sub Freeze ()" />
      <MemberSignature Language="F#" Value="abstract member Freeze : unit -&gt; unit&#xA;override this.Freeze : unit -&gt; unit" Usage="clientPipelineOptions.Freeze " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Freeze this instance of <see cref="T:System.ClientModel.Primitives.ClientPipelineOptions" />.  After
            this method has been called, any attempt to set properties on the
            instance or call methods that would change its state will throw
            <see cref="T:System.InvalidOperationException" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="MessageLoggingPolicy">
      <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelinePolicy? MessageLoggingPolicy { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelinePolicy MessageLoggingPolicy" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientPipelineOptions.MessageLoggingPolicy" />
      <MemberSignature Language="VB.NET" Value="Public Property MessageLoggingPolicy As PipelinePolicy" />
      <MemberSignature Language="F#" Value="member this.MessageLoggingPolicy : System.ClientModel.Primitives.PipelinePolicy with get, set" Usage="System.ClientModel.Primitives.ClientPipelineOptions.MessageLoggingPolicy" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.PipelinePolicy</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to be used by the
            <see cref="T:System.ClientModel.Primitives.ClientPipeline" /> for logging.
            </summary>
        <value>To be added.</value>
        <remarks>
            In most cases, this property will be set to an instance of
            <see cref="P:System.ClientModel.Primitives.ClientPipelineOptions.MessageLoggingPolicy" />.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="NetworkTimeout">
      <MemberSignature Language="C#" Value="public TimeSpan? NetworkTimeout { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;valuetype System.TimeSpan&gt; NetworkTimeout" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientPipelineOptions.NetworkTimeout" />
      <MemberSignature Language="VB.NET" Value="Public Property NetworkTimeout As Nullable(Of TimeSpan)" />
      <MemberSignature Language="F#" Value="member this.NetworkTimeout : Nullable&lt;TimeSpan&gt; with get, set" Usage="System.ClientModel.Primitives.ClientPipelineOptions.NetworkTimeout" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.TimeSpan&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The timeout applied to an individual network operation.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RetryPolicy">
      <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelinePolicy? RetryPolicy { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelinePolicy RetryPolicy" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientPipelineOptions.RetryPolicy" />
      <MemberSignature Language="VB.NET" Value="Public Property RetryPolicy As PipelinePolicy" />
      <MemberSignature Language="F#" Value="member this.RetryPolicy : System.ClientModel.Primitives.PipelinePolicy with get, set" Usage="System.ClientModel.Primitives.ClientPipelineOptions.RetryPolicy" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.PipelinePolicy</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to be used by the
            <see cref="T:System.ClientModel.Primitives.ClientPipeline" /> for handling retry logic.
            </summary>
        <value>To be added.</value>
        <remarks>
            In most cases, this property will be set to an instance of
            <see cref="T:System.ClientModel.Primitives.ClientRetryPolicy" />.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="Transport">
      <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineTransport? Transport { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineTransport Transport" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientPipelineOptions.Transport" />
      <MemberSignature Language="VB.NET" Value="Public Property Transport As PipelineTransport" />
      <MemberSignature Language="F#" Value="member this.Transport : System.ClientModel.Primitives.PipelineTransport with get, set" Usage="System.ClientModel.Primitives.ClientPipelineOptions.Transport" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.PipelineTransport</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the <see cref="T:System.ClientModel.Primitives.PipelineTransport" /> to be used by the
            <see cref="T:System.ClientModel.Primitives.ClientPipeline" /> for sending and receiving HTTP messages.
            </summary>
        <value>To be added.</value>
        <remarks>
            In most cases, this property will be set to an instance of
            <see cref="T:System.ClientModel.Primitives.HttpClientPipelineTransport" />.
            </remarks>
      </Docs>
    </Member>
  </Members>
</Type>