mcs/class/System/Documentation/en/System.Net.Sockets/SocketFlags.xml

   1 <Type Name="SocketFlags" FullName="System.Net.Sockets.SocketFlags" FullNameSP="System_Net_Sockets_SocketFlags" Maintainer="ecma">
   2   <TypeSignature Language="ILASM" Value=".class public sealed serializable SocketFlags extends System.Enum" />
   3   <TypeSignature Language="C#" Value="public enum SocketFlags" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SocketFlags extends System.Enum" />
   5   <MemberOfLibrary>Networking</MemberOfLibrary>
   6   <AssemblyInfo>
   7     <AssemblyName>System</AssemblyName>
   8     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
   9     <AssemblyVersion>1.0.x.x</AssemblyVersion>
  10     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  11     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  12     <AssemblyVersion>4.0.0.0</AssemblyVersion>
  13   </AssemblyInfo>
  14   <Base>
  15     <BaseTypeName>System.Enum</BaseTypeName>
  16   </Base>
  17   <Attributes>
  18     <Attribute>
  19       <AttributeName>System.Flags</AttributeName>
  20     </Attribute>
  21   </Attributes>
  22   <Docs>
  23     <summary>
  24       <para> Controls the transfer behavior when sending and
  25       receiving data on a <see cref="T:System.Net.Sockets.Socket" /> instance.</para>
  26     </summary>
  27     <remarks>
  28       <para>The following methods use this enumeration:</para>
  29       <list type="bullet">
  30         <item>
  31           <term>
  32             <see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" />
  33           </term>
  34         </item>
  35         <item>
  36           <term>
  37             <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)" />
  38           </term>
  39         </item>
  40         <item>
  41           <term>
  42             <see cref="M:System.Net.Sockets.Socket.BeginSend(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)" />
  43           </term>
  44         </item>
  45         <item>
  46           <term>
  47             <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)" />
  48           </term>
  49         </item>
  50         <item>
  51           <term>
  52             <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />
  53           </term>
  54         </item>
  55         <item>
  56           <term>
  57             <see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" />
  58           </term>
  59         </item>
  60         <item>
  61           <term>
  62             <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" />
  63           </term>
  64         </item>
  65         <item>
  66           <term>
  67             <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" />
  68           </term>
  69         </item>
  70       </list>
  71     </remarks>
  72   </Docs>
  73   <Members>
  74     <Member MemberName="Broadcast">
  75       <MemberSignature Language="C#" Value="Broadcast" />
  76       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Broadcast = int32(1024)" />
  77       <MemberType>Field</MemberType>
  78       <AssemblyInfo>
  79         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  80         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  81       </AssemblyInfo>
  82       <ReturnValue>
  83         <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
  84       </ReturnValue>
  85       <Docs>
  86         <summary>To be added.</summary>
  87       </Docs>
  88     </Member>
  89     <Member MemberName="ControlDataTruncated">
  90       <MemberSignature Language="C#" Value="ControlDataTruncated" />
  91       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags ControlDataTruncated = int32(512)" />
  92       <MemberType>Field</MemberType>
  93       <AssemblyInfo>
  94         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  95         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  96       </AssemblyInfo>
  97       <ReturnValue>
  98         <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
  99       </ReturnValue>
 100       <Docs>
 101         <summary>To be added.</summary>
 102       </Docs>
 103     </Member>
 104     <Member MemberName="DontRoute">
 105       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags DontRoute = 0x4" />
 106       <MemberSignature Language="C#" Value="DontRoute" />
 107       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags DontRoute = int32(4)" />
 108       <MemberType>Field</MemberType>
 109       <AssemblyInfo>
 110         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 111         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 112         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 113       </AssemblyInfo>
 114       <ReturnValue>
 115         <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
 116       </ReturnValue>
 117       <Parameters />
 118       <MemberValue>DontRoute</MemberValue>
 119       <Docs>
 120         <summary>
 121           <para> Specifies not to use routing tables to transmit the data. If there is a router
 122  between the local and destination addresses, the data will be lost.
 123  </para>
 124         </summary>
 125       </Docs>
 126       <Excluded>0</Excluded>
 127     </Member>
 128     <Member MemberName="MaxIOVectorLength">
 129       <MemberSignature Language="C#" Value="MaxIOVectorLength" />
 130       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags MaxIOVectorLength = int32(16)" />
 131       <MemberType>Field</MemberType>
 132       <AssemblyInfo>
 133         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 134         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 135         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 136       </AssemblyInfo>
 137       <ReturnValue>
 138         <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
 139       </ReturnValue>
 140       <MemberValue>MaxIOVectorLength</MemberValue>
 141       <Docs>
 142         <summary>To be added.</summary>
 143         <remarks>To be added.</remarks>
 144       </Docs>
 145     </Member>
 146     <Member MemberName="Multicast">
 147       <MemberSignature Language="C#" Value="Multicast" />
 148       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Multicast = int32(2048)" />
 149       <MemberType>Field</MemberType>
 150       <AssemblyInfo>
 151         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 152         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 153       </AssemblyInfo>
 154       <ReturnValue>
 155         <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
 156       </ReturnValue>
 157       <Docs>
 158         <summary>To be added.</summary>
 159       </Docs>
 160     </Member>
 161     <Member MemberName="None">
 162       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags None = 0x0" />
 163       <MemberSignature Language="C#" Value="None" />
 164       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags None = int32(0)" />
 165       <MemberType>Field</MemberType>
 166       <AssemblyInfo>
 167         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 168         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 169         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 170       </AssemblyInfo>
 171       <ReturnValue>
 172         <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
 173       </ReturnValue>
 174       <Parameters />
 175       <MemberValue>None</MemberValue>
 176       <Docs>
 177         <summary>
 178           <para> No flags are specified.
 179  </para>
 180         </summary>
 181       </Docs>
 182       <Excluded>0</Excluded>
 183     </Member>
 184     <Member MemberName="OutOfBand">
 185       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags OutOfBand = 0x1" />
 186       <MemberSignature Language="C#" Value="OutOfBand" />
 187       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags OutOfBand = int32(1)" />
 188       <MemberType>Field</MemberType>
 189       <AssemblyInfo>
 190         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 191         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 192         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 193       </AssemblyInfo>
 194       <ReturnValue>
 195         <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
 196       </ReturnValue>
 197       <Parameters />
 198       <MemberValue>OutOfBand</MemberValue>
 199       <Docs>
 200         <summary>
 201           <para> Specifies to send or receive out-of-band (OOB) data. OOB
 202       data is specially marked data that can be received independently of unmarked data.
 203       </para>
 204           <block subset="none" type="note">
 205             <para>Used only with a connection-oriented protocol. </para>
 206           </block>
 207         </summary>
 208       </Docs>
 209       <Excluded>0</Excluded>
 210     </Member>
 211     <Member MemberName="Partial">
 212       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Partial = 0x8000" />
 213       <MemberSignature Language="C#" Value="Partial" />
 214       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Partial = int32(32768)" />
 215       <MemberType>Field</MemberType>
 216       <AssemblyInfo>
 217         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 218         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 219         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 220       </AssemblyInfo>
 221       <ReturnValue>
 222         <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
 223       </ReturnValue>
 224       <Parameters />
 225       <MemberValue>Partial</MemberValue>
 226       <Docs>
 227         <summary>
 228           <para> Specifies that a partial message has been received.
 229       </para>
 230           <block subset="none" type="note">
 231             <para>Used only with a message-oriented protocol. </para>
 232           </block>
 233         </summary>
 234       </Docs>
 235       <Excluded>0</Excluded>
 236     </Member>
 237     <Member MemberName="Peek">
 238       <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Peek = 0x2" />
 239       <MemberSignature Language="C#" Value="Peek" />
 240       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Peek = int32(2)" />
 241       <MemberType>Field</MemberType>
 242       <AssemblyInfo>
 243         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 244         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 245         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 246       </AssemblyInfo>
 247       <ReturnValue>
 248         <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
 249       </ReturnValue>
 250       <Parameters />
 251       <MemberValue>Peek</MemberValue>
 252       <Docs>
 253         <summary>
 254           <para> Specifies to peek at the incoming data. This copies data
 255  to the input buffer but does not remove it from the input queue.
 256  </para>
 257         </summary>
 258       </Docs>
 259       <Excluded>0</Excluded>
 260     </Member>
 261     <Member MemberName="Truncated">
 262       <MemberSignature Language="C#" Value="Truncated" />
 263       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags Truncated = int32(256)" />
 264       <MemberType>Field</MemberType>
 265       <AssemblyInfo>
 266         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 267         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 268       </AssemblyInfo>
 269       <ReturnValue>
 270         <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
 271       </ReturnValue>
 272       <Docs>
 273         <summary>To be added.</summary>
 274       </Docs>
 275     </Member>
 276   </Members>
 277   <TypeExcluded>0</TypeExcluded>
 278 </Type>