mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Imported Upstream version 3.6.0

Browse Source 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
This commit is contained in:
Jo Shields
2014-08-13 10:39:27 +01:00
commit a575963da9
50588 changed files with 8155799 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

742
mcs/class/System/Documentation/en/System.Net.Sockets/AddressFamily.xml Normal file
View File

File diff suppressed because it is too large Load Diff

637
mcs/class/System/Documentation/en/System.Net.Sockets/IOControlCode.xml Normal file
View File

File diff suppressed because it is too large Load Diff

182
mcs/class/System/Documentation/en/System.Net.Sockets/IPPacketInformation.xml Normal file
View File

@@ -0,0 +1,182 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IPPacketInformation" FullName="System.Net.Sockets.IPPacketInformation">
<TypeSignature Language="C#" Value="public struct IPPacketInformation" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit IPPacketInformation extends System.ValueType" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Presents the packet information from a call to <see cref="M:System.Net.Sockets.Socket.ReceiveMessageFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags@,System.Net.EndPoint@,System.Net.Sockets.IPPacketInformation@)" /> or <see cref="M:System.Net.Sockets.Socket.EndReceiveMessageFrom(System.IAsyncResult,System.Net.Sockets.SocketFlags@,System.Net.EndPoint@,System.Net.Sockets.IPPacketInformation@)" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Address">
<MemberSignature Language="C#" Value="public System.Net.IPAddress Address { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IPAddress Address" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.IPAddress</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the origin information of the packet that was received as a result of calling the <see cref="M:System.Net.Sockets.Socket.ReceiveMessageFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags@,System.Net.EndPoint@,System.Net.Sockets.IPPacketInformation@)" /> method or <see cref="M:System.Net.Sockets.Socket.EndReceiveMessageFrom(System.IAsyncResult,System.Net.Sockets.SocketFlags@,System.Net.EndPoint@,System.Net.Sockets.IPPacketInformation@)" /> method.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Equals">
<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>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>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a value that indicates whether this instance is equal to a specified object.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="comparand" /> is an instance of <see cref="T:System.Net.Sockets.IPPacketInformation" /> and equals the value of the instance; otherwise, false.</para>
</returns>
<param name="comparand">
<attribution license="cc4" from="Microsoft" modified="false" />The object to compare with this instance.</param>
</Docs>
</Member>
<Member MemberName="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>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 hash code is constructed from the values of the <see cref="P:System.Net.Sockets.IPPacketInformation.Address" /> and <see cref="P:System.Net.Sockets.IPPacketInformation.Interface" /> properties.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the hash code for this instance.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An Int32 hash code.</para>
</returns>
</Docs>
</Member>
<Member MemberName="Interface">
<MemberSignature Language="C#" Value="public int Interface { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Interface" />
<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>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the network interface information that is associated with a call to <see cref="M:System.Net.Sockets.Socket.ReceiveMessageFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags@,System.Net.EndPoint@,System.Net.Sockets.IPPacketInformation@)" /> or <see cref="M:System.Net.Sockets.Socket.EndReceiveMessageFrom(System.IAsyncResult,System.Net.Sockets.SocketFlags@,System.Net.EndPoint@,System.Net.Sockets.IPPacketInformation@)" />.</para>
</summary>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool op_Equality (System.Net.Sockets.IPPacketInformation p1, System.Net.Sockets.IPPacketInformation p2);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype System.Net.Sockets.IPPacketInformation p1, valuetype System.Net.Sockets.IPPacketInformation p2) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="p1" Type="System.Net.Sockets.IPPacketInformation" />
<Parameter Name="p2" Type="System.Net.Sockets.IPPacketInformation" />
</Parameters>
<Docs>
<param name="p1">To be added.</param>
<param name="p2">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This operator tests both the <see cref="P:System.Net.Sockets.IPPacketInformation.Address" /> and <see cref="P:System.Net.Sockets.IPPacketInformation.Interface" /> values for both arguments.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Tests whether two specified <see cref="T:System.Net.Sockets.IPPacketInformation" /> instances are equivalent.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="packetInformation1" /> and <paramref name="packetInformation2" /> are equal; otherwise, false.</para>
</returns>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool op_Inequality (System.Net.Sockets.IPPacketInformation p1, System.Net.Sockets.IPPacketInformation p2);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype System.Net.Sockets.IPPacketInformation p1, valuetype System.Net.Sockets.IPPacketInformation p2) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="p1" Type="System.Net.Sockets.IPPacketInformation" />
<Parameter Name="p2" Type="System.Net.Sockets.IPPacketInformation" />
</Parameters>
<Docs>
<param name="p1">To be added.</param>
<param name="p2">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This operator tests both the <see cref="P:System.Net.Sockets.IPPacketInformation.Address" /> and <see cref="P:System.Net.Sockets.IPPacketInformation.Interface" /> values for both arguments.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Tests whether two specified <see cref="T:System.Net.Sockets.IPPacketInformation" /> instances are not equal.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="packetInformation1" /> and <paramref name="packetInformation2" /> are unequal; otherwise, false.</para>
</returns>
</Docs>
</Member>
</Members>
</Type>

119
mcs/class/System/Documentation/en/System.Net.Sockets/IPv6MulticastOption.xml Normal file
View File

@@ -0,0 +1,119 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IPv6MulticastOption" FullName="System.Net.Sockets.IPv6MulticastOption">
<TypeSignature Language="C#" Value="public class IPv6MulticastOption" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IPv6MulticastOption extends System.Object" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Contains option values for joining an IPv6 multicast group.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IPv6MulticastOption (System.Net.IPAddress group);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Net.IPAddress group) 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>
<Parameters>
<Parameter Name="group" Type="System.Net.IPAddress" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new version of the <see cref="T:System.Net.Sockets.IPv6MulticastOption" /> class for the specified IP multicast group.</para>
</summary>
<param name="group">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Net.IPAddress" /> of the multicast group. </param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IPv6MulticastOption (System.Net.IPAddress group, long ifindex);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Net.IPAddress group, int64 ifindex) 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>
<Parameters>
<Parameter Name="group" Type="System.Net.IPAddress" />
<Parameter Name="ifindex" Type="System.Int64" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <paramref name="ifindex" /> parameter specifies the interface on which data is received or sent.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.IPv6MulticastOption" /> class with the specified IP multicast group and the local interface address.</para>
</summary>
<param name="group">
<attribution license="cc4" from="Microsoft" modified="false" />The group <see cref="T:System.Net.IPAddress" />. </param>
<param name="ifindex">
<attribution license="cc4" from="Microsoft" modified="false" />The local interface address. </param>
</Docs>
</Member>
<Member MemberName="Group">
<MemberSignature Language="C#" Value="public System.Net.IPAddress Group { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IPAddress Group" />
<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>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the IP address of a multicast group.</para>
</summary>
</Docs>
</Member>
<Member MemberName="InterfaceIndex">
<MemberSignature Language="C#" Value="public long InterfaceIndex { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 InterfaceIndex" />
<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.Int64</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This property specifies the interface on which data is received or sent.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the interface index that is associated with a multicast group.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

