2006-09-11 Gonzalo Paniagua Javier <gonzalo@ximian.com>
[mono.git] / mcs / class / System / System.Net.Sockets / SocketOptionName.cs
index a9e1bea901524614644b0ec6df1167f2c6b1da07..ce10c14fafe881e78dd99d0eb49c961ecbb9b3c4 100644 (file)
-// SocketOptionName.cs\r
-//\r
-// This code was automatically generated from\r
-// ECMA CLI XML Library Specification.\r
-// Generator: libgen.xsl\r
-// Source file: AllTypes.xml\r
-// URL: http://msdn.microsoft.com/net/ecma/AllTypes.xml\r
-//\r
-// (C) 2001 Ximian, Inc.  http://www.ximian.com\r
-\r
-\r
-namespace System.Net.Sockets {\r
-\r
-\r
-       /// <summary>\r
-       /// <para> Specifies option names for use in the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" qualify="true" /> and <see cref="M:System.Net.Sockets.Socket.GetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName)" qualify="true" /> \r
-       /// methods of the <see cref="T:System.Net.Sockets.Socket" /> class. </para>\r
-       /// </summary>\r
-       /// <remarks>\r
-       /// <para>Socket options determine the behavior of an instance of\r
-       ///       the <see cref="T:System.Net.Sockets.Socket" /> class. Some socket options apply only to specific protocols while others apply to\r
-       ///       all types. Members of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration specify\r
-       ///       which protocol applies to a specific socket option. </para>\r
-       /// </remarks>\r
-       public enum SocketOptionName {\r
-\r
-               /// <summary><para>Record debugging information when available.</para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data \r
-               ///  type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               Debug = 1,\r
-\r
-               /// <summary><para><see cref="M:System.Net.Sockets.Socket.Listen(System.Int32)" qualify="true" /> has been called on the socket.</para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> \r
-               /// data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               AcceptConnection = 2,\r
-\r
-               /// <summary><para> Allow the socket to be bound to an address that is already in use.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data \r
-               ///  type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               ReuseAddress = 4,\r
-\r
-               /// <summary><para> Send keep-alives.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data \r
-               ///  type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               KeepAlive = 8,\r
-\r
-               /// <summary><para> Do not route; send directly to interface addresses.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data \r
-               ///  type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               DontRoute = 16,\r
-\r
-               /// <summary><para> Permit sending broadcast messages on the socket.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data \r
-               ///  type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               Broadcast = 32,\r
-\r
-               /// <summary><para> Bypass hardware when possible.\r
-               ///       </para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               UseLoopback = 64,\r
-\r
-               /// <summary><para> Linger on close if unsent data is present.\r
-               ///  </para><para>The value associated with this option is an instance of \r
-               ///  the <see cref="T:System.Net.Sockets.LingerOption" qualify="true" /> class. </para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               Linger = 128,\r
-\r
-               /// <summary><para> Receive out-of-band data in the normal data stream.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data \r
-               ///  type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               OutOfBandInline = 256,\r
-\r
-               /// <summary><para> Close socket gracefully without lingering.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data \r
-               ///  type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               DontLinger = -129,\r
-\r
-               /// <summary><para> Enable a socket to be bound for exclusive access.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data \r
-               ///  type.</para></summary>\r
-               ExclusiveAddressUse = -5,\r
-\r
-               /// <summary><para> Specifies the total per-socket buffer space reserved for sends. This is\r
-               ///  unrelated to the maximum message size or the size of a TCP window.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               SendBuffer = 4097,\r
-\r
-               /// <summary><para>Specifies the total per-socket buffer space reserved for\r
-               ///  receives. This is unrelated to the maximum message size or the size of a TCP window. </para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               ReceiveBuffer = 4098,\r
-\r
-               /// <summary><para> Send low water mark.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para></summary>\r
-               SendLowWater = 4099,\r
-\r
-               /// <summary><para> Receive low water mark.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para></summary>\r
-               ReceiveLowWater = 4100,\r
-\r
-               /// <summary><para> Specifies the \r
-               ///       maximum time, in milliseconds, the <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> and <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" /> methods will block when attempting to\r
-               ///       send data. If data is not sent within this time, a <see cref="T:System.Net.Sockets.SocketException" /> exception is thrown.\r
-               ///       </para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> member of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               SendTimeout = 4101,\r
-\r
-               /// <summary><para> Specifies the \r
-               ///       maximum time, in milliseconds, the <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> and <see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" /> methods will block when attempting to\r
-               ///       receive data. If data is not received within this time, a <see cref="T:System.Net.Sockets.SocketException" /> exception is thrown.\r
-               ///       </para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               ReceiveTimeout = 4102,\r
-\r
-               /// <summary><para> Get the error status code, then clear the code.\r
-               ///       </para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               Error = 4103,\r
-\r
-               /// <summary><para> Get the socket type, one of the members of \r
-               ///       the <see cref="T:System.Net.Sockets.SocketType" qualify="true" /> enumeration.\r
-               ///       </para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Socket" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               Type = 4104,\r
-\r
-               /// <summary><para> Maximum queue length that can be specified by <see cref="M:System.Net.Sockets.Socket.Listen(System.Int32)" />.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para></summary>\r
-               MaxConnections = 2147483647,\r
-\r
-               /// <summary><para>Specifies IP options to be inserted into outgoing datagrams.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               IPOptions = 1,\r
-\r
-               /// <summary><para> Application is providing the IP header for\r
-               ///  outgoing datagrams.</para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               HeaderIncluded = 2,\r
-\r
-               /// <summary><para>Change the IP header type of service field.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               TypeOfService = 3,\r
-\r
-               /// <summary><para>Set the IP header time-to-live field.</para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               IpTimeToLive = 4,\r
-\r
-               /// <summary><para>Set the interface for outgoing multicast packets.</para><para>The value associated with this option is an instance of the <see cref="!:System.Net.Sockets.IPAddress" qualify="true" /> \r
-               /// class. </para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               MulticastInterface = 9,\r
-\r
-               /// <summary><para> IP multicast time to live.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Int32" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               MulticastTimeToLive = 10,\r
-\r
-               /// <summary><para>IP multicast loopback.</para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               MulticastLoopback = 11,\r
-\r
-               /// <summary><para> Add an IP group membership.\r
-               ///  </para><para>The value associated with this option is an instance of the <see cref="T:System.Net.Sockets.MulticastOption" qualify="true" /> class. </para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               AddMembership = 12,\r
-\r
-               /// <summary><para> Drop an IP group membership.\r
-               ///  </para><para>The value associated with this option is an instance of the <see cref="T:System.Net.Sockets.MulticastOption" qualify="true" /> class. </para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               DropMembership = 13,\r
-\r
-               /// <summary><para>Do not fragment IP datagrams.</para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data type.</para></summary>\r
-               DontFragment = 14,\r
-\r
-               /// <summary><para>Join a source group.</para><para>The value associated with this option is an instance of the <see cref="!:System.Net.Sockets.IPAddress" qualify="true" />\r
-               /// class. </para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               AddSourceMembership = 15,\r
-\r
-               /// <summary><para>Drop a source group.</para><para>The value associated with this option is an instance of the <see cref="!:System.Net.Sockets.IPAddress" qualify="true" />\r
-               /// class. </para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.IP" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               DropSourceMembership = 16,\r
-\r
-               /// <summary><para>Block data from a source.</para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data type.</para></summary>\r
-               BlockSource = 17,\r
-\r
-               /// <summary><para>Unblock a previously blocked source.</para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data type.</para></summary>\r
-               UnblockSource = 18,\r
-\r
-               /// <summary><para>Return information about received packets.</para></summary>\r
-               PacketInformation = 19,\r
-\r
-               /// <summary><para> Disable the Nagle algorithm for send coalescing.\r
-               ///  </para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data \r
-               ///  type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Tcp" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               NoDelay = 1,\r
-\r
-               /// <summary><para>Use urgent data as defined in RFC-1222. This option can\r
-               ///  be set only once, and once set, cannot be turned off.</para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Tcp" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               BsdUrgent = 2,\r
-\r
-               /// <summary><para>Use expedited data as defined in RFC-1222. This option\r
-               ///  can be set only once, and once set, cannot be turned off.</para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Tcp" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               Expedited = 2,\r
-\r
-               /// <summary><para>Send UDP datagrams with checksum set to zero.</para><para>The value associated with this option is a <see cref="T:System.Boolean" qualify="true" /> data type.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Udp" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               NoChecksum = 1,\r
-\r
-               /// <summary><para>Set or get UDP checksum coverage.</para><para>The <see cref="F:System.Net.Sockets.SocketOptionLevel.Udp" /> value of the <see cref="T:System.Net.Sockets.SocketOptionLevel" /> enumeration applies to this option.</para></summary>\r
-               ChecksumCoverage = 20,\r
-       } // SocketOptionName\r
-\r
-} // System.Net.Sockets\r
+// SocketOptionName.cs
+//
+// This code was automatically generated from
+// ECMA CLI XML Library Specification.
+// Generator: libgen.xsl [1.0; (C) Sergey Chaban (serge@wildwestsoftware.com)]
+// Created: Wed, 5 Sep 2001 06:33:02 UTC
+// Source file: AllTypes.xml
+// URL: http://msdn.microsoft.com/net/ecma/AllTypes.xml
+//
+// (C) 2001 Ximian, Inc.  http://www.ximian.com
+
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+// 
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+
+namespace System.Net.Sockets {
+
+
+       /// <summary>
+       /// </summary>
+       public enum SocketOptionName {
+
+               /// <summary>
+               /// </summary>
+               Debug = 1,
+
+               /// <summary>
+               /// </summary>
+               AcceptConnection = 2,
+
+               /// <summary>
+               /// </summary>
+               ReuseAddress = 4,
+
+               /// <summary>
+               /// </summary>
+               KeepAlive = 8,
+
+               /// <summary>
+               /// </summary>
+               DontRoute = 16,
+
+               /// <summary>
+               /// </summary>
+               Broadcast = 32,
+
+               /// <summary>
+               /// </summary>
+               UseLoopback = 64,
+
+               /// <summary>
+               /// </summary>
+               Linger = 128,
+
+               /// <summary>
+               /// </summary>
+               OutOfBandInline = 256,
+
+               /// <summary>
+               /// </summary>
+               DontLinger = -129,
+
+               /// <summary>
+               /// </summary>
+               ExclusiveAddressUse = -5,
+
+               /// <summary>
+               /// </summary>
+               SendBuffer = 4097,
+
+               /// <summary>
+               /// </summary>
+               ReceiveBuffer = 4098,
+
+               /// <summary>
+               /// </summary>
+               SendLowWater = 4099,
+
+               /// <summary>
+               /// </summary>
+               ReceiveLowWater = 4100,
+
+               /// <summary>
+               /// </summary>
+               SendTimeout = 4101,
+
+               /// <summary>
+               /// </summary>
+               ReceiveTimeout = 4102,
+
+               /// <summary>
+               /// </summary>
+               Error = 4103,
+
+               /// <summary>
+               /// </summary>
+               Type = 4104,
+
+               /// <summary>
+               /// </summary>
+               MaxConnections = 2147483647,
+
+               /// <summary>
+               /// </summary>
+               IPOptions = 1,
+
+               /// <summary>
+               /// </summary>
+               HeaderIncluded = 2,
+
+               /// <summary>
+               /// </summary>
+               TypeOfService = 3,
+
+               /// <summary>
+               /// </summary>
+               IpTimeToLive = 4,
+
+               /// <summary>
+               /// </summary>
+               MulticastInterface = 9,
+
+               /// <summary>
+               /// </summary>
+               MulticastTimeToLive = 10,
+
+               /// <summary>
+               /// </summary>
+               MulticastLoopback = 11,
+
+               /// <summary>
+               /// </summary>
+               AddMembership = 12,
+
+               /// <summary>
+               /// </summary>
+               DropMembership = 13,
+
+               /// <summary>
+               /// </summary>
+               DontFragment = 14,
+
+               /// <summary>
+               /// </summary>
+               AddSourceMembership = 15,
+
+               /// <summary>
+               /// </summary>
+               DropSourceMembership = 16,
+
+               /// <summary>
+               /// </summary>
+               BlockSource = 17,
+
+               /// <summary>
+               /// </summary>
+               UnblockSource = 18,
+
+               /// <summary>
+               /// </summary>
+               PacketInformation = 19,
+
+               /// <summary>
+               /// </summary>
+               NoDelay = 1,
+
+               /// <summary>
+               /// </summary>
+               BsdUrgent = 2,
+
+               /// <summary>
+               /// </summary>
+               Expedited = 2,
+
+               /// <summary>
+               /// </summary>
+               NoChecksum = 1,
+
+               /// <summary>
+               /// </summary>
+               ChecksumCoverage = 20,
+
+#if NET_2_0
+               HopLimit = 21,
+               UpdateAcceptContext = 28683,
+               UpdateConnectContext = 28688,
+#endif
+
+       } // SocketOptionName
+
+} // System.Net.Sockets