392 lines
45 KiB
XML
392 lines
45 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>System.Net.Sockets</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:System.Net.Sockets.ProtocolType">
|
|
<summary>Specifies the protocols that the <see cref="T:System.Net.Sockets.Socket" /> class supports.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.ProtocolType.Tcp">
|
|
<summary>Transmission Control Protocol.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.ProtocolType.Udp">
|
|
<summary>User Datagram Protocol.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.ProtocolType.Unknown">
|
|
<summary>Unknown protocol.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.ProtocolType.Unspecified">
|
|
<summary>Unspecified protocol.</summary>
|
|
</member>
|
|
<member name="T:System.Net.Sockets.Socket">
|
|
<summary>Implements the Berkeley sockets interface.</summary>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.#ctor(System.Net.Sockets.AddressFamily,System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType)">
|
|
<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>
|
|
<param name="addressFamily">One of the <see cref="T:System.Net.Sockets.AddressFamily" /> values. </param>
|
|
<param name="socketType">One of the <see cref="T:System.Net.Sockets.SocketType" /> values. </param>
|
|
<param name="protocolType">One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values. </param>
|
|
<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>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.#ctor(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType)">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Net.Sockets.Socket" /> class using the specified socket type and protocol.</summary>
|
|
<param name="socketType">One of the <see cref="T:System.Net.Sockets.SocketType" /> values.</param>
|
|
<param name="protocolType">One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values.</param>
|
|
<exception cref="T:System.Net.Sockets.SocketException">The combination of <paramref name="socketType" /> and <paramref name="protocolType" /> results in an invalid socket. </exception>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.AcceptAsync(System.Net.Sockets.SocketAsyncEventArgs)">
|
|
<summary>Begins an asynchronous operation to accept an incoming connection attempt.</summary>
|
|
<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>
|
|
<param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>
|
|
<exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.AddressFamily">
|
|
<summary>Gets the address family of the <see cref="T:System.Net.Sockets.Socket" />.</summary>
|
|
<returns>One of the <see cref="T:System.Net.Sockets.AddressFamily" /> values.</returns>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.Bind(System.Net.EndPoint)">
|
|
<summary>Associates a <see cref="T:System.Net.Sockets.Socket" /> with a local endpoint.</summary>
|
|
<param name="localEP">The local <see cref="T:System.Net.EndPoint" /> to associate with the <see cref="T:System.Net.Sockets.Socket" />. </param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="localEP" /> is null. </exception>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation. </exception>
|
|
<PermissionSet>
|
|
<IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Net.SocketPermission, System, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
</PermissionSet>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.CancelConnectAsync(System.Net.Sockets.SocketAsyncEventArgs)">
|
|
<summary>Cancels an asynchronous request for a remote host connection.</summary>
|
|
<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>
|
|
<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>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. </exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation.</exception>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.ConnectAsync(System.Net.Sockets.SocketAsyncEventArgs)">
|
|
<summary>Begins an asynchronous request for a connection to a remote host.</summary>
|
|
<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>
|
|
<param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information.</exception>
|
|
<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>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation.</exception>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.ConnectAsync(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.Net.Sockets.SocketAsyncEventArgs)">
|
|
<summary>Begins an asynchronous request for a connection to a remote host.</summary>
|
|
<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>
|
|
<param name="socketType">One of the <see cref="T:System.Net.Sockets.SocketType" /> values.</param>
|
|
<param name="protocolType">One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values.</param>
|
|
<param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information.</exception>
|
|
<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>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation.</exception>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.Connected">
|
|
<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>
|
|
<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>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.Dispose">
|
|
<summary>Releases all resources used by the current instance of the <see cref="T:System.Net.Sockets.Socket" /> class.</summary>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.Dispose(System.Boolean)">
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:System.Net.Sockets.Socket" />, and optionally disposes of the managed resources.</summary>
|
|
<param name="disposing">true to release both managed and unmanaged resources; false to releases only unmanaged resources. </param>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.Finalize">
|
|
<summary>Frees resources used by the <see cref="T:System.Net.Sockets.Socket" /> class.</summary>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.Listen(System.Int32)">
|
|
<summary>Places a <see cref="T:System.Net.Sockets.Socket" /> in a listening state.</summary>
|
|
<param name="backlog">The maximum length of the pending connections queue. </param>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<PermissionSet>
|
|
<IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
|
|
</PermissionSet>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.LocalEndPoint">
|
|
<summary>Gets the local endpoint.</summary>
|
|
<returns>The <see cref="T:System.Net.EndPoint" /> that the <see cref="T:System.Net.Sockets.Socket" /> is using for communications.</returns>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<PermissionSet>
|
|
<IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
|
|
</PermissionSet>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.NoDelay">
|
|
<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>
|
|
<returns>false if the <see cref="T:System.Net.Sockets.Socket" /> uses the Nagle algorithm; otherwise, true. The default is false.</returns>
|
|
<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>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<PermissionSet>
|
|
<IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
</PermissionSet>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.OSSupportsIPv4">
|
|
<summary>Indicates whether the underlying operating system and network adaptors support Internet Protocol version 4 (IPv4).</summary>
|
|
<returns>true if the operating system and network adaptors support the IPv4 protocol; otherwise, false.</returns>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.OSSupportsIPv6">
|
|
<summary>Indicates whether the underlying operating system and network adaptors support Internet Protocol version 6 (IPv6).</summary>
|
|
<returns>true if the operating system and network adaptors support the IPv6 protocol; otherwise, false.</returns>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.ProtocolType">
|
|
<summary>Gets the protocol type of the <see cref="T:System.Net.Sockets.Socket" />.</summary>
|
|
<returns>One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values.</returns>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.ReceiveAsync(System.Net.Sockets.SocketAsyncEventArgs)">
|
|
<summary>Begins an asynchronous request to receive data from a connected <see cref="T:System.Net.Sockets.Socket" /> object.</summary>
|
|
<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>
|
|
<param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
|
|
<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>
|
|
<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>
|
|
<exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.ReceiveBufferSize">
|
|
<summary>Gets or sets a value that specifies the size of the receive buffer of the <see cref="T:System.Net.Sockets.Socket" />.</summary>
|
|
<returns>An <see cref="T:System.Int32" /> that contains the size, in bytes, of the receive buffer. The default is 8192.</returns>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation is less than 0.</exception>
|
|
<PermissionSet>
|
|
<IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
</PermissionSet>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.ReceiveFromAsync(System.Net.Sockets.SocketAsyncEventArgs)">
|
|
<summary>Begins to asynchronously receive data from a specified network device.</summary>
|
|
<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>
|
|
<param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
|
|
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> cannot be null.</exception>
|
|
<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>
|
|
<exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. </exception>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.RemoteEndPoint">
|
|
<summary>Gets the remote endpoint.</summary>
|
|
<returns>The <see cref="T:System.Net.EndPoint" /> with which the <see cref="T:System.Net.Sockets.Socket" /> is communicating.</returns>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<PermissionSet>
|
|
<IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
|
|
</PermissionSet>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.SendAsync(System.Net.Sockets.SocketAsyncEventArgs)">
|
|
<summary>Sends data asynchronously to a connected <see cref="T:System.Net.Sockets.Socket" /> object.</summary>
|
|
<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>
|
|
<param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
|
|
<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>
|
|
<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>
|
|
<exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<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>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.SendBufferSize">
|
|
<summary>Gets or sets a value that specifies the size of the send buffer of the <see cref="T:System.Net.Sockets.Socket" />.</summary>
|
|
<returns>An <see cref="T:System.Int32" /> that contains the size, in bytes, of the send buffer. The default is 8192.</returns>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation is less than 0.</exception>
|
|
<PermissionSet>
|
|
<IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
</PermissionSet>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.SendToAsync(System.Net.Sockets.SocketAsyncEventArgs)">
|
|
<summary>Sends data asynchronously to a specific remote host.</summary>
|
|
<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>
|
|
<param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
|
|
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> cannot be null.</exception>
|
|
<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>
|
|
<exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<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>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)">
|
|
<summary>Disables sends and receives on a <see cref="T:System.Net.Sockets.Socket" />.</summary>
|
|
<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>
|
|
<exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. See the Remarks section for more information. </exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<PermissionSet>
|
|
<IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
|
|
</PermissionSet>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.Socket.Ttl">
|
|
<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>
|
|
<returns>The TTL value.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The TTL value can't be set to a negative number.</exception>
|
|
<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>
|
|
<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>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
|
|
<PermissionSet>
|
|
<IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
<IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
|
|
</PermissionSet>
|
|
</member>
|
|
<member name="T:System.Net.Sockets.SocketAsyncEventArgs">
|
|
<summary>Represents an asynchronous socket operation.</summary>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.SocketAsyncEventArgs.#ctor">
|
|
<summary>Creates an empty <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> instance.</summary>
|
|
<exception cref="T:System.NotSupportedException">The platform is not supported. </exception>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.AcceptSocket">
|
|
<summary>Gets or sets the socket to use or the socket created for accepting a connection with an asynchronous socket method.</summary>
|
|
<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>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer">
|
|
<summary>Gets the data buffer to use with an asynchronous socket method.</summary>
|
|
<returns>A <see cref="T:System.Byte" /> array that represents the data buffer to use with an asynchronous socket method.</returns>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.BufferList">
|
|
<summary>Gets or sets an array of data buffers to use with an asynchronous socket method.</summary>
|
|
<returns>An <see cref="T:System.Collections.IList" /> that represents an array of data buffers to use with an asynchronous socket method.</returns>
|
|
<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>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.BytesTransferred">
|
|
<summary>Gets the number of bytes transferred in the socket operation.</summary>
|
|
<returns>An <see cref="T:System.Int32" /> that contains the number of bytes transferred in the socket operation.</returns>
|
|
</member>
|
|
<member name="E:System.Net.Sockets.SocketAsyncEventArgs.Completed">
|
|
<summary>The event used to complete an asynchronous operation.</summary>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.ConnectByNameError">
|
|
<summary>Gets the exception in the case of a connection failure when a <see cref="T:System.Net.DnsEndPoint" /> was used.</summary>
|
|
<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>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.ConnectSocket">
|
|
<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>
|
|
<returns>The connected <see cref="T:System.Net.Sockets.Socket" /> object.</returns>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.Count">
|
|
<summary>Gets the maximum amount of data, in bytes, to send or receive in an asynchronous operation.</summary>
|
|
<returns>An <see cref="T:System.Int32" /> that contains the maximum amount of data, in bytes, to send or receive.</returns>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.SocketAsyncEventArgs.Dispose">
|
|
<summary>Releases the unmanaged resources used by the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> instance and optionally disposes of the managed resources.</summary>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.SocketAsyncEventArgs.Finalize">
|
|
<summary>Frees resources used by the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> class.</summary>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.LastOperation">
|
|
<summary>Gets the type of socket operation most recently performed with this context object.</summary>
|
|
<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>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.Offset">
|
|
<summary>Gets the offset, in bytes, into the data buffer referenced by the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> property.</summary>
|
|
<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>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.SocketAsyncEventArgs.OnCompleted(System.Net.Sockets.SocketAsyncEventArgs)">
|
|
<summary>Represents a method that is called when an asynchronous operation completes.</summary>
|
|
<param name="e">The event that is signaled.</param>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint">
|
|
<summary>Gets or sets the remote IP endpoint for an asynchronous operation.</summary>
|
|
<returns>An <see cref="T:System.Net.EndPoint" /> that represents the remote IP endpoint for an asynchronous operation.</returns>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.SocketAsyncEventArgs.SetBuffer(System.Byte[],System.Int32,System.Int32)">
|
|
<summary>Sets the data buffer to use with an asynchronous socket method.</summary>
|
|
<param name="buffer">The data buffer to use with an asynchronous socket method.</param>
|
|
<param name="offset">The offset, in bytes, in the data buffer where the operation starts.</param>
|
|
<param name="count">The maximum amount of data, in bytes, to send or receive in the buffer.</param>
|
|
<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>
|
|
<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>
|
|
</member>
|
|
<member name="M:System.Net.Sockets.SocketAsyncEventArgs.SetBuffer(System.Int32,System.Int32)">
|
|
<summary>Sets the data buffer to use with an asynchronous socket method.</summary>
|
|
<param name="offset">The offset, in bytes, in the data buffer where the operation starts.</param>
|
|
<param name="count">The maximum amount of data, in bytes, to send or receive in the buffer.</param>
|
|
<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>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.SocketError">
|
|
<summary>Gets or sets the result of the asynchronous socket operation.</summary>
|
|
<returns>A <see cref="T:System.Net.Sockets.SocketError" /> that represents the result of the asynchronous socket operation.</returns>
|
|
</member>
|
|
<member name="P:System.Net.Sockets.SocketAsyncEventArgs.UserToken">
|
|
<summary>Gets or sets a user or application object associated with this asynchronous socket operation.</summary>
|
|
<returns>An object that represents the user or application object associated with this asynchronous socket operation.</returns>
|
|
</member>
|
|
<member name="T:System.Net.Sockets.SocketAsyncOperation">
|
|
<summary>The type of asynchronous socket operation most recently performed with this context object.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketAsyncOperation.Accept">
|
|
<summary>A socket Accept operation. </summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketAsyncOperation.Connect">
|
|
<summary>A socket Connect operation.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketAsyncOperation.None">
|
|
<summary>None of the socket operations.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketAsyncOperation.Receive">
|
|
<summary>A socket Receive operation.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketAsyncOperation.ReceiveFrom">
|
|
<summary>A socket ReceiveFrom operation.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketAsyncOperation.Send">
|
|
<summary>A socket Send operation.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketAsyncOperation.SendTo">
|
|
<summary>A socket SendTo operation.</summary>
|
|
</member>
|
|
<member name="T:System.Net.Sockets.SocketShutdown">
|
|
<summary>Defines constants that are used by the <see cref="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)" /> method.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketShutdown.Both">
|
|
<summary>Disables a <see cref="T:System.Net.Sockets.Socket" /> for both sending and receiving. This field is constant.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketShutdown.Receive">
|
|
<summary>Disables a <see cref="T:System.Net.Sockets.Socket" /> for receiving. This field is constant.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketShutdown.Send">
|
|
<summary>Disables a <see cref="T:System.Net.Sockets.Socket" /> for sending. This field is constant.</summary>
|
|
</member>
|
|
<member name="T:System.Net.Sockets.SocketType">
|
|
<summary>Specifies the type of socket that an instance of the <see cref="T:System.Net.Sockets.Socket" /> class represents.</summary>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketType.Dgram">
|
|
<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>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketType.Stream">
|
|
<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>
|
|
</member>
|
|
<member name="F:System.Net.Sockets.SocketType.Unknown">
|
|
<summary>Specifies an unknown Socket type.</summary>
|
|
</member>
|
|
</members>
|
|
</doc> |