295
mcs/class/System/Documentation/en/System.Net.Sockets/LingerOption.xml Normal file
View File

@@ -0,0 +1,295 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="LingerOption" FullName="System.Net.Sockets.LingerOption" FullNameSP="System_Net_Sockets_LingerOption" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public LingerOption extends System.Object" />
<TypeSignature Language="C#" Value="public class LingerOption" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit LingerOption extends System.Object" />
<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.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>There may still be data available in the outgoing network buffer after an application calls the <see cref="T:System.Net.Sockets.Socket" /> or <see cref="T:System.Net.Sockets.TcpClient" /> method. If you want to specify the amount of time that the <see cref="T:System.Net.Sockets.Socket" /> will attempt to transmit unsent data after closing, create a <see cref="T:System.Net.Sockets.LingerOption" /> with the <paramref name="enable" /> parameter set to true, and the <paramref name="seconds" /> parameter set to the desired amount of time. The <paramref name="seconds" /> parameter is used to indicate how long you would like the <see cref="T:System.Net.Sockets.Socket" /> to remain connected before timing out. If you do not want the <see cref="T:System.Net.Sockets.Socket" /> to stay connected for any length of time after closing, create a <see cref="T:System.Net.Sockets.LingerOption" /> instance with the <paramref name="enable" /> parameter set to true and the <paramref name="seconds" /> parameter set to zero. In this case, the <see cref="T:System.Net.Sockets.Socket" /> will close immediately and any unsent data will be lost. Once created, pass the <see cref="T:System.Net.Sockets.LingerOption" /> to the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" /> method. If you are sending and receiving data with a <see cref="T:System.Net.Sockets.TcpClient" />, then set the <see cref="T:System.Net.Sockets.LingerOption" /> instance in the <see cref="P:System.Net.Sockets.TcpClient.LingerState" /> property.</para>
<para>The IP stack computes the default IP protocol time-out period to use based on the round trip time of the connection. In most cases, the time-out computed by the stack is more relevant than one defined by an application. This is the default behavior for a <see cref="T:System.Net.Sockets.Socket" /> when the <see cref="P:System.Net.Sockets.Socket.LingerState" /> property is not set and for a <see cref="T:System.Net.Sockets.TcpClient" /> when the <see cref="P:System.Net.Sockets.TcpClient.LingerState" /> property is not set.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies whether a <see cref="T:System.Net.Sockets.Socket" /> will remain connected after a call to the <see cref="M:System.Net.Sockets.Socket.Close" /> or <see cref="M:System.Net.Sockets.TcpClient.Close" /> methods and the length of time it will remain connected, if data remains to be sent.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(bool enable, int32 seconds)" />
<MemberSignature Language="C#" Value="public LingerOption (bool enable, int seconds);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool enable, int32 seconds) 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="enable" Type="System.Boolean" />
<Parameter Name="seconds" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>There may still be data available in the outgoing network buffer after you close the <see cref="T:System.Net.Sockets.Socket" />. Use the <paramref name="enable" /> parameter to specify whether you would like the <see cref="T:System.Net.Sockets.Socket" /> to continue transmitting unsent data after the close method is called. Use the <paramref name="seconds" /> parameter to indicate how long you would like the <see cref="T:System.Net.Sockets.Socket" /> to attempt transferring unsent data before timing out. If you specify true for the <paramref name="enable" /> parameter and 0 for the <paramref name="seconds" /> parameter, the <see cref="T:System.Net.Sockets.Socket" /> will attempt to send data until there is no data left in the outgoing network buffer. If you specify false for the <paramref name="enable" /> parameter, the <see cref="T:System.Net.Sockets.Socket" /> will close immediately and any unsent data will be lost.</para>
<para>The following table describes the behavior on the <see cref="M:System.Net.Sockets.Socket.Close" /> and <see cref="M:System.Net.Sockets.TcpClient.Close" /> methods based on the possible values of the <paramref name="enable" /> and <paramref name="seconds" /> parameters when an T:System.Net.Sockets.LingerOption instance is created and set in the <see cref="P:System.Net.Sockets.Socket.LingerState" /> or <see cref="P:System.Net.Sockets.TcpClient.LingerState" /> property.</para>
<list type="table">
<listheader>
<item>
<term>
<para>
<paramref name="enable" />
</para>
</term>
<description>
<para>
<paramref name="seconds" />
</para>
</description>
<description>
<para>Behavior</para>
</description>
</item>
</listheader>
<item>
<term>
<para>false (disabled), the default value </para>
</term>
<description>
<para>The time-out is not applicable, (default).</para>
</description>
<description>
<para>Attempts to send pending data for a connection-oriented socket (TCP, for example) until the default IP protocol time-out expires. </para>
</description>
</item>
<item>
<term>
<para>true (enabled)</para>
</term>
<description>
<para>A nonzero time-out</para>
</description>
<description>
<para>Attempts to send pending data until the specified time-out expires, and if the attempt fails, then Winsock resets the connection. </para>
</description>
</item>
<item>
<term>
<para>true (enabled)</para>
</term>
<description>
<para>A zero timeout.</para>
</description>
<description>
<para>Discards any pending data. For connection-oriented socket (TCP, for example), Winsock resets the connection. </para>
</description>
</item>
</list>
<para>The IP stack computes the default IP protocol time-out period to use based on the round trip time of the connection. In most cases, the time-out computed by the stack is more relevant than one defined by an application. This is the default behavior for a socket when the <see cref="P:System.Net.Sockets.Socket.LingerState" /> property is not set.</para>
<para>When the <see cref="P:System.Net.Sockets.LingerOption.LingerTime" /> property stored in the <see cref="P:System.Net.Sockets.Socket.LingerState" /> property is set greater than the default IP protocol time-out, the default IP protocol time-out will still apply and override.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.LingerOption" /> class.</para>
</summary>
<param name="enable">
<attribution license="cc4" from="Microsoft" modified="false" />true to remain connected after the <see cref="M:System.Net.Sockets.Socket.Close" /> method is called; otherwise, false. </param>
<param name="seconds">
<attribution license="cc4" from="Microsoft" modified="false" />The number of seconds to remain connected after the <see cref="M:System.Net.Sockets.Socket.Close" /> method is called. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Enabled">
<MemberSignature Language="ILASM" Value=".property bool Enabled { public hidebysig specialname instance bool get_Enabled() public hidebysig specialname instance void set_Enabled(bool value) }" />
<MemberSignature Language="C#" Value="public bool Enabled { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Enabled" />
<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.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>
<para>
<see langword="true " />to enable lingering
after the <see cref="M:System.Net.Sockets.Socket.Close" qualify="true" />
method is called; otherwise
<see langword="false" />.</para>
</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can use the <see cref="P:System.Net.Sockets.LingerOption.Enabled" /> property to determine whether the <see cref="T:System.Net.Sockets.Socket" /> will linger after closing. Change this value to true or false and pass the altered <see cref="T:System.Net.Sockets.LingerOption" /> to the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" /> method or set the <see cref="P:System.Net.Sockets.TcpClient.LingerState" /> or <see cref="P:System.Net.Sockets.Socket.LingerState" /> property.to disable or enable lingering.</para>
<para>The following table describes the behavior for the possible values of the <see cref="P:System.Net.Sockets.LingerOption.Enabled" /> property and the <see cref="P:System.Net.Sockets.LingerOption.LingerTime" /> property stored in the <see cref="P:System.Net.Sockets.Socket.LingerState" /> property.</para>
<list type="table">
<listheader>
<item>
<term>
<para>
<paramref name="enable" />
</para>
</term>
<description>
<para>
<paramref name="seconds" />
</para>
</description>
<description>
<para>Behavior</para>
</description>
</item>
</listheader>
<item>
<term>
<para>false (disabled), the default value </para>
</term>
<description>
<para>The time-out is not applicable, (default).</para>
</description>
<description>
<para>Attempts to send pending data for a connection-oriented socket (TCP, for example) until the default IP protocol time-out expires. </para>
</description>
</item>
<item>
<term>
<para>true (enabled)</para>
</term>
<description>
<para>A nonzero time-out</para>
</description>
<description>
<para>Attempts to send pending data until the specified time-out expires, and if the attempt fails, then Winsock resets the connection. </para>
</description>
</item>
<item>
<term>
<para>true (enabled)</para>
</term>
<description>
<para>A zero timeout.</para>
</description>
<description>
<para>Discards any pending data. For connection-oriented socket (TCP, for example), Winsock resets the connection. </para>
</description>
</item>
</list>
<para>The IP stack computes the default IP protocol time-out period to use based on the round trip time of the connection. In most cases, the time-out computed by the stack is more relevant than one defined by an application. This is the default behavior for a socket when the <see cref="P:System.Net.Sockets.Socket.LingerState" /> property is not set.</para>
<para>When the <see cref="P:System.Net.Sockets.LingerOption.LingerTime" /> property stored in the <see cref="P:System.Net.Sockets.Socket.LingerState" /> property is set greater than the default IP protocol time-out, the default IP protocol time-out will still apply and override.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value that indicates whether to linger after the <see cref="T:System.Net.Sockets.Socket" /> is closed.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="LingerTime">
<MemberSignature Language="ILASM" Value=".property int32 LingerTime { public hidebysig specialname instance int32 get_LingerTime() public hidebysig specialname instance void set_LingerTime(int32 value) }" />
<MemberSignature Language="C#" Value="public int LingerTime { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 LingerTime" />
<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" qualify="true" /> that contains the amount of time, in seconds, to remain connected after
calling the <see cref="M:System.Net.Sockets.Socket.Close" qualify="true" />
method.</para>
</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this value if you want to determine how long a closed <see cref="T:System.Net.Sockets.Socket" /> will attempt to transfer unsent data before timing out. You can also set this value to the desired time-out period, in seconds. </para>
<para>If the <see cref="P:System.Net.Sockets.LingerOption.Enabled" /> property is true, and you set <see cref="P:System.Net.Sockets.LingerOption.LingerTime" /> to 0, the <see cref="T:System.Net.Sockets.Socket" /> discards any pending data to send in the outgoing network buffer. If you change this value, you must pass the altered <see cref="T:System.Net.Sockets.LingerOption" /> instance to the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" /> method or set the <see cref="P:System.Net.Sockets.TcpClient.LingerState" /> or <see cref="P:System.Net.Sockets.Socket.LingerState" /> property.</para>
<para>The following table describes the behavior for the possible values of the <see cref="P:System.Net.Sockets.LingerOption.Enabled" /> property and the <see cref="P:System.Net.Sockets.LingerOption.LingerTime" /> property stored in the <see cref="P:System.Net.Sockets.Socket.LingerState" /> property.</para>
<list type="table">
<listheader>
<item>
<term>
<para>
<paramref name="enable" />
</para>
</term>
<description>
<para>
<paramref name="seconds" />
</para>
</description>
<description>
<para>Behavior</para>
</description>
</item>
</listheader>
<item>
<term>
<para>false (disabled), the default value </para>
</term>
<description>
<para>The time-out is not applicable, (default).</para>
</description>
<description>
<para>Attempts to send pending data for a connection-oriented socket (TCP, for example) until the default IP protocol time-out expires. </para>
</description>
</item>
<item>
<term>
<para>true (enabled)</para>
</term>
<description>
<para>A nonzero time-out</para>
</description>
<description>
<para>Attempts to send pending data until the specified time-out expires, and if the attempt fails, then Winsock resets the connection. </para>
</description>
</item>
<item>
<term>
<para>true (enabled)</para>
</term>
<description>
<para>A zero timeout.</para>
</description>
<description>
<para>Discards any pending data. For connection-oriented socket (TCP, for example), Winsock resets the connection. </para>
</description>
</item>
</list>
<para>The IP stack computes the default IP protocol time-out period to use based on the round trip time of the connection. In most cases, the time-out computed by the stack is more relevant than one defined by an application. This is the default behavior for a socket when the <see cref="P:System.Net.Sockets.Socket.LingerState" /> property is not set.</para>
<para>When the <see cref="P:System.Net.Sockets.LingerOption.LingerTime" /> property stored in the <see cref="P:System.Net.Sockets.Socket.LingerState" /> property is set greater than the default IP protocol time-out, the default IP protocol time-out will still apply and override.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the amount of time to remain connected after calling the <see cref="M:System.Net.Sockets.Socket.Close" /> method if data remains to be sent.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>

