mcs/class/System/System.Net.Sockets/SocketFlags.cs

   1 // SocketFlags.cs\r
   2 //\r
   3 // This code was automatically generated from\r
   4 // ECMA CLI XML Library Specification.\r
   5 // Generator: libgen.xsl\r
   6 // Source file: AllTypes.xml\r
   7 // URL: http://msdn.microsoft.com/net/ecma/AllTypes.xml\r
   8 //\r
   9 // (C) 2001 Ximian, Inc.  http://www.ximian.com\r
  10 \r
  11 \r
  12 namespace System.Net.Sockets {\r
  13 \r
  14 \r
  15         /// <summary>\r
  16         /// <para> Controls the transfer behavior when sending and \r
  17         ///  receiving data on a <see cref="T:System.Net.Sockets.Socket" /> instance.</para>\r
  18         /// </summary>\r
  19         /// <remarks>\r
  20         /// <para>The following methods use this enumeration:</para>\r
  21         /// <para>\r
  22         /// <see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" />\r
  23         /// </para>\r
  24         /// <para>\r
  25         /// <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)" />\r
  26         /// </para>\r
  27         /// <para>\r
  28         /// <see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" />\r
  29         /// </para>\r
  30         /// <para>\r
  31         /// <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)" />\r
  32         /// </para>\r
  33         /// <para>\r
  34         /// <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />\r
  35         /// </para>\r
  36         /// <para>\r
  37         /// <see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" />\r
  38         /// </para>\r
  39         /// <para>\r
  40         /// <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />\r
  41         /// </para>\r
  42         /// <para>\r
  43         /// <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" />\r
  44         /// </para>\r
  45         /// </remarks>\r
  46         [Flags]\r
  47         public enum SocketFlags {\r
  48 \r
  49                 /// <summary><para> No flags are specified. \r
  50                 ///  </para></summary>\r
  51                 None = 0x00000000,\r
  52 \r
  53                 /// <summary><para> Specifies to send or receive out-of-band (OOB) data. OOB\r
  54                 ///       data is specially marked data that can be received independently of unmarked data.\r
  55                 ///       </para><block subset="none" type="note"><para>Used only with a connection-oriented protocol. </para></block></summary>\r
  56                 OutOfBand = 0x00000001,\r
  57 \r
  58                 /// <summary><para> Specifies to peek at the incoming data. This copies data \r
  59                 ///  to the input buffer but does not remove it from the input queue.\r
  60                 ///  </para></summary>\r
  61                 Peek = 0x00000002,\r
  62 \r
  63                 /// <summary><para> Specifies not to use routing tables to transmit the data. If there is a router \r
  64                 ///  between the local and destination addresses, the data will be lost.\r
  65                 ///  </para></summary>\r
  66                 DontRoute = 0x00000004,\r
  67 \r
  68                 /// <summary><para> Specifies that a partial message has been received.\r
  69                 ///       </para><block subset="none" type="note"><para>Used only with a message-oriented protocol. </para></block></summary>\r
  70                 Partial = 0x00008000,\r
  71         } // SocketFlags\r
  72 \r
  73 } // System.Net.Sockets\r