mcs/class/System/Documentation/en/System.Net/SocketAddress.xml

   1 <Type Name="SocketAddress" FullName="System.Net.SocketAddress" FullNameSP="System_Net_SocketAddress" Maintainer="ecma">
   2   <TypeSignature Language="ILASM" Value=".class public SocketAddress extends System.Object" />
   3   <TypeSignature Language="C#" Value="public class SocketAddress" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SocketAddress extends System.Object" />
   5   <MemberOfLibrary>Networking</MemberOfLibrary>
   6   <AssemblyInfo>
   7     <AssemblyName>System</AssemblyName>
   8     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
   9     <AssemblyVersion>1.0.x.x</AssemblyVersion>
  10     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  11     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  12     <AssemblyVersion>4.0.0.0</AssemblyVersion>
  13   </AssemblyInfo>
  14   <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
  15   <Base>
  16     <BaseTypeName>System.Object</BaseTypeName>
  17   </Base>
  18   <Interfaces />
  19   <Docs>
  20     <summary>
  21       <para> Provides a socket address stored in a <see cref="T:System.Byte" qualify="true" /> array.
  22    </para>
  23     </summary>
  24     <remarks>
  25       <para>At a minimum, a socket address consists of a member of the <see cref="T:System.Net.Sockets.AddressFamily" qualify="true" /> enumeration
  26    stored in the first two bytes of the array.</para>
  27     </remarks>
  28   </Docs>
  29   <Members>
  30     <Member MemberName=".ctor">
  31       <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(valuetype System.Net.Sockets.AddressFamily family)" />
  32       <MemberSignature Language="C#" Value="public SocketAddress (System.Net.Sockets.AddressFamily family);" />
  33       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Net.Sockets.AddressFamily family) cil managed" />
  34       <MemberType>Constructor</MemberType>
  35       <AssemblyInfo>
  36         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  37         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  38         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  39       </AssemblyInfo>
  40       <ReturnValue />
  41       <Parameters>
  42         <Parameter Name="family" Type="System.Net.Sockets.AddressFamily" />
  43       </Parameters>
  44       <Docs>
  45         <param name="family">One of the values of the <see cref="T:System.Net.Sockets.AddressFamily" /> enumeration.</param>
  46         <summary>
  47           <para>Constructs and initializes a new instance of the <see cref="T:System.Net.SocketAddress" />
  48 class.</para>
  49         </summary>
  50         <remarks>
  51           <para>This method is equivalent to <see cref="!:System.Net.SocketAddress.SocketAddress" />(<paramref name="family" />, 32).</para>
  52         </remarks>
  53       </Docs>
  54       <Excluded>0</Excluded>
  55     </Member>
  56     <Member MemberName=".ctor">
  57       <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(valuetype System.Net.Sockets.AddressFamily family, int32 size)" />
  58       <MemberSignature Language="C#" Value="public SocketAddress (System.Net.Sockets.AddressFamily family, int size);" />
  59       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Net.Sockets.AddressFamily family, int32 size) cil managed" />
  60       <MemberType>Constructor</MemberType>
  61       <AssemblyInfo>
  62         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  63         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  64         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  65       </AssemblyInfo>
  66       <ReturnValue />
  67       <Parameters>
  68         <Parameter Name="family" Type="System.Net.Sockets.AddressFamily" />
  69         <Parameter Name="size" Type="System.Int32" />
  70       </Parameters>
  71       <Docs>
  72         <param name="family">One of the values of the <see cref="T:System.Net.Sockets.AddressFamily" /> enumeration.</param>
  73         <param name="size">A <see cref="T:System.Int32" qualify="true" /> containing the number of bytes to allocate for the <see cref="T:System.Byte" qualify="true" /> array storing the socket address.</param>
  74         <summary>
  75           <para>Constructs and initializes a new instance of the <see cref="T:System.Net.SocketAddress" />
  76 class.</para>
  77         </summary>
  78         <remarks>
  79           <para>The minimum value for <paramref name="size" /> is 2 bytes.</para>
  80         </remarks>
  81         <exception cref="T:System.ArgumentOutOfRangeException">
  82           <paramref name="size" /> is less than 2.</exception>
  83       </Docs>
  84       <Excluded>0</Excluded>
  85     </Member>
  86     <Member MemberName="Equals">
  87       <MemberSignature Language="ILASM" Value=".method public hidebysig virtual bool Equals(object comparand)" />
  88       <MemberSignature Language="C#" Value="public override bool Equals (object comparand);" />
  89       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object comparand) cil managed" />
  90       <MemberType>Method</MemberType>
  91       <AssemblyInfo>
  92         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  93         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  94         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  95       </AssemblyInfo>
  96       <ReturnValue>
  97         <ReturnType>System.Boolean</ReturnType>
  98       </ReturnValue>
  99       <Parameters>
 100         <Parameter Name="comparand" Type="System.Object" />
 101       </Parameters>
 102       <Docs>
 103         <param name="comparand">The <see cref="T:System.Object" qualify="true" /> to compare to the current instance.</param>
 104         <summary>
 105           <para>Determines whether the current instance and the
 106       specified <see cref="T:System.Object" qualify="true" /> represent the same
 107       socket address.</para>
 108         </summary>
 109         <returns>
 110           <para>A <see cref="T:System.Boolean" qualify="true" /> where <see langword="true" />
 111 indicates <paramref name="comparand" /> is an
 112 instance of the <see cref="T:System.Net.SocketAddress" /> class and contains the same data as the current
 113 instance; otherwise <see langword="false" />.</para>
 114         </returns>
 115         <remarks>
 116           <block subset="none" type="note">
 117             <para>This method overrides <see cref="M:System.Object.Equals(System.Object)" qualify="true" />.</para>
 118           </block>
 119         </remarks>
 120       </Docs>
 121       <Excluded>0</Excluded>
 122     </Member>
 123     <Member MemberName="Family">
 124       <MemberSignature Language="ILASM" Value=".property valuetype System.Net.Sockets.AddressFamily Family { public hidebysig specialname instance valuetype System.Net.Sockets.AddressFamily get_Family() }" />
 125       <MemberSignature Language="C#" Value="public System.Net.Sockets.AddressFamily Family { get; }" />
 126       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.Sockets.AddressFamily Family" />
 127       <MemberType>Property</MemberType>
 128       <AssemblyInfo>
 129         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 130         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 131         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 132       </AssemblyInfo>
 133       <ReturnValue>
 134         <ReturnType>System.Net.Sockets.AddressFamily</ReturnType>
 135       </ReturnValue>
 136       <Parameters />
 137       <Docs>
 138         <summary>
 139           <para>Gets the address family which specifies the addressing scheme used to resolve an address.</para>
 140         </summary>
 141         <value>
 142           <para>One of the values defined in the <see cref="T:System.Net.Sockets.AddressFamily" qualify="true" /> enumeration.</para>
 143         </value>
 144         <remarks>
 145           <para>This property is read-only.</para>
 146           <para>This property is set by the <see cref="T:System.Net.SocketAddress" /> constructors and is stored in
 147    the first two bytes of the socket address array.</para>
 148         </remarks>
 149       </Docs>
 150       <Excluded>0</Excluded>
 151     </Member>
 152     <Member MemberName="GetHashCode">
 153       <MemberSignature Language="ILASM" Value=".method public hidebysig virtual int32 GetHashCode()" />
 154       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
 155       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
 156       <MemberType>Method</MemberType>
 157       <AssemblyInfo>
 158         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 159         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 160         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 161       </AssemblyInfo>
 162       <ReturnValue>
 163         <ReturnType>System.Int32</ReturnType>
 164       </ReturnValue>
 165       <Parameters />
 166       <Docs>
 167         <summary>
 168           <para>Generates a hash code for the current instance.</para>
 169         </summary>
 170         <returns>
 171           <para>A <see cref="T:System.Int32" qualify="true" /> containing the hash code for the current instance.</para>
 172         </returns>
 173         <remarks>
 174           <para>The algorithm used to generate the hash code is
 175          unspecified.</para>
 176           <block subset="none" type="note">
 177             <para>This method overrides <see cref="M:System.Object.GetHashCode" qualify="true" />.</para>
 178           </block>
 179         </remarks>
 180       </Docs>
 181       <Excluded>0</Excluded>
 182     </Member>
 183     <Member MemberName="Item">
 184       <MemberSignature Language="ILASM" Value=".property unsigned int8 Item[int32 offset] { public hidebysig specialname instance unsigned int8 get_Item(int32 offset) public hidebysig specialname instance void set_Item(int32 offset, unsigned int8 value) }" />
 185       <MemberSignature Language="C#" Value="public byte this[int offset] { get; set; }" />
 186       <MemberSignature Language="ILAsm" Value=".property instance unsigned int8 Item(int32)" />
 187       <MemberType>Property</MemberType>
 188       <AssemblyInfo>
 189         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 190         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 191         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 192       </AssemblyInfo>
 193       <ReturnValue>
 194         <ReturnType>System.Byte</ReturnType>
 195       </ReturnValue>
 196       <Parameters>
 197         <Parameter Name="offset" Type="System.Int32" />
 198       </Parameters>
 199       <Docs>
 200         <param name="offset">A <see cref="T:System.Int32" qualify="true" /> containing the zero-based index of the element to get or set.</param>
 201         <summary>
 202           <para>Gets or sets the element at the specified index of
 203       the <see cref="T:System.Byte" qualify="true" /> array storing the socket address.</para>
 204         </summary>
 205         <value>
 206           <para>A <see cref="T:System.Byte" qualify="true" /> containing the element at the specified index.</para>
 207         </value>
 208         <remarks>To be added.</remarks>
 209         <exception cref="T:System.IndexOutOfRangeException">
 210           <para>
 211             <paramref name="offset" /> is &lt; 0.</para>
 212           <para>-or-</para>
 213           <para>
 214             <paramref name="offset" /> &gt;= <see cref="P:System.Net.SocketAddress.Size" />.</para>
 215         </exception>
 216       </Docs>
 217       <Excluded>0</Excluded>
 218     </Member>
 219     <Member MemberName="Size">
 220       <MemberSignature Language="ILASM" Value=".property int32 Size { public hidebysig specialname instance int32 get_Size() }" />
 221       <MemberSignature Language="C#" Value="public int Size { get; }" />
 222       <MemberSignature Language="ILAsm" Value=".property instance int32 Size" />
 223       <MemberType>Property</MemberType>
 224       <AssemblyInfo>
 225         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 226         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 227         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 228       </AssemblyInfo>
 229       <ReturnValue>
 230         <ReturnType>System.Int32</ReturnType>
 231       </ReturnValue>
 232       <Parameters />
 233       <Docs>
 234         <summary>
 235           <para> Gets the length of the socket address.</para>
 236         </summary>
 237         <value>
 238           <para>A <see cref="T:System.Int32" qualify="true" /> containing the length of the
 239 <see cref="T:System.Byte" qualify="true" /> array storing the socket
 240    address.</para>
 241         </value>
 242         <remarks>
 243           <para>This property is read-only.</para>
 244           <para>This property is set by the <see cref="T:System.Net.SocketAddress" /> constructors.</para>
 245         </remarks>
 246       </Docs>
 247       <Excluded>0</Excluded>
 248     </Member>
 249     <Member MemberName="ToString">
 250       <MemberSignature Language="ILASM" Value=".method public hidebysig virtual string ToString()" />
 251       <MemberSignature Language="C#" Value="public override string ToString ();" />
 252       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
 253       <MemberType>Method</MemberType>
 254       <AssemblyInfo>
 255         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 256         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 257         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 258       </AssemblyInfo>
 259       <ReturnValue>
 260         <ReturnType>System.String</ReturnType>
 261       </ReturnValue>
 262       <Parameters />
 263       <Docs>
 264         <summary>
 265           <para>Returns a <see cref="T:System.String" qualify="true" /> representation of the value of the current instance.</para>
 266         </summary>
 267         <returns>
 268           <para>A <see cref="T:System.String" qualify="true" /> representation of the current
 269    instance.</para>
 270         </returns>
 271         <remarks>
 272           <para> The returned string contains the string representation of the address family, the length of the array holding the socket
 273       address, and the contents of the array from the third to the maximum element, output in the
 274       following format:</para>
 275           <para>
 276             <see cref="P:System.Net.SocketAddress.Family" />:<see cref="P:System.Net.SocketAddress.Size" />:{array[2], array[3], ...,
 277    element[<see langword="Size" />-
 278    1]}</para>
 279           <block subset="none" type="note">
 280             <para>This method overrides <see cref="M:System.Object.ToString" qualify="true" />.</para>
 281           </block>
 282         </remarks>
 283         <example>
 284           <para>The following example writes a socket address to the
 285       console.</para>
 286           <code lang="C#">using System;
 287 using System.Net;
 288 using System.Net.Sockets;
 289
 290 public class SocketAddressToString{
 291   public static void Main() {
 292     Console.WriteLine("This is a minimal SocketAddress.");
 293     SocketAddress socketAddress = new
 294            SocketAddress(AddressFamily.InterNetwork);
 295     Console.WriteLine("{0}", socketAddress.ToString());
 296   }
 297 }
 298    </code>
 299           <para>The output is</para>
 300           <c>
 301             <para>This is a minimal SocketAddress.</para>
 302             <para>InterNetwork:32:{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}</para>
 303           </c>
 304         </example>
 305       </Docs>
 306       <Excluded>0</Excluded>
 307     </Member>
 308   </Members>
 309   <TypeExcluded>0</TypeExcluded>
 310 </Type>