245
mcs/class/System/Documentation/en/System.Net.Sockets/MulticastOption.xml Normal file
View File

@@ -0,0 +1,245 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="MulticastOption" FullName="System.Net.Sockets.MulticastOption" FullNameSP="System_Net_Sockets_MulticastOption" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public MulticastOption extends System.Object" />
<TypeSignature Language="C#" Value="public class MulticastOption" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MulticastOption extends System.Object" />
<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.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use a <see cref="T:System.Net.Sockets.MulticastOption" /> to store the <see cref="T:System.Net.IPAddress" /> of a multicast group you want to join or drop. Use the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" /> method with the following parameters to join a multicast group.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Parameter </para>
</term>
<description>
<para>Value </para>
</description>
</item>
</listheader>
<item>
<term>
<para>socketOptionLevel </para>
</term>
<description>
<para>
<see cref="F:System.Net.Sockets.SocketOptionLevel.Udp" /> </para>
</description>
</item>
<item>
<term>
<para>socketOptionName </para>
</term>
<description>
<para>
<see cref="F:System.Net.Sockets.SocketOptionName.AddMembership" /> </para>
</description>
</item>
<item>
<term>
<para>object </para>
</term>
<description>
<para>
<see cref="T:System.Net.Sockets.MulticastOption" /> </para>
</description>
</item>
</list>
<para>Use <see cref="F:System.Net.Sockets.SocketOptionName.DropMembership" /> to drop a multicast group.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Contains <see cref="T:System.Net.IPAddress" /> values used to join and drop multicast groups.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.Net.IPAddress group)" />
<MemberSignature Language="C#" Value="public MulticastOption (System.Net.IPAddress group);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Net.IPAddress group) 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="group" Type="System.Net.IPAddress" />
</Parameters>
<Docs>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="group " />is <see langword="null" />.</para>
</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For machines with multiple network cards, do not use this constructor. Use the constructor that takes a group and a local IP address.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new version of the <see cref="T:System.Net.Sockets.MulticastOption" /> class for the specified IP multicast group.</para>
</summary>
<param name="group">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Net.IPAddress" /> of the multicast group. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MulticastOption (System.Net.IPAddress group, int interfaceIndex);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Net.IPAddress group, int32 interfaceIndex) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="group" Type="System.Net.IPAddress" />
<Parameter Name="interfaceIndex" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.MulticastOption" /> class with the specified IP multicast group address and interface index.</para>
</summary>
<param name="group">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Net.IPAddress" /> of the multicast group.</param>
<param name="interfaceIndex">
<attribution license="cc4" from="Microsoft" modified="false" />The index of the interface that is used to send and receive multicast packets.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.Net.IPAddress group, class System.Net.IPAddress mcint)" />
<MemberSignature Language="C#" Value="public MulticastOption (System.Net.IPAddress group, System.Net.IPAddress mcint);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Net.IPAddress group, class System.Net.IPAddress mcint) 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="group" Type="System.Net.IPAddress" />
<Parameter Name="mcint" Type="System.Net.IPAddress" />
</Parameters>
<Docs>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="group " /> or <paramref name="mcint" /> is <see langword="null" />.</para>
</exception>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For machines with multiple network cards, you must use this constructor to create <see cref="T:System.Net.Sockets.MulticastOption" /> instances.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.MulticastOption" /> class with the specified IP multicast group address and local IP address associated with a network interface.</para>
</summary>
<param name="group">
<attribution license="cc4" from="Microsoft" modified="false" />The group <see cref="T:System.Net.IPAddress" />. </param>
<param name="mcint">
<attribution license="cc4" from="Microsoft" modified="false" />The local <see cref="T:System.Net.IPAddress" />. </param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Group">
<MemberSignature Language="ILASM" Value=".property class System.Net.IPAddress Group { public hidebysig specialname instance class System.Net.IPAddress get_Group() public hidebysig specialname instance void set_Group(class System.Net.IPAddress value) }" />
<MemberSignature Language="C#" Value="public System.Net.IPAddress Group { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IPAddress Group" />
<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> An instance of <see cref="T:System.Net.IPAddress" qualify="true" />
containing the IP address of a multicast
group.</para>
</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Valid IP addresses for multicast packets are in the range 224.0.0.0 to 239.255.255.255.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the IP address of a multicast group.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="InterfaceIndex">
<MemberSignature Language="C#" Value="public int InterfaceIndex { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 InterfaceIndex" />
<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>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the index of the interface that is used to send and receive multicast packets. </para>
</summary>
</Docs>
</Member>
<Member MemberName="LocalAddress">
<MemberSignature Language="ILASM" Value=".property class System.Net.IPAddress LocalAddress { public hidebysig specialname instance class System.Net.IPAddress get_LocalAddress() public hidebysig specialname instance void set_LocalAddress(class System.Net.IPAddress value) }" />
<MemberSignature Language="C#" Value="public System.Net.IPAddress LocalAddress { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.IPAddress LocalAddress" />
<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> An instance of <see cref="T:System.Net.IPAddress" qualify="true" /> containing the local IP
address.</para>
</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Net.Sockets.MulticastOption.LocalAddress" /> property contains the IP address of the interface associated with the multicast group membership. If <see cref="P:System.Net.Sockets.MulticastOption.LocalAddress" /> is set to <see cref="F:System.Net.IPAddress.Any" />, the default interface is used.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the local address associated with a multicast group.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>

