IHttpMessageHandlerFactory.xml

<Type Name="IHttpMessageHandlerFactory" FullName="System.Net.Http.IHttpMessageHandlerFactory">
  <TypeSignature Language="C#" Value="public interface IHttpMessageHandlerFactory" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IHttpMessageHandlerFactory" />
  <TypeSignature Language="DocId" Value="T:System.Net.Http.IHttpMessageHandlerFactory" />
  <TypeSignature Language="VB.NET" Value="Public Interface IHttpMessageHandlerFactory" />
  <TypeSignature Language="F#" Value="type IHttpMessageHandlerFactory = interface" />
  <TypeSignature Language="C++ CLI" Value="public interface class IHttpMessageHandlerFactory" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Extensions.Http</AssemblyName>
    <AssemblyVersion>2.2.0.0</AssemblyVersion>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>3.1.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Docs>
    <summary>
            A factory abstraction for a component that can create <see cref="T:System.Net.Http.HttpMessageHandler" /> instances with custom
            configuration for a given logical name.
            </summary>
    <remarks>
            A default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory" /> can be registered in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />
            by calling <see cref="M:Microsoft.Extensions.DependencyInjection.HttpClientFactoryServiceCollectionExtensions.AddHttpClient(Microsoft.Extensions.DependencyInjection.IServiceCollection)" />.
            The default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory" /> will be registered in the service collection as a singleton.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName="CreateHandler">
      <MemberSignature Language="C#" Value="public System.Net.Http.HttpMessageHandler CreateHandler (string name);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Net.Http.HttpMessageHandler CreateHandler(string name) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Net.Http.IHttpMessageHandlerFactory.CreateHandler(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function CreateHandler (name As String) As HttpMessageHandler" />
      <MemberSignature Language="F#" Value="abstract member CreateHandler : string -&gt; System.Net.Http.HttpMessageHandler" Usage="iHttpMessageHandlerFactory.CreateHandler name" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::Net::Http::HttpMessageHandler ^ CreateHandler(System::String ^ name);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Http</AssemblyName>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.Http.HttpMessageHandler</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="name">The logical name of the message handler to create.</param>
        <summary>
            Creates and configures an <see cref="T:System.Net.Http.HttpMessageHandler" /> instance using the configuration that corresponds
            to the logical name specified by <paramref name="name" />.
            </summary>
        <returns>A new <see cref="T:System.Net.Http.HttpMessageHandler" /> instance.</returns>
        <remarks>
          <para>
            The default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory" /> implementation may cache the underlying
            <see cref="T:System.Net.Http.HttpMessageHandler" /> instances to improve performance.
            </para>
          <para>
            The default <see cref="T:System.Net.Http.IHttpMessageHandlerFactory" /> implementation also manages the lifetime of the
            handler created, so disposing of the <see cref="T:System.Net.Http.HttpMessageHandler" /> returned by this method may
            have no effect.
            </para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>