c7df3bc19c96cea8b079ef4f63c7be459ef9e5da
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <doc>\r
3   <assembly>\r
4     <name>System.Net.Sockets</name>\r
5   </assembly>\r
6   <members>\r
7     <member name="T:System.Net.Sockets.ProtocolType">\r
8       <summary>Specifies the protocols that the <see cref="T:System.Net.Sockets.Socket" /> class supports.</summary>\r
9     </member>\r
10     <member name="F:System.Net.Sockets.ProtocolType.Tcp">\r
11       <summary>Transmission Control Protocol.</summary>\r
12     </member>\r
13     <member name="F:System.Net.Sockets.ProtocolType.Udp">\r
14       <summary>User Datagram Protocol.</summary>\r
15     </member>\r
16     <member name="F:System.Net.Sockets.ProtocolType.Unknown">\r
17       <summary>Unknown protocol.</summary>\r
18     </member>\r
19     <member name="F:System.Net.Sockets.ProtocolType.Unspecified">\r
20       <summary>Unspecified protocol.</summary>\r
21     </member>\r
22     <member name="T:System.Net.Sockets.Socket">\r
23       <summary>Implements the Berkeley sockets interface.</summary>\r
24     </member>\r
25     <member name="M:System.Net.Sockets.Socket.#ctor(System.Net.Sockets.AddressFamily,System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType)">\r
26       <summary>Initializes a new instance of the <see cref="T:System.Net.Sockets.Socket" /> class using the specified address family, socket type and protocol.</summary>\r
27       <param name="addressFamily">One of the <see cref="T:System.Net.Sockets.AddressFamily" /> values. </param>\r
28       <param name="socketType">One of the <see cref="T:System.Net.Sockets.SocketType" /> values. </param>\r
29       <param name="protocolType">One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values. </param>\r
30       <exception cref="T:System.Net.Sockets.SocketException">The combination of <paramref name="addressFamily" />, <paramref name="socketType" />, and <paramref name="protocolType" /> results in an invalid socket. </exception>\r
31     </member>\r
32     <member name="M:System.Net.Sockets.Socket.#ctor(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType)">\r
33       <summary>Initializes a new instance of the <see cref="T:System.Net.Sockets.Socket" /> class using the specified socket type and protocol.</summary>\r
34       <param name="socketType">One of the <see cref="T:System.Net.Sockets.SocketType" /> values.</param>\r
35       <param name="protocolType">One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values.</param>\r
36       <exception cref="T:System.Net.Sockets.SocketException">The combination of  <paramref name="socketType" /> and <paramref name="protocolType" /> results in an invalid socket. </exception>\r
37     </member>\r
38     <member name="M:System.Net.Sockets.Socket.AcceptAsync(System.Net.Sockets.SocketAsyncEventArgs)">\r
39       <summary>Begins an asynchronous operation to accept an incoming connection attempt.</summary>\r
40       <returns>Returns true if the I/O operation is pending. The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will be raised upon completion of the operation.Returns false if the I/O operation completed synchronously. The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will not be raised and the <paramref name="e" /> object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.</returns>\r
41       <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>\r
42       <exception cref="T:System.ArgumentException">An argument is not valid. This exception occurs if the buffer provided is not large enough. The buffer must be at least 2 * (sizeof(SOCKADDR_STORAGE + 16) bytes. This exception also occurs if multiple buffers are specified, the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.BufferList" /> property is not null.</exception>\r
43       <exception cref="T:System.ArgumentOutOfRangeException">An argument is out of range. The exception occurs if the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Count" /> is less than 0.</exception>\r
44       <exception cref="T:System.InvalidOperationException">An invalid operation was requested. This exception occurs if the accepting <see cref="T:System.Net.Sockets.Socket" /> is not listening for connections or the accepted socket is bound. You must call the <see cref="M:System.Net.Sockets.Socket.Bind(System.Net.EndPoint)" /> and <see cref="M:System.Net.Sockets.Socket.Listen(System.Int32)" /> method before calling the <see cref="M:System.Net.Sockets.Socket.AcceptAsync(System.Net.Sockets.SocketAsyncEventArgs)" /> method.This exception also occurs if the socket is already connected or a socket operation was already in progress using the specified <paramref name="e" /> parameter. </exception>\r
45       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>\r
46       <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>\r
47       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
48     </member>\r
49     <member name="P:System.Net.Sockets.Socket.AddressFamily">\r
50       <summary>Gets the address family of the <see cref="T:System.Net.Sockets.Socket" />.</summary>\r
51       <returns>One of the <see cref="T:System.Net.Sockets.AddressFamily" /> values.</returns>\r
52     </member>\r
53     <member name="M:System.Net.Sockets.Socket.Bind(System.Net.EndPoint)">\r
54       <summary>Associates a <see cref="T:System.Net.Sockets.Socket" /> with a local endpoint.</summary>\r
55       <param name="localEP">The local <see cref="T:System.Net.EndPoint" /> to associate with the <see cref="T:System.Net.Sockets.Socket" />. </param>\r
56       <exception cref="T:System.ArgumentNullException">\r
57         <paramref name="localEP" /> is null. </exception>\r
58       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>\r
59       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
60       <exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation. </exception>\r
61       <PermissionSet>\r
62         <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
63         <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
64         <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
65         <IPermission class="System.Net.SocketPermission, System, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
66       </PermissionSet>\r
67     </member>\r
68     <member name="M:System.Net.Sockets.Socket.CancelConnectAsync(System.Net.Sockets.SocketAsyncEventArgs)">\r
69       <summary>Cancels an asynchronous request for a remote host connection.</summary>\r
70       <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object used to request the connection to the remote host by calling one of the <see cref="M:System.Net.Sockets.Socket.ConnectAsync(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.Net.Sockets.SocketAsyncEventArgs)" /> methods.</param>\r
71       <exception cref="T:System.ArgumentNullException">The <paramref name="e" /> parameter cannot be null and the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> cannot be null.</exception>\r
72       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. </exception>\r
73       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
74       <exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation.</exception>\r
75     </member>\r
76     <member name="M:System.Net.Sockets.Socket.ConnectAsync(System.Net.Sockets.SocketAsyncEventArgs)">\r
77       <summary>Begins an asynchronous request for a connection to a remote host.</summary>\r
78       <returns>Returns true if the I/O operation is pending. The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will be raised upon completion of the operation. Returns false if the I/O operation completed synchronously. In this case, The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will not be raised and the <paramref name="e" /> object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation. </returns>\r
79       <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>\r
80       <exception cref="T:System.ArgumentException">An argument is not valid. This exception occurs if multiple buffers are specified, the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.BufferList" /> property is not null. </exception>\r
81       <exception cref="T:System.ArgumentNullException">The <paramref name="e" /> parameter cannot be null and the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> cannot be null.</exception>\r
82       <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.Sockets.Socket" /> is listening or a socket operation was already in progress using the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object specified in the <paramref name="e" /> parameter.</exception>\r
83       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information.</exception>\r
84       <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method. This exception also occurs if the local endpoint and the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> are not the same address family.</exception>\r
85       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
86       <exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation.</exception>\r
87     </member>\r
88     <member name="M:System.Net.Sockets.Socket.ConnectAsync(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.Net.Sockets.SocketAsyncEventArgs)">\r
89       <summary>Begins an asynchronous request for a connection to a remote host.</summary>\r
90       <returns>Returns true if the I/O operation is pending. The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will be raised upon completion of the operation. Returns false if the I/O operation completed synchronously. In this case, The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will not be raised and the <paramref name="e" /> object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation. </returns>\r
91       <param name="socketType">One of the <see cref="T:System.Net.Sockets.SocketType" /> values.</param>\r
92       <param name="protocolType">One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values.</param>\r
93       <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>\r
94       <exception cref="T:System.ArgumentException">An argument is not valid. This exception occurs if multiple buffers are specified, the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.BufferList" /> property is not null. </exception>\r
95       <exception cref="T:System.ArgumentNullException">The <paramref name="e" /> parameter cannot be null and the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> cannot be null.</exception>\r
96       <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.Sockets.Socket" /> is listening or a socket operation was already in progress using the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object specified in the <paramref name="e" /> parameter.</exception>\r
97       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information.</exception>\r
98       <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method. This exception also occurs if the local endpoint and the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> are not the same address family.</exception>\r
99       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
100       <exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation.</exception>\r
101     </member>\r
102     <member name="P:System.Net.Sockets.Socket.Connected">\r
103       <summary>Gets a value that indicates whether a <see cref="T:System.Net.Sockets.Socket" /> is connected to a remote host as of the last <see cref="Overload:System.Net.Sockets.Socket.Send" /> or <see cref="Overload:System.Net.Sockets.Socket.Receive" /> operation.</summary>\r
104       <returns>true if the <see cref="T:System.Net.Sockets.Socket" /> was connected to a remote resource as of the most recent operation; otherwise, false.</returns>\r
105     </member>\r
106     <member name="M:System.Net.Sockets.Socket.Dispose">\r
107       <summary>Releases all resources used by the current instance of the <see cref="T:System.Net.Sockets.Socket" /> class.</summary>\r
108     </member>\r
109     <member name="M:System.Net.Sockets.Socket.Dispose(System.Boolean)">\r
110       <summary>Releases the unmanaged resources used by the <see cref="T:System.Net.Sockets.Socket" />, and optionally disposes of the managed resources.</summary>\r
111       <param name="disposing">true to release both managed and unmanaged resources; false to releases only unmanaged resources. </param>\r
112     </member>\r
113     <member name="M:System.Net.Sockets.Socket.Finalize">\r
114       <summary>Frees resources used by the <see cref="T:System.Net.Sockets.Socket" /> class.</summary>\r
115     </member>\r
116     <member name="M:System.Net.Sockets.Socket.Listen(System.Int32)">\r
117       <summary>Places a <see cref="T:System.Net.Sockets.Socket" /> in a listening state.</summary>\r
118       <param name="backlog">The maximum length of the pending connections queue. </param>\r
119       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>\r
120       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
121       <PermissionSet>\r
122         <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
123         <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
124         <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />\r
125       </PermissionSet>\r
126     </member>\r
127     <member name="P:System.Net.Sockets.Socket.LocalEndPoint">\r
128       <summary>Gets the local endpoint.</summary>\r
129       <returns>The <see cref="T:System.Net.EndPoint" /> that the <see cref="T:System.Net.Sockets.Socket" /> is using for communications.</returns>\r
130       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>\r
131       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
132       <PermissionSet>\r
133         <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
134         <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
135         <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />\r
136       </PermissionSet>\r
137     </member>\r
138     <member name="P:System.Net.Sockets.Socket.NoDelay">\r
139       <summary>Gets or sets a <see cref="T:System.Boolean" /> value that specifies whether the stream <see cref="T:System.Net.Sockets.Socket" /> is using the Nagle algorithm.</summary>\r
140       <returns>false if the <see cref="T:System.Net.Sockets.Socket" /> uses the Nagle algorithm; otherwise, true. The default is false.</returns>\r
141       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the <see cref="T:System.Net.Sockets.Socket" />. See the Remarks section for more information. </exception>\r
142       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
143       <PermissionSet>\r
144         <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
145         <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
146         <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
147       </PermissionSet>\r
148     </member>\r
149     <member name="P:System.Net.Sockets.Socket.OSSupportsIPv4">\r
150       <summary>Indicates whether the underlying operating system and network adaptors support Internet Protocol version 4 (IPv4).</summary>\r
151       <returns>true if the operating system and network adaptors support the IPv4 protocol; otherwise, false.</returns>\r
152     </member>\r
153     <member name="P:System.Net.Sockets.Socket.OSSupportsIPv6">\r
154       <summary>Indicates whether the underlying operating system and network adaptors support Internet Protocol version 6 (IPv6).</summary>\r
155       <returns>true if the operating system and network adaptors support the IPv6 protocol; otherwise, false.</returns>\r
156     </member>\r
157     <member name="P:System.Net.Sockets.Socket.ProtocolType">\r
158       <summary>Gets the protocol type of the <see cref="T:System.Net.Sockets.Socket" />.</summary>\r
159       <returns>One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values.</returns>\r
160     </member>\r
161     <member name="M:System.Net.Sockets.Socket.ReceiveAsync(System.Net.Sockets.SocketAsyncEventArgs)">\r
162       <summary>Begins an asynchronous request to receive data from a connected <see cref="T:System.Net.Sockets.Socket" /> object.</summary>\r
163       <returns>Returns true if the I/O operation is pending. The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will be raised upon completion of the operation. Returns false if the I/O operation completed synchronously. In this case, The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will not be raised and the <paramref name="e" /> object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.</returns>\r
164       <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>\r
165       <exception cref="T:System.ArgumentException">An argument was invalid. The <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> or <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.BufferList" /> properties on the <paramref name="e" /> parameter must reference valid buffers. One or the other of these properties may be set, but not both at the same time.</exception>\r
166       <exception cref="T:System.InvalidOperationException">A socket operation was already in progress using the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object specified in the <paramref name="e" /> parameter.</exception>\r
167       <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>\r
168       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
169       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>\r
170     </member>\r
171     <member name="P:System.Net.Sockets.Socket.ReceiveBufferSize">\r
172       <summary>Gets or sets a value that specifies the size of the receive buffer of the <see cref="T:System.Net.Sockets.Socket" />.</summary>\r
173       <returns>An <see cref="T:System.Int32" /> that contains the size, in bytes, of the receive buffer. The default is 8192.</returns>\r
174       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket.</exception>\r
175       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
176       <exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation is less than 0.</exception>\r
177       <PermissionSet>\r
178         <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
179         <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
180         <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
181       </PermissionSet>\r
182     </member>\r
183     <member name="M:System.Net.Sockets.Socket.ReceiveFromAsync(System.Net.Sockets.SocketAsyncEventArgs)">\r
184       <summary>Begins to asynchronously receive data from a specified network device.</summary>\r
185       <returns>Returns true if the I/O operation is pending. The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will be raised upon completion of the operation. Returns false if the I/O operation completed synchronously. In this case, The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will not be raised and the <paramref name="e" /> object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.</returns>\r
186       <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>\r
187       <exception cref="T:System.ArgumentNullException">The <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> cannot be null.</exception>\r
188       <exception cref="T:System.InvalidOperationException">A socket operation was already in progress using the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object specified in the <paramref name="e" /> parameter.</exception>\r
189       <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>\r
190       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
191       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. </exception>\r
192     </member>\r
193     <member name="P:System.Net.Sockets.Socket.RemoteEndPoint">\r
194       <summary>Gets the remote endpoint.</summary>\r
195       <returns>The <see cref="T:System.Net.EndPoint" /> with which the <see cref="T:System.Net.Sockets.Socket" /> is communicating.</returns>\r
196       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>\r
197       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
198       <PermissionSet>\r
199         <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
200         <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
201         <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />\r
202       </PermissionSet>\r
203     </member>\r
204     <member name="M:System.Net.Sockets.Socket.SendAsync(System.Net.Sockets.SocketAsyncEventArgs)">\r
205       <summary>Sends data asynchronously to a connected <see cref="T:System.Net.Sockets.Socket" /> object.</summary>\r
206       <returns>Returns true if the I/O operation is pending. The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will be raised upon completion of the operation. Returns false if the I/O operation completed synchronously. In this case, The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will not be raised and the <paramref name="e" /> object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.</returns>\r
207       <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>\r
208       <exception cref="T:System.ArgumentException">The <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> or <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.BufferList" /> properties on the <paramref name="e" /> parameter must reference valid buffers. One or the other of these properties may be set, but not both at the same time.</exception>\r
209       <exception cref="T:System.InvalidOperationException">A socket operation was already in progress using the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object specified in the <paramref name="e" /> parameter.</exception>\r
210       <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>\r
211       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
212       <exception cref="T:System.Net.Sockets.SocketException">The <see cref="T:System.Net.Sockets.Socket" /> is not yet connected or was not obtained via an <see cref="M:System.Net.Sockets.Socket.Accept" />, <see cref="M:System.Net.Sockets.Socket.AcceptAsync(System.Net.Sockets.SocketAsyncEventArgs)" />,or <see cref="Overload:System.Net.Sockets.Socket.BeginAccept" />, method.</exception>\r
213     </member>\r
214     <member name="P:System.Net.Sockets.Socket.SendBufferSize">\r
215       <summary>Gets or sets a value that specifies the size of the send buffer of the <see cref="T:System.Net.Sockets.Socket" />.</summary>\r
216       <returns>An <see cref="T:System.Int32" /> that contains the size, in bytes, of the send buffer. The default is 8192.</returns>\r
217       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket.</exception>\r
218       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
219       <exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation is less than 0.</exception>\r
220       <PermissionSet>\r
221         <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
222         <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
223         <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
224       </PermissionSet>\r
225     </member>\r
226     <member name="M:System.Net.Sockets.Socket.SendToAsync(System.Net.Sockets.SocketAsyncEventArgs)">\r
227       <summary>Sends data asynchronously to a specific remote host.</summary>\r
228       <returns>Returns true if the I/O operation is pending. The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will be raised upon completion of the operation. Returns false if the I/O operation completed synchronously. In this case, The <see cref="E:System.Net.Sockets.SocketAsyncEventArgs.Completed" /> event on the <paramref name="e" /> parameter will not be raised and the <paramref name="e" /> object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.</returns>\r
229       <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>\r
230       <exception cref="T:System.ArgumentNullException">The <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> cannot be null.</exception>\r
231       <exception cref="T:System.InvalidOperationException">A socket operation was already in progress using the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object specified in the <paramref name="e" /> parameter.</exception>\r
232       <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>\r
233       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
234       <exception cref="T:System.Net.Sockets.SocketException">The protocol specified is connection-oriented, but the <see cref="T:System.Net.Sockets.Socket" /> is not yet connected.</exception>\r
235     </member>\r
236     <member name="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)">\r
237       <summary>Disables sends and receives on a <see cref="T:System.Net.Sockets.Socket" />.</summary>\r
238       <param name="how">One of the <see cref="T:System.Net.Sockets.SocketShutdown" /> values that specifies the operation that will no longer be allowed. </param>\r
239       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>\r
240       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
241       <PermissionSet>\r
242         <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
243         <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
244         <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />\r
245       </PermissionSet>\r
246     </member>\r
247     <member name="P:System.Net.Sockets.Socket.Ttl">\r
248       <summary>Gets or sets a value that specifies the Time To Live (TTL) value of Internet Protocol (IP) packets sent by the <see cref="T:System.Net.Sockets.Socket" />.</summary>\r
249       <returns>The TTL value.</returns>\r
250       <exception cref="T:System.ArgumentOutOfRangeException">The TTL value can't be set to a negative number.</exception>\r
251       <exception cref="T:System.NotSupportedException">This property can be set only for sockets in the <see cref="F:System.Net.Sockets.AddressFamily.InterNetwork" /> or <see cref="F:System.Net.Sockets.AddressFamily.InterNetworkV6" /> families.</exception>\r
252       <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. This error is also returned when an attempt was made to set TTL to a value higher than 255.</exception>\r
253       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>\r
254       <PermissionSet>\r
255         <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
256         <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
257         <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />\r
258       </PermissionSet>\r
259     </member>\r
260     <member name="T:System.Net.Sockets.SocketAsyncEventArgs">\r
261       <summary>Represents an asynchronous socket operation.</summary>\r
262     </member>\r
263     <member name="M:System.Net.Sockets.SocketAsyncEventArgs.#ctor">\r
264       <summary>Creates an empty <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> instance.</summary>\r
265       <exception cref="T:System.NotSupportedException">The platform is not supported. </exception>\r
266     </member>\r
267     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.AcceptSocket">\r
268       <summary>Gets or sets the socket to use or the socket created for accepting a connection with an asynchronous socket method.</summary>\r
269       <returns>The <see cref="T:System.Net.Sockets.Socket" /> to use or the socket created for accepting a connection with an asynchronous socket method.</returns>\r
270     </member>\r
271     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer">\r
272       <summary>Gets the data buffer to use with an asynchronous socket method.</summary>\r
273       <returns>A <see cref="T:System.Byte" /> array that represents the data buffer to use with an asynchronous socket method.</returns>\r
274     </member>\r
275     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.BufferList">\r
276       <summary>Gets or sets an array of data buffers to use with an asynchronous socket method.</summary>\r
277       <returns>An <see cref="T:System.Collections.IList" /> that represents an array of data buffers to use with an asynchronous socket method.</returns>\r
278       <exception cref="T:System.ArgumentException">There are ambiguous buffers specified on a set operation. This exception occurs if the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> property has been set to a non-null value and an attempt was made to set the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.BufferList" /> property to a non-null value.</exception>\r
279     </member>\r
280     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.BytesTransferred">\r
281       <summary>Gets the number of bytes transferred in the socket operation.</summary>\r
282       <returns>An <see cref="T:System.Int32" /> that contains the number of bytes transferred in the socket operation.</returns>\r
283     </member>\r
284     <member name="E:System.Net.Sockets.SocketAsyncEventArgs.Completed">\r
285       <summary>The event used to complete an asynchronous operation.</summary>\r
286     </member>\r
287     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.ConnectByNameError">\r
288       <summary>Gets the exception in the case of a connection failure when a <see cref="T:System.Net.DnsEndPoint" /> was used.</summary>\r
289       <returns>An <see cref="T:System.Exception" /> that indicates the cause of the connection error when a <see cref="T:System.Net.DnsEndPoint" /> was specified for the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> property.</returns>\r
290     </member>\r
291     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.ConnectSocket">\r
292       <summary>The created and connected <see cref="T:System.Net.Sockets.Socket" /> object after successful completion of the <see cref="Overload:System.Net.Sockets.Socket.ConnectAsync" /> method.</summary>\r
293       <returns>The connected <see cref="T:System.Net.Sockets.Socket" /> object.</returns>\r
294     </member>\r
295     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.Count">\r
296       <summary>Gets the maximum amount of data, in bytes, to send or receive in an asynchronous operation.</summary>\r
297       <returns>An <see cref="T:System.Int32" /> that contains the maximum amount of data, in bytes, to send or receive.</returns>\r
298     </member>\r
299     <member name="M:System.Net.Sockets.SocketAsyncEventArgs.Dispose">\r
300       <summary>Releases the unmanaged resources used by the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> instance and optionally disposes of the managed resources.</summary>\r
301     </member>\r
302     <member name="M:System.Net.Sockets.SocketAsyncEventArgs.Finalize">\r
303       <summary>Frees resources used by the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> class.</summary>\r
304     </member>\r
305     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.LastOperation">\r
306       <summary>Gets the type of socket operation most recently performed with this context object.</summary>\r
307       <returns>A <see cref="T:System.Net.Sockets.SocketAsyncOperation" /> instance that indicates the type of socket operation most recently performed with this context object.</returns>\r
308     </member>\r
309     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.Offset">\r
310       <summary>Gets the offset, in bytes, into the data buffer referenced by the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> property.</summary>\r
311       <returns>An <see cref="T:System.Int32" /> that contains the offset, in bytes, into the data buffer referenced by the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> property.</returns>\r
312     </member>\r
313     <member name="M:System.Net.Sockets.SocketAsyncEventArgs.OnCompleted(System.Net.Sockets.SocketAsyncEventArgs)">\r
314       <summary>Represents a method that is called when an asynchronous operation completes.</summary>\r
315       <param name="e">The event that is signaled.</param>\r
316     </member>\r
317     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint">\r
318       <summary>Gets or sets the remote IP endpoint for an asynchronous operation.</summary>\r
319       <returns>An <see cref="T:System.Net.EndPoint" /> that represents the remote IP endpoint for an asynchronous operation.</returns>\r
320     </member>\r
321     <member name="M:System.Net.Sockets.SocketAsyncEventArgs.SetBuffer(System.Byte[],System.Int32,System.Int32)">\r
322       <summary>Sets the data buffer to use with an asynchronous socket method.</summary>\r
323       <param name="buffer">The data buffer to use with an asynchronous socket method.</param>\r
324       <param name="offset">The offset, in bytes, in the data buffer where the operation starts.</param>\r
325       <param name="count">The maximum amount of data, in bytes, to send or receive in the buffer.</param>\r
326       <exception cref="T:System.ArgumentException">There are ambiguous buffers specified. This exception occurs if the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> property is also not null and the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.BufferList" /> property is also not null.</exception>\r
327       <exception cref="T:System.ArgumentOutOfRangeException">An argument was out of range. This exception occurs if the <paramref name="offset" /> parameter is less than zero or greater than the length of the array in the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> property. This exception also occurs if the <paramref name="count" /> parameter is less than zero or greater than the length of the array in the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> property minus the <paramref name="offset" /> parameter.</exception>\r
328     </member>\r
329     <member name="M:System.Net.Sockets.SocketAsyncEventArgs.SetBuffer(System.Int32,System.Int32)">\r
330       <summary>Sets the data buffer to use with an asynchronous socket method.</summary>\r
331       <param name="offset">The offset, in bytes, in the data buffer where the operation starts.</param>\r
332       <param name="count">The maximum amount of data, in bytes, to send or receive in the buffer.</param>\r
333       <exception cref="T:System.ArgumentOutOfRangeException">An argument was out of range. This exception occurs if the <paramref name="offset" /> parameter is less than zero or greater than the length of the array in the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> property. This exception also occurs if the <paramref name="count" /> parameter is less than zero or greater than the length of the array in the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> property minus the <paramref name="offset" /> parameter.</exception>\r
334     </member>\r
335     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.SocketError">\r
336       <summary>Gets or sets the result of the asynchronous socket operation.</summary>\r
337       <returns>A <see cref="T:System.Net.Sockets.SocketError" /> that represents the result of the asynchronous socket operation.</returns>\r
338     </member>\r
339     <member name="P:System.Net.Sockets.SocketAsyncEventArgs.UserToken">\r
340       <summary>Gets or sets a user or application object associated with this asynchronous socket operation.</summary>\r
341       <returns>An object that represents the user or application object associated with this asynchronous socket operation.</returns>\r
342     </member>\r
343     <member name="T:System.Net.Sockets.SocketAsyncOperation">\r
344       <summary>The type of asynchronous socket operation most recently performed with this context object.</summary>\r
345     </member>\r
346     <member name="F:System.Net.Sockets.SocketAsyncOperation.Accept">\r
347       <summary>A socket Accept operation. </summary>\r
348     </member>\r
349     <member name="F:System.Net.Sockets.SocketAsyncOperation.Connect">\r
350       <summary>A socket Connect operation.</summary>\r
351     </member>\r
352     <member name="F:System.Net.Sockets.SocketAsyncOperation.None">\r
353       <summary>None of the socket operations.</summary>\r
354     </member>\r
355     <member name="F:System.Net.Sockets.SocketAsyncOperation.Receive">\r
356       <summary>A socket Receive operation.</summary>\r
357     </member>\r
358     <member name="F:System.Net.Sockets.SocketAsyncOperation.ReceiveFrom">\r
359       <summary>A socket ReceiveFrom operation.</summary>\r
360     </member>\r
361     <member name="F:System.Net.Sockets.SocketAsyncOperation.Send">\r
362       <summary>A socket Send operation.</summary>\r
363     </member>\r
364     <member name="F:System.Net.Sockets.SocketAsyncOperation.SendTo">\r
365       <summary>A socket SendTo operation.</summary>\r
366     </member>\r
367     <member name="T:System.Net.Sockets.SocketShutdown">\r
368       <summary>Defines constants that are used by the <see cref="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)" /> method.</summary>\r
369     </member>\r
370     <member name="F:System.Net.Sockets.SocketShutdown.Both">\r
371       <summary>Disables a <see cref="T:System.Net.Sockets.Socket" /> for both sending and receiving. This field is constant.</summary>\r
372     </member>\r
373     <member name="F:System.Net.Sockets.SocketShutdown.Receive">\r
374       <summary>Disables a <see cref="T:System.Net.Sockets.Socket" /> for receiving. This field is constant.</summary>\r
375     </member>\r
376     <member name="F:System.Net.Sockets.SocketShutdown.Send">\r
377       <summary>Disables a <see cref="T:System.Net.Sockets.Socket" /> for sending. This field is constant.</summary>\r
378     </member>\r
379     <member name="T:System.Net.Sockets.SocketType">\r
380       <summary>Specifies the type of socket that an instance of the <see cref="T:System.Net.Sockets.Socket" /> class represents.</summary>\r
381     </member>\r
382     <member name="F:System.Net.Sockets.SocketType.Dgram">\r
383       <summary>Supports datagrams, which are connectionless, unreliable messages of a fixed (typically small) maximum length. Messages might be lost or duplicated and might arrive out of order. A <see cref="T:System.Net.Sockets.Socket" /> of type <see cref="F:System.Net.Sockets.SocketType.Dgram" /> requires no connection prior to sending and receiving data, and can communicate with multiple peers. <see cref="F:System.Net.Sockets.SocketType.Dgram" /> uses the Datagram Protocol (<see cref="F:System.Net.Sockets.ProtocolType.Udp" />) and the <see cref="F:System.Net.Sockets.AddressFamily.InterNetwork" /><see cref="T:System.Net.Sockets.AddressFamily" />.</summary>\r
384     </member>\r
385     <member name="F:System.Net.Sockets.SocketType.Stream">\r
386       <summary>Supports reliable, two-way, connection-based byte streams without the duplication of data and without preservation of boundaries. A Socket of this type communicates with a single peer and requires a remote host connection before communication can begin. <see cref="F:System.Net.Sockets.SocketType.Stream" /> uses the Transmission Control Protocol (<see cref="F:System.Net.Sockets.ProtocolType.Tcp" />) <see cref="T:System.Net.Sockets.ProtocolType" /> and the InterNetwork<see cref="T:System.Net.Sockets.AddressFamily" />.</summary>\r
387     </member>\r
388     <member name="F:System.Net.Sockets.SocketType.Unknown">\r
389       <summary>Specifies an unknown Socket type.</summary>\r
390     </member>\r
391   </members>\r
392 </doc>