1152
mcs/class/System/Documentation/en/System.Net.Sockets/NetworkStream.xml Normal file
View File

File diff suppressed because it is too large Load Diff

680
mcs/class/System/Documentation/en/System.Net.Sockets/ProtocolFamily.xml Normal file
View File

File diff suppressed because it is too large Load Diff

559
mcs/class/System/Documentation/en/System.Net.Sockets/ProtocolType.xml Normal file
View File

File diff suppressed because it is too large Load Diff

100
mcs/class/System/Documentation/en/System.Net.Sockets/SelectMode.xml Normal file
View File

@@ -0,0 +1,100 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SelectMode" FullName="System.Net.Sockets.SelectMode" FullNameSP="System_Net_Sockets_SelectMode" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public sealed serializable SelectMode extends System.Enum" />
<TypeSignature Language="C#" Value="public enum SelectMode" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SelectMode extends System.Enum" />
<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>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Net.Sockets.SelectMode" /> enumeration defines the polling modes that can be passed to the <see cref="M:System.Net.Sockets.Socket.Poll(System.Int32,System.Net.Sockets.SelectMode)" /> method. Use the <see cref="F:System.Net.Sockets.SelectMode.SelectRead" /> value to determine if a listening <see cref="T:System.Net.Sockets.Socket" /> has incoming connection requests. Use the <see cref="F:System.Net.Sockets.SelectMode.SelectWrite" /> value to determine if a <see cref="T:System.Net.Sockets.Socket" /> is writeable. Use the <see cref="F:System.Net.Sockets.SelectMode.SelectError" /> value to determine if there is an error condition present on the <see cref="T:System.Net.Sockets.Socket" />. For explanations of writeability, readability, and the presence of error conditions, see the <see cref="M:System.Net.Sockets.Socket.Poll(System.Int32,System.Net.Sockets.SelectMode)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines the polling modes for the <see cref="M:System.Net.Sockets.Socket.Poll(System.Int32,System.Net.Sockets.SelectMode)" /> method.</para>
</summary>
</Docs>
<Members>
<Member MemberName="SelectError">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SelectMode SelectError = 2" />
<MemberSignature Language="C#" Value="SelectError" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SelectMode SelectError = int32(2)" />
<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.Net.Sockets.SelectMode</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>SelectError</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Error status mode.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SelectRead">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SelectMode SelectRead = 0" />
<MemberSignature Language="C#" Value="SelectRead" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SelectMode SelectRead = int32(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.Net.Sockets.SelectMode</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>SelectRead</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Read status mode.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="SelectWrite">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SelectMode SelectWrite = 1" />
<MemberSignature Language="C#" Value="SelectWrite" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SelectMode SelectWrite = int32(1)" />
<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.Net.Sockets.SelectMode</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>SelectWrite</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Write status mode.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>

320
mcs/class/System/Documentation/en/System.Net.Sockets/SendPacketsElement.xml Normal file
View File

@@ -0,0 +1,320 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SendPacketsElement" FullName="System.Net.Sockets.SendPacketsElement">
<TypeSignature Language="C#" Value="public class SendPacketsElement" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SendPacketsElement 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>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Net.Sockets.SendPacketsElement" /> class is used to enhance the <see cref="T:System.Net.Sockets.Socket" /> class for use by server applications that use asynchronous network I/O to achieve the highest performance. The <see cref="T:System.Net.Sockets.SendPacketsElement" /> class is used with the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.SendPacketsElements" /> property to get or set a data buffer or file to be sent using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents an element in a <see cref="T:System.Net.Sockets.SendPacketsElement" /> array.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SendPacketsElement (byte[] buffer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] buffer) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Net.Sockets.SendPacketsElement.#ctor(System.Byte[])" /> constructor initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class with a byte array of data. The <see cref="T:System.Net.Sockets.SendPacketsElement" /> class is used with the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.SendPacketsElements" /> property to get or set a data buffer or file to be sent using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class using the specified buffer.</para>
</summary>
<param name="buffer">
<attribution license="cc4" from="Microsoft" modified="false" />A byte array of data to send using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SendPacketsElement (string filepath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filepath) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="filepath" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Net.Sockets.SendPacketsElement.#ctor(System.String)" /> constructor initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class with a filename of a file. The <see cref="T:System.Net.Sockets.SendPacketsElement" /> class is used with the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.SendPacketsElements" /> property to get or set a data buffer or file to be sent using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</para>
<para>Universal Naming Convention (UNC) paths are supported by the <paramref name="filepath" /> parameter. If the file is in the current working directory, no path information needs to be specified.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class using the specified file.</para>
</summary>
<param name="filepath">
<attribution license="cc4" from="Microsoft" modified="false" />The filename of the file to be transmitted using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SendPacketsElement (byte[] buffer, int offset, int count);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] buffer, int32 offset, int32 count) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Net.Sockets.SendPacketsElement.#ctor(System.Byte[],System.Int32,System.Int32)" /> constructor initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class with a byte array of data. The <see cref="T:System.Net.Sockets.SendPacketsElement" /> class is used with the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.SendPacketsElements" /> property to get or set a data buffer or file to be sent using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class using the specified buffer, buffer offset, and count.</para>
</summary>
<param name="buffer">
<attribution license="cc4" from="Microsoft" modified="false" />A byte array of data to send using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</param>
<param name="offset">
<attribution license="cc4" from="Microsoft" modified="false" />The offset, in bytes, from the beginning of the <paramref name="buffer" /> to the location in the <paramref name="buffer" /> to start sending the data specified in the <paramref name="buffer" /> parameter.</param>
<param name="count">
<attribution license="cc4" from="Microsoft" modified="false" />The number of bytes to send starting from the <paramref name="offset" /> parameter. If <paramref name="count" /> is zero, no bytes are sent.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SendPacketsElement (string filepath, int offset, int count);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filepath, int32 offset, int32 count) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="filepath" Type="System.String" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Net.Sockets.SendPacketsElement.#ctor(System.String,System.Int32,System.Int32)" /> constructor initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class with a filename of a file. The <see cref="T:System.Net.Sockets.SendPacketsElement" /> class is used with the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.SendPacketsElements" /> property to get or set a data buffer or file to be sent using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</para>
<para>Universal Naming Convention (UNC) paths are supported by the <paramref name="filepath" /> parameter. If the file is in the current working directory, no path information needs to be specified.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class using the specified filename path, offset, and count.</para>
</summary>
<param name="filepath">
<attribution license="cc4" from="Microsoft" modified="false" />The filename of the file to be transmitted using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</param>
<param name="offset">
<attribution license="cc4" from="Microsoft" modified="false" />The offset, in bytes, from the beginning of the file to the location in the file to start sending the file specified in the <paramref name="filepath" /> parameter.</param>
<param name="count">
<attribution license="cc4" from="Microsoft" modified="false" />The number of bytes to send starting from the <paramref name="offset" /> parameter. If <paramref name="count" /> is zero, the entire file is sent. </param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SendPacketsElement (byte[] buffer, int offset, int count, bool endOfPacket);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] buffer, int32 offset, int32 count, bool endOfPacket) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
<Parameter Name="endOfPacket" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Net.Sockets.SendPacketsElement.#ctor(System.Byte[],System.Int32,System.Int32,System.Boolean)" /> constructor initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class with a byte array of data. The <see cref="T:System.Net.Sockets.SendPacketsElement" /> class is used with the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.SendPacketsElements" /> property to get or set a data buffer or file to be sent using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class using the specified buffer, buffer offset, and count with an option to combine this element with the next element in a single send request from the sockets layer to the transport. </para>
</summary>
<param name="buffer">
<attribution license="cc4" from="Microsoft" modified="false" />A byte array of data to send using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</param>
<param name="offset">
<attribution license="cc4" from="Microsoft" modified="false" />The offset, in bytes, from the beginning of the <paramref name="buffer" /> to the location in the <paramref name="buffer" /> to start sending the data specified in the <paramref name="buffer" /> parameter.</param>
<param name="count">
<attribution license="cc4" from="Microsoft" modified="false" />The number bytes to send starting from the <paramref name="offset" /> parameter. If <paramref name="count" /> is zero, no bytes are sent.</param>
<param name="endOfPacket">
<attribution license="cc4" from="Microsoft" modified="false" />A Boolean value that specifies that this element should not be combined with the next element in a single send request from the sockets layer to the transport. This flag is used for granular control of the content of each message on a datagram or message-oriented socket. </param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SendPacketsElement (string filepath, int offset, int count, bool endOfPacket);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filepath, int32 offset, int32 count, bool endOfPacket) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="filepath" Type="System.String" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
<Parameter Name="endOfPacket" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Net.Sockets.SendPacketsElement.#ctor(System.String,System.Int32,System.Int32,System.Boolean)" /> constructor initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class with a filename of a file. The <see cref="T:System.Net.Sockets.SendPacketsElement" /> class is used with the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.SendPacketsElements" /> property to get or set a data buffer or file to be sent using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</para>
<para>Universal Naming Convention (UNC) paths are supported by the <paramref name="filepath" /> parameter. If the file is in the current working directory, no path information needs to be specified.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class using the specified filename path, buffer offset, and count with an option to combine this element with the next element in a single send request from the sockets layer to the transport. </para>
</summary>
<param name="filepath">
<attribution license="cc4" from="Microsoft" modified="false" />The filename of the file to be transmitted using the <see cref="M:System.Net.Sockets.Socket.SendPacketsAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.</param>
<param name="offset">
<attribution license="cc4" from="Microsoft" modified="false" />The offset, in bytes, from the beginning of the file to the location in the file to start sending the file specified in the <paramref name="filepath" /> parameter.</param>
<param name="count">
<attribution license="cc4" from="Microsoft" modified="false" />The number of bytes to send starting from the <paramref name="offset" /> parameter. If <paramref name="count" /> is zero, the entire file is sent.</param>
<param name="endOfPacket">
<attribution license="cc4" from="Microsoft" modified="false" />A Boolean value that specifies that this element should not be combined with the next element in a single send request from the sockets layer to the transport. This flag is used for granular control of the content of each message on a datagram or message-oriented socket.</param>
</Docs>
</Member>
<Member MemberName="Buffer">
<MemberSignature Language="C#" Value="public byte[] Buffer { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8[] Buffer" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The default value for the <see cref="P:System.Net.Sockets.SendPacketsElement.Buffer" /> property is a zero-length array if the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class was not initialized with a <paramref name="buffer" /> parameter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the buffer to be sent if the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class was initialized with a <paramref name="buffer" /> parameter.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Count">
<MemberSignature Language="C#" Value="public int Count { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
<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>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The default value for the <see cref="P:System.Net.Sockets.SendPacketsElement.Count" /> property is zero if the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class was not initialized with a <paramref name="count" /> parameter.</para>
<para>If <see cref="P:System.Net.Sockets.SendPacketsElement.Count" /> is zero for a file, the entire file is sent. If <see cref="P:System.Net.Sockets.SendPacketsElement.Count" /> is zero for a buffer, no bytes are sent.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the count of bytes to be sent. </para>
</summary>
</Docs>
</Member>
<Member MemberName="EndOfPacket">
<MemberSignature Language="C#" Value="public bool EndOfPacket { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool EndOfPacket" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The default value for the <see cref="P:System.Net.Sockets.SendPacketsElement.EndOfPacket" /> property is false if the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class was not initialized with an <paramref name="endOfPacket" /> parameter set to true.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a Boolean value that indicates if this element should not be combined with the next element in a single send request from the sockets layer to the transport.</para>
</summary>
</Docs>
</Member>
<Member MemberName="FilePath">
<MemberSignature Language="C#" Value="public string FilePath { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FilePath" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Universal Naming Convention (UNC) paths are supported by the <see cref="P:System.Net.Sockets.SendPacketsElement.FilePath" /> property. If the file is in the current working directory, no path information needs to be specified.</para>
<para>The default value for the <see cref="P:System.Net.Sockets.SendPacketsElement.FilePath" /> property is an empty string if the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class was not initialized with a <paramref name="filepath" /> parameter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the filename of the file to send if the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class was initialized with a <paramref name="filepath" /> parameter.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Offset">
<MemberSignature Language="C#" Value="public int Offset { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Offset" />
<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>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The default value for the <see cref="P:System.Net.Sockets.SendPacketsElement.Offset" /> property is zero if the <see cref="T:System.Net.Sockets.SendPacketsElement" /> class was not initialized with an <paramref name="offset" /> parameter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the offset, in bytes, from the beginning of the data buffer or file to the location in the buffer or file to start sending the data. </para>
</summary>
</Docs>
</Member>
</Members>
</Type>

