399 lines
20 KiB
XML
399 lines
20 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="IPEndPoint" FullName="System.Net.IPEndPoint" FullNameSP="System_Net_IPEndPoint" Maintainer="ecma">
|
|
<TypeSignature Language="ILASM" Value=".class public serializable IPEndPoint extends System.Net.EndPoint" />
|
|
<TypeSignature Language="C#" Value="public class IPEndPoint : System.Net.EndPoint" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit IPEndPoint extends System.Net.EndPoint" />
|
|
<MemberOfLibrary>Networking</MemberOfLibrary>
|
|
<AssemblyInfo>
|
|
<AssemblyName>System</AssemblyName>
|
|
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
|
|
<AssemblyVersion>1.0.x.x</AssemblyVersion>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
|
|
<Base>
|
|
<BaseTypeName>System.Net.EndPoint</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Net.IPEndPoint" /> class contains the host and local or remote port information needed by an application to connect to a service on a host. By combining the host's IP address and port number of a service, the <see cref="T:System.Net.IPEndPoint" /> class forms a connection point to a service.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Represents a network endpoint as an IP address and a port number.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(int64 address, int32 port)" />
|
|
<MemberSignature Language="C#" Value="public IPEndPoint (long address, int port);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int64 address, int32 port) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="address" Type="System.Int64" />
|
|
<Parameter Name="port" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<para>
|
|
<paramref name="port " />is less than <see cref="F:System.Net.IPEndPoint.MinPort" /> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />. </para>
|
|
<para>A negative number was specified for <paramref name="address" />. </para>
|
|
</exception>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Net.IPEndPoint" /> class with the specified address and port number.</para>
|
|
</summary>
|
|
<param name="address">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The IP address of the Internet host. </param>
|
|
<param name="port">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The port number associated with the <paramref name="address" />, or 0 to specify any available port. <paramref name="port" /> is in host order.</param>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.Net.IPAddress address, int32 port)" />
|
|
<MemberSignature Language="C#" Value="public IPEndPoint (System.Net.IPAddress address, int port);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Net.IPAddress address, int32 port) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="address" Type="System.Net.IPAddress" />
|
|
<Parameter Name="port" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="address" /> is <see langword="null" />.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<para>
|
|
<paramref name="port " />is less than <see cref="F:System.Net.IPEndPoint.MinPort" /> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />. </para>
|
|
</exception>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Net.IPEndPoint" /> class with the specified address and port number.</para>
|
|
</summary>
|
|
<param name="address">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Net.IPAddress" />. </param>
|
|
<param name="port">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The port number associated with the <paramref name="address" />, or 0 to specify any available port. <paramref name="port" /> is in host order.</param>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="Address">
|
|
<MemberSignature Language="ILASM" Value=".property class System.Net.IPAddress Address { public hidebysig specialname instance class System.Net.IPAddress get_Address() public hidebysig specialname instance void set_Address(class System.Net.IPAddress value) }" />
|
|
<MemberSignature Language="C#" Value="public System.Net.IPAddress Address { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IPAddress Address" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.IPAddress</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>
|
|
<para>A <see cref="T:System.Net.IPAddress" /> instance containing the IP address of the end
|
|
point.</para>
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the IP address of the endpoint.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="AddressFamily">
|
|
<MemberSignature Language="ILASM" Value=".property valuetype System.Net.Sockets.AddressFamily AddressFamily { public hidebysig virtual specialname valuetype System.Net.Sockets.AddressFamily get_AddressFamily() }" />
|
|
<MemberSignature Language="C#" Value="public override System.Net.Sockets.AddressFamily AddressFamily { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.Sockets.AddressFamily AddressFamily" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.Sockets.AddressFamily</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>
|
|
<para>Returns <see cref="F:System.Net.Sockets.AddressFamily.InterNetwork" qualify="true" /> .</para>
|
|
</value>
|
|
<remarks>
|
|
<para>This property is read-only.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the Internet Protocol (IP) address family.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="Create">
|
|
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual class System.Net.EndPoint Create(class System.Net.SocketAddress socketAddress)" />
|
|
<MemberSignature Language="C#" Value="public override System.Net.EndPoint Create (System.Net.SocketAddress socketAddress);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Net.EndPoint Create(class System.Net.SocketAddress socketAddress) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.EndPoint</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="socketAddress" Type="System.Net.SocketAddress" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<para>
|
|
<block subset="none" type="note">This method
|
|
overrides <see cref="M:System.Net.EndPoint.Create(System.Net.SocketAddress)" /> .</block>
|
|
</para>
|
|
</remarks>
|
|
<exception cref="T:System.ArgumentException">The <see langword="AddressFamily" /> of the specified <see cref="T:System.Net.SocketAddress" /> is not equal to the <see langword="AddressFamily" /> of the current instance. </exception>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates an endpoint from a socket address.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An <see cref="T:System.Net.EndPoint" /> instance using the specified socket address.</para>
|
|
</returns>
|
|
<param name="socketAddress">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Net.SocketAddress" /> to use for the endpoint. </param>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="Equals">
|
|
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual bool Equals(object comparand)" />
|
|
<MemberSignature Language="C#" Value="public override bool Equals (object comparand);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object comparand) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="comparand" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<returns>
|
|
<para>
|
|
<see langword="true" /> if <paramref name="comparand" /> represents
|
|
the same endpoint as the current instance. If <paramref name="comparand" /> is a
|
|
<see langword="null" /> reference or is not an instance of <see cref="T:System.Net.IPEndPoint" />, returns
|
|
<see langword="false" /> .</para>
|
|
</returns>
|
|
<remarks>
|
|
<para>Two <see cref="T:System.Net.IPEndPoint" /> instances are equal if their <see cref="P:System.Net.IPEndPoint.Address" />
|
|
and <see cref="P:System.Net.IPEndPoint.Port" /> properties contain the same values.</para>
|
|
<para>
|
|
<block subset="none" type="note">This method
|
|
overrides <see cref="M:System.Object.Equals(System.Object)" />.</block>
|
|
</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Determines whether the specified <see cref="T:System.Object" /> is equal to the current <see cref="T:System.Net.IPEndPoint" /> instance.</para>
|
|
</summary>
|
|
<param name="comparand">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The specified <see cref="T:System.Object" /> to compare with the current <see cref="T:System.Net.IPEndPoint" /> instance.</param>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="GetHashCode">
|
|
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual int32 GetHashCode()" />
|
|
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="M:System.Net.IPEndPoint.GetHashCode" /> method returns a hash code of the IP endpoint instance. This value can be used as a key in hash tables.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a hash value for a <see cref="T:System.Net.IPEndPoint" /> instance.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An integer hash value.</para>
|
|
</returns>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="MaxPort">
|
|
<MemberSignature Language="ILASM" Value=".field public static literal int32 MaxPort = 65535" />
|
|
<MemberSignature Language="C#" Value="public const int MaxPort = 65535;" />
|
|
<MemberSignature Language="ILAsm" Value=".field public static literal int32 MaxPort = (65535)" />
|
|
<MemberType>Field</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<MemberValue>65535</MemberValue>
|
|
<Docs>
|
|
<remarks>
|
|
<para>This field is read-only. The value of this field is 65535.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Specifies the maximum value that can be assigned to the <see cref="P:System.Net.IPEndPoint.Port" /> property. The MaxPort value is set to 0x0000FFFF. This field is read-only.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="MinPort">
|
|
<MemberSignature Language="ILASM" Value=".field public static literal int32 MinPort = 0" />
|
|
<MemberSignature Language="C#" Value="public const int MinPort = 0;" />
|
|
<MemberSignature Language="ILAsm" Value=".field public static literal int32 MinPort = (0)" />
|
|
<MemberType>Field</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<MemberValue>0</MemberValue>
|
|
<Docs>
|
|
<remarks>
|
|
<para>This field is read-only. The value of this field is zero.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Specifies the minimum value that can be assigned to the <see cref="P:System.Net.IPEndPoint.Port" /> property. This field is read-only.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="Port">
|
|
<MemberSignature Language="ILASM" Value=".property int32 Port { public hidebysig specialname instance int32 get_Port() public hidebysig specialname instance void set_Port(int32 value) }" />
|
|
<MemberSignature Language="C#" Value="public int Port { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 Port" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>
|
|
<para>A <see cref="T:System.Int32" /> value that is between <see cref="F:System.Net.IPEndPoint.MinPort" /> and <see cref="F:System.Net.IPEndPoint.MaxPort" />
|
|
inclusive.</para>
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation was less than <see cref="F:System.Net.IPEndPoint.MinPort" /> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the port number of the endpoint.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
<Member MemberName="Serialize">
|
|
<MemberSignature Language="C#" Value="public override System.Net.SocketAddress Serialize ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Net.SocketAddress Serialize() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Net.SocketAddress</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Serializes endpoint information into a <see cref="T:System.Net.SocketAddress" /> instance.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A <see cref="T:System.Net.SocketAddress" /> instance containing the socket address for the endpoint.</para>
|
|
</returns>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ToString">
|
|
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual string ToString()" />
|
|
<MemberSignature Language="C#" Value="public override string ToString ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>
|
|
<para>
|
|
<block subset="none" type="note">This method overrides <see cref="M:System.Object.ToString" />.</block>
|
|
</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns the IP address and port number of the specified endpoint.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A string containing the IP address and the port number of the specified endpoint (for example, 192.168.1.2:80).</para>
|
|
</returns>
|
|
</Docs>
|
|
<Excluded>0</Excluded>
|
|
</Member>
|
|
</Members>
|
|
<TypeExcluded>0</TypeExcluded>
|
|
</Type> |