xml/System.ClientModel.Primitives/ClientConnectionProvider.xml

<Type Name="ClientConnectionProvider" FullName="System.ClientModel.Primitives.ClientConnectionProvider">
  <TypeSignature Language="C#" Value="public abstract class ClientConnectionProvider" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ClientConnectionProvider extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.ClientConnectionProvider" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class ClientConnectionProvider" />
  <TypeSignature Language="F#" Value="type ClientConnectionProvider = class" />
  <AssemblyInfo>
    <AssemblyName>System.ClientModel</AssemblyName>
    <AssemblyVersion>1.4.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Abstract base class for managing client connections.
            Provides connection options for a specified client type and instance ID.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected ClientConnectionProvider (int maxCacheSize);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(int32 maxCacheSize) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientConnectionProvider.#ctor(System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New (maxCacheSize As Integer)" />
      <MemberSignature Language="F#" Value="new System.ClientModel.Primitives.ClientConnectionProvider : int -&gt; System.ClientModel.Primitives.ClientConnectionProvider" Usage="new System.ClientModel.Primitives.ClientConnectionProvider maxCacheSize" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="maxCacheSize" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="maxCacheSize">The maximum number of subclients to store in the cache.</param>
        <summary>
            Initializes a new instance of the ConnectionProvider class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetAllConnections">
      <MemberSignature Language="C#" Value="public abstract System.Collections.Generic.IEnumerable&lt;System.ClientModel.Primitives.ClientConnection&gt; GetAllConnections ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1&lt;valuetype System.ClientModel.Primitives.ClientConnection&gt; GetAllConnections() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientConnectionProvider.GetAllConnections" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function GetAllConnections () As IEnumerable(Of ClientConnection)" />
      <MemberSignature Language="F#" Value="abstract member GetAllConnections : unit -&gt; seq&lt;System.ClientModel.Primitives.ClientConnection&gt;" Usage="clientConnectionProvider.GetAllConnections " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IEnumerable&lt;System.ClientModel.Primitives.ClientConnection&gt;</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Retrieves all available client connections managed by this provider.
            </summary>
        <returns>A collection of <see cref="T:System.ClientModel.Primitives.ClientConnection" /> instances.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetConnection">
      <MemberSignature Language="C#" Value="public abstract System.ClientModel.Primitives.ClientConnection GetConnection (string connectionId);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.ClientModel.Primitives.ClientConnection GetConnection(string connectionId) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientConnectionProvider.GetConnection(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public MustOverride Function GetConnection (connectionId As String) As ClientConnection" />
      <MemberSignature Language="F#" Value="abstract member GetConnection : string -&gt; System.ClientModel.Primitives.ClientConnection" Usage="clientConnectionProvider.GetConnection connectionId" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.ClientConnection</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="connectionId" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="connectionId">The unique identifier for the connection.</param>
        <summary>
            Retrieves the connection settings associated with a given connection ID.
            </summary>
        <returns>The <see cref="T:System.ClientModel.Primitives.ClientConnection" /> instance containing authentication and endpoint details.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Subclients">
      <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.ClientCache Subclients { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.ClientCache Subclients" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientConnectionProvider.Subclients" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Subclients As ClientCache" />
      <MemberSignature Language="F#" Value="member this.Subclients : System.ClientModel.Primitives.ClientCache" Usage="System.ClientModel.Primitives.ClientConnectionProvider.Subclients" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.ClientCache</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the cache for subclients to optimize performance by reusing client instances.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>