1
mcs/class/System/Documentation/en/System.Net.Sockets/Socket.xml.REMOVED.git-id Normal file
View File

@@ -0,0 +1 @@
f9af69eaf40fcf83406b50487a1b7b6902de49b4

693
mcs/class/System/Documentation/en/System.Net.Sockets/SocketAsyncEventArgs.xml Normal file
View File

File diff suppressed because it is too large Load Diff

206
mcs/class/System/Documentation/en/System.Net.Sockets/SocketAsyncOperation.xml Normal file
View File

@@ -0,0 +1,206 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SocketAsyncOperation" FullName="System.Net.Sockets.SocketAsyncOperation">
<TypeSignature Language="C#" Value="public enum SocketAsyncOperation" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SocketAsyncOperation extends System.Enum" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This type describes the asynchronous socket operation that was most recently completed using a <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object. The value of the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.LastOperation" /> property is set to <see cref="F:System.Net.Sockets.SocketAsyncOperation.None" /> until the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> instance is used to begin an asynchronous socket operation. The property will then be set to the type of asynchronous operation being performed. This type more easily facilitates using a single completion callback delegate for multiple kinds of asynchronous socket operations. This type is intended for use in the SocketAsyncCallback completion routine. </para>
<para>The <see cref="T:System.Net.Sockets.SocketAsyncOperation" /> type is used by the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.LastOperation" /> property.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The type of asynchronous socket operation most recently performed with this context object.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Accept">
<MemberSignature Language="C#" Value="Accept" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketAsyncOperation Accept = int32(1)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketAsyncOperation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A socket Accept operation. </para>
</summary>
</Docs>
</Member>
<Member MemberName="Connect">
<MemberSignature Language="C#" Value="Connect" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketAsyncOperation Connect = int32(2)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketAsyncOperation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A socket Connect operation.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Disconnect">
<MemberSignature Language="C#" Value="Disconnect" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketAsyncOperation Disconnect = int32(3)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketAsyncOperation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A socket Disconnect operation.</para>
</summary>
</Docs>
</Member>
<Member MemberName="None">
<MemberSignature Language="C#" Value="None" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketAsyncOperation None = int32(0)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketAsyncOperation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>None of the socket operations.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Receive">
<MemberSignature Language="C#" Value="Receive" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketAsyncOperation Receive = int32(4)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketAsyncOperation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A socket Receive operation.</para>
</summary>
</Docs>
</Member>
<Member MemberName="ReceiveFrom">
<MemberSignature Language="C#" Value="ReceiveFrom" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketAsyncOperation ReceiveFrom = int32(5)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketAsyncOperation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A socket ReceiveFrom operation.</para>
</summary>
</Docs>
</Member>
<Member MemberName="ReceiveMessageFrom">
<MemberSignature Language="C#" Value="ReceiveMessageFrom" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketAsyncOperation ReceiveMessageFrom = int32(6)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketAsyncOperation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A socket ReceiveMessageFrom operation.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Send">
<MemberSignature Language="C#" Value="Send" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketAsyncOperation Send = int32(7)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketAsyncOperation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A socket Send operation.</para>
</summary>
</Docs>
</Member>
<Member MemberName="SendPackets">
<MemberSignature Language="C#" Value="SendPackets" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketAsyncOperation SendPackets = int32(8)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketAsyncOperation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A socket SendPackets operation.</para>
</summary>
</Docs>
</Member>
<Member MemberName="SendTo">
<MemberSignature Language="C#" Value="SendTo" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketAsyncOperation SendTo = int32(9)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketAsyncOperation</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A socket SendTo operation.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

