linux-packaging-mono/mcs/class/System/Documentation/en/System.Net.NetworkInformation/UdpStatistics.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="UdpStatistics" FullName="System.Net.NetworkInformation.UdpStatistics">
  <TypeSignature Language="C#" Value="public abstract class UdpStatistics" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit UdpStatistics extends System.Object" />
  <AssemblyInfo>
    <AssemblyName>System</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Instances of this class are returned by the <see cref="M:System.Net.NetworkInformation.IPGlobalProperties.GetUdpIPv4Statistics" /> and <see cref="M:System.Net.NetworkInformation.IPGlobalProperties.GetUdpIPv6Statistics" /> methods to give applications access to UDP traffic information.</para>
      <para>The information in this class correlates to the management information objects described in <see cref="http://www.ietf.org/rfc/rfc2013.txt">http://www.ietf.org/rfc/rfc2013.txt</see>.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Provides User Datagram Protocol (UDP) statistical data.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected UdpStatistics ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This constructor can be called only by classes that derive from <see cref="T:System.Net.NetworkInformation.UdpStatistics" />.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Net.NetworkInformation.UdpStatistics" /> class.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="DatagramsReceived">
      <MemberSignature Language="C#" Value="public abstract long DatagramsReceived { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 DatagramsReceived" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The number returned by this property does not include datagrams that were received but not deliverable.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the number of User Datagram Protocol (UDP) datagrams that were received.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="DatagramsSent">
      <MemberSignature Language="C#" Value="public abstract long DatagramsSent { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 DatagramsSent" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the number of User Datagram Protocol (UDP) datagrams that were sent.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="IncomingDatagramsDiscarded">
      <MemberSignature Language="C#" Value="public abstract long IncomingDatagramsDiscarded { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 IncomingDatagramsDiscarded" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>To find the total number of datagrams that could not be delivered, add the values that were returned by this property and the <see cref="P:System.Net.NetworkInformation.UdpStatistics.IncomingDatagramsWithErrors" /> property.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the number of User Datagram Protocol (UDP) datagrams that were received and discarded because of port errors.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="IncomingDatagramsWithErrors">
      <MemberSignature Language="C#" Value="public abstract long IncomingDatagramsWithErrors { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 IncomingDatagramsWithErrors" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>To find the total number of datagrams that could not be delivered, add the values that were returned by this property and the <see cref="P:System.Net.NetworkInformation.UdpStatistics.IncomingDatagramsDiscarded" /> property.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the number of User Datagram Protocol (UDP) datagrams that were received and discarded because of errors other than bad port information.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="UdpListeners">
      <MemberSignature Language="C#" Value="public abstract int UdpListeners { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 UdpListeners" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>You can use the <see cref="T:System.Net.Sockets.UdpClient" /> and <see cref="T:System.Net.Sockets.Socket" /> classes to create UDP listener applications.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the number of local endpoints that are listening for User Datagram Protocol (UDP) datagrams.</para>
        </summary>
      </Docs>
    </Member>
  </Members>
</Type>