IRetryPolicy.xml

<Type Name="IRetryPolicy" FullName="Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy">
  <TypeSignature Language="C#" Value="public interface IRetryPolicy" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IRetryPolicy" />
  <TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy" />
  <TypeSignature Language="VB.NET" Value="Public Interface IRetryPolicy" />
  <TypeSignature Language="F#" Value="type IRetryPolicy = interface" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Docs>
    <summary>
            Specifies the retry policy for retrying requests on exceptions in the communication channel between
            client and service replicas.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="ClientRetryTimeout">
      <MemberSignature Language="C#" Value="public TimeSpan ClientRetryTimeout { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan ClientRetryTimeout" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy.ClientRetryTimeout" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ClientRetryTimeout As TimeSpan" />
      <MemberSignature Language="F#" Value="member this.ClientRetryTimeout : TimeSpan" Usage="Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy.ClientRetryTimeout" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.TimeSpan</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the timeout for the client side retry.
            </summary>
        <value>Amount of time we retry before throwing the OperationCancelledException to the user Api.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetNextRetryDelay">
      <MemberSignature Language="C#" Value="public TimeSpan GetNextRetryDelay (Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters retryDelayParameters);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.TimeSpan GetNextRetryDelay(class Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters retryDelayParameters) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy.GetNextRetryDelay(Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetNextRetryDelay (retryDelayParameters As RetryDelayParameters) As TimeSpan" />
      <MemberSignature Language="F#" Value="abstract member GetNextRetryDelay : Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters -&gt; TimeSpan" Usage="iRetryPolicy.GetNextRetryDelay retryDelayParameters" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.TimeSpan</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="retryDelayParameters" Type="Microsoft.ServiceFabric.Services.Communication.Client.RetryDelayParameters" />
      </Parameters>
      <Docs>
        <param name="retryDelayParameters">
             The retry delay parameters to be used to calculate retry.
            </param>
        <summary>
            Gets the maximum interval to back-off before retrying in-case of Transient errors
            </summary>
        <returns>Maximum retry interval to back-off on transient errors</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TotalNumberOfRetries">
      <MemberSignature Language="C#" Value="public int TotalNumberOfRetries { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 TotalNumberOfRetries" />
      <MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy.TotalNumberOfRetries" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property TotalNumberOfRetries As Integer" />
      <MemberSignature Language="F#" Value="member this.TotalNumberOfRetries : int" Usage="Microsoft.ServiceFabric.Services.Communication.Client.IRetryPolicy.TotalNumberOfRetries" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the maximum number of times to retry.
            </summary>
        <value>Maximum number of times to retry a specific exception.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>