919
mcs/class/System/Documentation/en/System.Net.Sockets/SocketError.xml Normal file
View File

File diff suppressed because it is too large Load Diff

176
mcs/class/System/Documentation/en/System.Net.Sockets/SocketException.xml Normal file
View File

@@ -0,0 +1,176 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SocketException" FullName="System.Net.Sockets.SocketException" FullNameSP="System_Net_Sockets_SocketException" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public serializable SocketException extends System.SystemException" />
<TypeSignature Language="C#" Value="public class SocketException : System.ComponentModel.Win32Exception" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit SocketException extends System.ComponentModel.Win32Exception" />
<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.ComponentModel.Win32Exception</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Net.Sockets.SocketException" /> is thrown by the <see cref="T:System.Net.Sockets.Socket" /> and <see cref="T:System.Net.Dns" /> classes when an error occurs with the network.</para>
<para>The default constructor for the <see cref="M:System.Net.Sockets.SocketException.#ctor" /> class sets the <see cref="P:System.Net.Sockets.SocketException.ErrorCode" /> property to the last operating system socket error that occurred. For more information about socket error codes, see the Windows Sockets version 2 API error code documentation on MSDN.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The exception that is thrown when a socket error occurs.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor()" />
<MemberSignature Language="C#" Value="public SocketException ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() 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 />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Net.Sockets.SocketException.#ctor" /> constructor sets the <see cref="P:System.Net.Sockets.SocketException.ErrorCode" /> property to the last operating system socket error that occurred. For more information about socket error codes, see the Windows Sockets version 2 API error code documentation (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winsock/winsock/windows_sockets_error_codes_2.asp).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.SocketException" /> class with the last operating system error code.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SocketException (int error);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 error) 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>
<Parameters>
<Parameter Name="error" Type="System.Int32" />
</Parameters>
<Docs>
<param name="error">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Net.Sockets.SocketException.#ctor" /> constructor sets the <see cref="P:System.Net.Sockets.SocketException.ErrorCode" /> property to <paramref name="errorCode" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.SocketException" /> class with the specified error code.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SocketException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Runtime.Serialization.SerializationInfo info, valuetype System.Runtime.Serialization.StreamingContext context) 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>
<Parameters>
<Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters>
<Docs>
<param name="info">To be added.</param>
<param name="context">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor implements the <see cref="T:System.Runtime.Serialization.ISerializable" /> interface for the <see cref="T:System.Net.Sockets.SocketException" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Net.Sockets.SocketException" /> class from the specified instances of the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> and <see cref="T:System.Runtime.Serialization.StreamingContext" /> classes.</para>
</summary>
</Docs>
</Member>
<Member MemberName="ErrorCode">
<MemberSignature Language="C#" Value="public override int ErrorCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 ErrorCode" />
<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>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Net.Sockets.SocketException.ErrorCode" /> property contains the error code that is associated with the error that caused the exception.</para>
<para>The default constructor for <see cref="T:System.Net.Sockets.SocketException" /> sets the <see cref="P:System.Net.Sockets.SocketException.ErrorCode" /> property to the last operating system error that occurred. For more information about socket error codes, see the Windows Sockets version 2 API error code documentation in MSDN.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the error code that is associated with this exception.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Message">
<MemberSignature Language="C#" Value="public override string Message { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Message" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the error message that is associated with this exception.</para>
</summary>
</Docs>
</Member>
<Member MemberName="SocketErrorCode">
<MemberSignature Language="C#" Value="public System.Net.Sockets.SocketError SocketErrorCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.Sockets.SocketError SocketErrorCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketError</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Net.Sockets.SocketException.SocketErrorCode" /> property contains the error code that is associated with the error that caused the exception.</para>
<para>The default constructor for <see cref="T:System.Net.Sockets.SocketException" /> sets the <see cref="P:System.Net.Sockets.SocketException.ErrorCode" /> property to the last operating system error that occurred. For more information about socket error codes, see the Windows Sockets version 2 API error code documentation in MSDN.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the error code that is associated with this exception.</para>
</summary>
</Docs>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>

