File: SocketFlags.xml

package info (click to toggle)
monodoc 1.1.18-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 58,432 kB
  • ctags: 4,991
  • sloc: xml: 718,392; cs: 38,337; sh: 3,172; perl: 554; makefile: 303
file content (198 lines) | stat: -rwxr-xr-x 7,719 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<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" />
  <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>
    <AssemblyCulture>none</AssemblyCulture>
    <Attributes>
      <Attribute>
        <AttributeName>CLSCompliantAttribute(true)</AttributeName>
        <Excluded>0</Excluded>
      </Attribute>
    </Attributes>
  </AssemblyInfo>
  <Docs>
    <summary>
      <para> Controls the transfer behavior when sending and
      receiving data on a <see cref="T:System.Net.Sockets.Socket" /> instance.</para>
    </summary>
    <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>
  </Docs>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>FlagsAttribute</AttributeName>
      <Excluded>0</Excluded>
    </Attribute>
  </Attributes>
  <Members>
    <Member MemberName="value__">
      <MemberSignature Language="ILASM" Value=".field public rtspecialname specialname int32 value__" />
      <MemberSignature Language="C#" Value="value__;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs />
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="None">
      <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags None = 0x0" />
      <MemberSignature Language="C#" Value="None = 0x0;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>None</MemberValue>
      <Docs>
        <summary>
          <para> No flags are specified. 
 </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 = 0x1;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>OutOfBand</MemberValue>
      <Docs>
        <summary>
          <para> Specifies to send or receive out-of-band (OOB) data. OOB
      data is specially marked data that can be received independently of unmarked data.
      </para>
          <block subset="none" type="note">
            <para>Used only with a connection-oriented protocol. </para>
          </block>
        </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 = 0x2;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>Peek</MemberValue>
      <Docs>
        <summary>
          <para> Specifies to peek at the incoming data. This copies data 
 to the input buffer but does not remove it from the input queue.
 </para>
        </summary>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="DontRoute">
      <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketFlags DontRoute = 0x4" />
      <MemberSignature Language="C#" Value="DontRoute = 0x4;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>DontRoute</MemberValue>
      <Docs>
        <summary>
          <para> Specifies not to use routing tables to transmit the data. If there is a router 
 between the local and destination addresses, the data will be lost.
 </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 = 0x8000;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>Partial</MemberValue>
      <Docs>
        <summary>
          <para> Specifies that a partial message has been received.
      </para>
          <block subset="none" type="note">
            <para>Used only with a message-oriented protocol. </para>
          </block>
        </summary>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
  <Member MemberName="MaxIOVectorLength">
      <MemberSignature Language="C#" Value="public static const System.Net.Sockets.SocketFlags MaxIOVectorLength" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.Sockets.SocketFlags</ReturnType>
      </ReturnValue>
      <MemberValue>MaxIOVectorLength</MemberValue>
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
  <TypeExcluded>0</TypeExcluded>
</Type>