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