285
mcs/class/System/Documentation/en/System.Net.Sockets/SocketFlags.xml Normal file
View File

@@ -0,0 +1,285 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SocketFlags" FullName="System.Net.Sockets.SocketFlags" FullNameSP="System_Net_Sockets_SocketFlags" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public sealed serializable SocketFlags extends System.Enum" />
<TypeSignature Language="C#" Value="public enum SocketFlags" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SocketFlags extends System.Enum" />
<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>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>System.Flags</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>
<para>The following methods use this enumeration:</para>
<list type="bullet">
<item>
<term>
<see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" />
</term>
</item>
<item>
<term>
<see cref="M:System.Net.Sockets.Socket.BeginReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@,System.AsyncCallback,System.Object)" />
</term>
</item>
<item>
<term>
<see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" />
</term>
</item>
<item>
<term>
<see cref="M:System.Net.Sockets.Socket.BeginSendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint,System.AsyncCallback,System.Object)" />
</term>
</item>
<item>
<term>
<see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />
</term>
</item>
<item>
<term>
<see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" />
</term>
</item>
<item>
<term>
<see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />
</term>
</item>
<item>
<term>
<see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" />
</term>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Specifies socket send and receive behaviors.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Broadcast">
<MemberSignature Language="C#" Value="Broadcast" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Broadcast = int32(1024)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates a broadcast packet.</para>
</summary>
</Docs>
</Member>
<Member MemberName="ControlDataTruncated">
<MemberSignature Language="C#" Value="ControlDataTruncated" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags ControlDataTruncated = int32(512)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates that the control data did not fit into an internal 64-KB buffer and was truncated.</para>
</summary>
</Docs>
</Member>
<Member MemberName="DontRoute">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags DontRoute = 0x4" />
<MemberSignature Language="C#" Value="DontRoute" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags DontRoute = int32(4)" />
<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.Net.Sockets.SocketFlags</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>DontRoute</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Send without using routing tables.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="MaxIOVectorLength">
<MemberSignature Language="C#" Value="MaxIOVectorLength" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags MaxIOVectorLength = int32(16)" />
<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.Net.Sockets.SocketFlags</ReturnType>
</ReturnValue>
<MemberValue>MaxIOVectorLength</MemberValue>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a standard value for the number of WSABUF structures that are used to send and receive data. This value is not used or supported on net_v45.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Multicast">
<MemberSignature Language="C#" Value="Multicast" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Multicast = int32(2048)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates a multicast packet.</para>
</summary>
</Docs>
</Member>
<Member MemberName="None">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags None = 0x0" />
<MemberSignature Language="C#" Value="None" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags None = int32(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.Net.Sockets.SocketFlags</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>None</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use no flags for this call.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="OutOfBand">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags OutOfBand = 0x1" />
<MemberSignature Language="C#" Value="OutOfBand" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags OutOfBand = int32(1)" />
<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.Net.Sockets.SocketFlags</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>OutOfBand</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Process out-of-band data.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Partial">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Partial = 0x8000" />
<MemberSignature Language="C#" Value="Partial" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Partial = int32(32768)" />
<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.Net.Sockets.SocketFlags</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>Partial</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Partial send or receive for message.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Peek">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Peek = 0x2" />
<MemberSignature Language="C#" Value="Peek" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Peek = int32(2)" />
<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.Net.Sockets.SocketFlags</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>Peek</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Peek at the incoming message.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Truncated">
<MemberSignature Language="C#" Value="Truncated" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Truncated = int32(256)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The message was too large to fit into the specified buffer and was truncated.</para>
</summary>
</Docs>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>

70
mcs/class/System/Documentation/en/System.Net.Sockets/SocketInformation.xml Normal file
View File

@@ -0,0 +1,70 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SocketInformation" FullName="System.Net.Sockets.SocketInformation">
<TypeSignature Language="C#" Value="public struct SocketInformation" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi serializable sealed beforefieldinit SocketInformation extends System.ValueType" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="M:System.Net.Sockets.Socket.DuplicateAndClose(System.Int32)" /> creates a <see cref="T:System.Net.Sockets.SocketInformation" /> instance for use with the <see cref="M:System.Net.Sockets.Socket.#ctor(System.Net.Sockets.SocketInformation)" /> constructor.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Encapsulates the information that is necessary to duplicate a <see cref="T:System.Net.Sockets.Socket" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Options">
<MemberSignature Language="C#" Value="public System.Net.Sockets.SocketInformationOptions Options { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.Sockets.SocketInformationOptions Options" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketInformationOptions</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Options include <see cref="F:System.Net.Sockets.SocketInformationOptions.Connected" />, <see cref="F:System.Net.Sockets.SocketInformationOptions.Listening" />, <see cref="F:System.Net.Sockets.SocketInformationOptions.NonBlocking" />, and <see cref="F:System.Net.Sockets.SocketInformationOptions.UseOnlyOverlappedIO" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the options for a <see cref="T:System.Net.Sockets.Socket" />.</para>
</summary>
</Docs>
</Member>
<Member MemberName="ProtocolInformation">
<MemberSignature Language="C#" Value="public byte[] ProtocolInformation { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8[] ProtocolInformation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the protocol information for a <see cref="T:System.Net.Sockets.Socket" />.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

99
mcs/class/System/Documentation/en/System.Net.Sockets/SocketInformationOptions.xml Normal file
View File

@@ -0,0 +1,99 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SocketInformationOptions" FullName="System.Net.Sockets.SocketInformationOptions">
<TypeSignature Language="C#" Value="public enum SocketInformationOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SocketInformationOptions extends System.Enum" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>System.Flags</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Describes states for a <see cref="T:System.Net.Sockets.Socket" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Connected">
<MemberSignature Language="C#" Value="Connected" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketInformationOptions Connected = int32(2)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketInformationOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Net.Sockets.Socket" /> is connected.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Listening">
<MemberSignature Language="C#" Value="Listening" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketInformationOptions Listening = int32(4)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketInformationOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Net.Sockets.Socket" /> is listening for new connections.</para>
</summary>
</Docs>
</Member>
<Member MemberName="NonBlocking">
<MemberSignature Language="C#" Value="NonBlocking" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketInformationOptions NonBlocking = int32(1)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketInformationOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Net.Sockets.Socket" /> is nonblocking.</para>
</summary>
</Docs>
</Member>
<Member MemberName="UseOnlyOverlappedIO">
<MemberSignature Language="C#" Value="UseOnlyOverlappedIO" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketInformationOptions UseOnlyOverlappedIO = int32(8)" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketInformationOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Net.Sockets.Socket" /> uses overlapped I/O.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

150
mcs/class/System/Documentation/en/System.Net.Sockets/SocketOptionLevel.xml Normal file
View File

@@ -0,0 +1,150 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="SocketOptionLevel" FullName="System.Net.Sockets.SocketOptionLevel" FullNameSP="System_Net_Sockets_SocketOptionLevel" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public sealed serializable SocketOptionLevel extends System.Enum" />
<TypeSignature Language="C#" Value="public enum SocketOptionLevel" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SocketOptionLevel extends System.Enum" />
<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>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration defines the socket option levels that can be passed to the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" /> and <see cref="M:System.Net.Sockets.Socket.GetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName)" /> methods. <see cref="T:System.Net.Sockets.SocketOptionName" /> enumerated values are grouped by <see cref="T:System.Net.Sockets.SocketOptionLevel" />. </para>
<para>Note   To use <see cref="F:System.Net.Sockets.SocketOptionLevel.IPv6" /> on Windows XP, install Advance Networking Pack for Windows XP.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines socket option levels for the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" /> and <see cref="M:System.Net.Sockets.Socket.GetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName)" /> methods.</para>
</summary>
</Docs>
<Members>
<Member MemberName="IP">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel IP = 0" />
<MemberSignature Language="C#" Value="IP" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel IP = int32(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.Net.Sockets.SocketOptionLevel</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>IP</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Net.Sockets.Socket" /> options apply only to IP sockets.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="IPv6">
<MemberSignature Language="C#" Value="IPv6" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel IPv6 = int32(41)" />
<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.Net.Sockets.SocketOptionLevel</ReturnType>
</ReturnValue>
<MemberValue>IPv6</MemberValue>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Net.Sockets.Socket" /> options apply only to IPv6 sockets.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Socket">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel Socket = 65535" />
<MemberSignature Language="C#" Value="Socket" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel Socket = int32(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.Net.Sockets.SocketOptionLevel</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>Socket</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Net.Sockets.Socket" /> options apply to all sockets.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Tcp">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel Tcp = 6" />
<MemberSignature Language="C#" Value="Tcp" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel Tcp = int32(6)" />
<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.Net.Sockets.SocketOptionLevel</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>Tcp</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Net.Sockets.Socket" /> options apply only to TCP sockets.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Udp">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel Udp = 17" />
<MemberSignature Language="C#" Value="Udp" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel Udp = int32(17)" />
<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.Net.Sockets.SocketOptionLevel</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>Udp</MemberValue>
<Docs>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Net.Sockets.Socket" /> options apply only to UDP sockets.</para>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>

Some files were not shown because too many files have changed in this diff Show More