285 lines
12 KiB
XML
Raw Normal View History

<?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>