You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

392 lines
45 KiB

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Net.Sockets</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Net.Sockets.ProtocolType">
  8. <summary>Specifies the protocols that the <see cref="T:System.Net.Sockets.Socket" /> class supports.</summary>
  9. </member>
  10. <member name="F:System.Net.Sockets.ProtocolType.Tcp">
  11. <summary>Transmission Control Protocol.</summary>
  12. </member>
  13. <member name="F:System.Net.Sockets.ProtocolType.Udp">
  14. <summary>User Datagram Protocol.</summary>
  15. </member>
  16. <member name="F:System.Net.Sockets.ProtocolType.Unknown">
  17. <summary>Unknown protocol.</summary>
  18. </member>
  19. <member name="F:System.Net.Sockets.ProtocolType.Unspecified">
  20. <summary>Unspecified protocol.</summary>
  21. </member>
  22. <member name="T:System.Net.Sockets.Socket">
  23. <summary>Implements the Berkeley sockets interface.</summary>
  24. </member>
  25. <member name="M:System.Net.Sockets.Socket.#ctor(System.Net.Sockets.AddressFamily,System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType)">
  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>
  27. <param name="addressFamily">One of the <see cref="T:System.Net.Sockets.AddressFamily" /> values. </param>
  28. <param name="socketType">One of the <see cref="T:System.Net.Sockets.SocketType" /> values. </param>
  29. <param name="protocolType">One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values. </param>
  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>
  31. </member>
  32. <member name="M:System.Net.Sockets.Socket.#ctor(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType)">
  33. <summary>Initializes a new instance of the <see cref="T:System.Net.Sockets.Socket" /> class using the specified socket type and protocol.</summary>
  34. <param name="socketType">One of the <see cref="T:System.Net.Sockets.SocketType" /> values.</param>
  35. <param name="protocolType">One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values.</param>
  36. <exception cref="T:System.Net.Sockets.SocketException">The combination of <paramref name="socketType" /> and <paramref name="protocolType" /> results in an invalid socket. </exception>
  37. </member>
  38. <member name="M:System.Net.Sockets.Socket.AcceptAsync(System.Net.Sockets.SocketAsyncEventArgs)">
  39. <summary>Begins an asynchronous operation to accept an incoming connection attempt.</summary>
  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>
  41. <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
  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>
  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>
  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>
  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>
  46. <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>
  47. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  48. </member>
  49. <member name="P:System.Net.Sockets.Socket.AddressFamily">
  50. <summary>Gets the address family of the <see cref="T:System.Net.Sockets.Socket" />.</summary>
  51. <returns>One of the <see cref="T:System.Net.Sockets.AddressFamily" /> values.</returns>
  52. </member>
  53. <member name="M:System.Net.Sockets.Socket.Bind(System.Net.EndPoint)">
  54. <summary>Associates a <see cref="T:System.Net.Sockets.Socket" /> with a local endpoint.</summary>
  55. <param name="localEP">The local <see cref="T:System.Net.EndPoint" /> to associate with the <see cref="T:System.Net.Sockets.Socket" />. </param>
  56. <exception cref="T:System.ArgumentNullException">
  57. <paramref name="localEP" /> is null. </exception>
  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>
  59. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  60. <exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation. </exception>
  61. <PermissionSet>
  62. <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  63. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  64. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  65. <IPermission class="System.Net.SocketPermission, System, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  66. </PermissionSet>
  67. </member>
  68. <member name="M:System.Net.Sockets.Socket.CancelConnectAsync(System.Net.Sockets.SocketAsyncEventArgs)">
  69. <summary>Cancels an asynchronous request for a remote host connection.</summary>
  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>
  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>
  72. <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. </exception>
  73. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  74. <exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation.</exception>
  75. </member>
  76. <member name="M:System.Net.Sockets.Socket.ConnectAsync(System.Net.Sockets.SocketAsyncEventArgs)">
  77. <summary>Begins an asynchronous request for a connection to a remote host.</summary>
  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>
  79. <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
  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>
  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>
  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>
  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>
  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>
  85. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  86. <exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation.</exception>
  87. </member>
  88. <member name="M:System.Net.Sockets.Socket.ConnectAsync(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.Net.Sockets.SocketAsyncEventArgs)">
  89. <summary>Begins an asynchronous request for a connection to a remote host.</summary>
  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>
  91. <param name="socketType">One of the <see cref="T:System.Net.Sockets.SocketType" /> values.</param>
  92. <param name="protocolType">One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values.</param>
  93. <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
  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>
  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>
  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>
  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>
  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>
  99. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  100. <exception cref="T:System.Security.SecurityException">A caller higher in the call stack does not have permission for the requested operation.</exception>
  101. </member>
  102. <member name="P:System.Net.Sockets.Socket.Connected">
  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>
  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>
  105. </member>
  106. <member name="M:System.Net.Sockets.Socket.Dispose">
  107. <summary>Releases all resources used by the current instance of the <see cref="T:System.Net.Sockets.Socket" /> class.</summary>
  108. </member>
  109. <member name="M:System.Net.Sockets.Socket.Dispose(System.Boolean)">
  110. <summary>Releases the unmanaged resources used by the <see cref="T:System.Net.Sockets.Socket" />, and optionally disposes of the managed resources.</summary>
  111. <param name="disposing">true to release both managed and unmanaged resources; false to releases only unmanaged resources. </param>
  112. </member>
  113. <member name="M:System.Net.Sockets.Socket.Finalize">
  114. <summary>Frees resources used by the <see cref="T:System.Net.Sockets.Socket" /> class.</summary>
  115. </member>
  116. <member name="M:System.Net.Sockets.Socket.Listen(System.Int32)">
  117. <summary>Places a <see cref="T:System.Net.Sockets.Socket" /> in a listening state.</summary>
  118. <param name="backlog">The maximum length of the pending connections queue. </param>
  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>
  120. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  121. <PermissionSet>
  122. <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  123. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  124. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  125. </PermissionSet>
  126. </member>
  127. <member name="P:System.Net.Sockets.Socket.LocalEndPoint">
  128. <summary>Gets the local endpoint.</summary>
  129. <returns>The <see cref="T:System.Net.EndPoint" /> that the <see cref="T:System.Net.Sockets.Socket" /> is using for communications.</returns>
  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>
  131. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  132. <PermissionSet>
  133. <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  134. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  135. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  136. </PermissionSet>
  137. </member>
  138. <member name="P:System.Net.Sockets.Socket.NoDelay">
  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>
  140. <returns>false if the <see cref="T:System.Net.Sockets.Socket" /> uses the Nagle algorithm; otherwise, true. The default is false.</returns>
  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>
  142. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  143. <PermissionSet>
  144. <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  145. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  146. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  147. </PermissionSet>
  148. </member>
  149. <member name="P:System.Net.Sockets.Socket.OSSupportsIPv4">
  150. <summary>Indicates whether the underlying operating system and network adaptors support Internet Protocol version 4 (IPv4).</summary>
  151. <returns>true if the operating system and network adaptors support the IPv4 protocol; otherwise, false.</returns>
  152. </member>
  153. <member name="P:System.Net.Sockets.Socket.OSSupportsIPv6">
  154. <summary>Indicates whether the underlying operating system and network adaptors support Internet Protocol version 6 (IPv6).</summary>
  155. <returns>true if the operating system and network adaptors support the IPv6 protocol; otherwise, false.</returns>
  156. </member>
  157. <member name="P:System.Net.Sockets.Socket.ProtocolType">
  158. <summary>Gets the protocol type of the <see cref="T:System.Net.Sockets.Socket" />.</summary>
  159. <returns>One of the <see cref="T:System.Net.Sockets.ProtocolType" /> values.</returns>
  160. </member>
  161. <member name="M:System.Net.Sockets.Socket.ReceiveAsync(System.Net.Sockets.SocketAsyncEventArgs)">
  162. <summary>Begins an asynchronous request to receive data from a connected <see cref="T:System.Net.Sockets.Socket" /> object.</summary>
  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>
  164. <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
  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>
  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>
  167. <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>
  168. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  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>
  170. </member>
  171. <member name="P:System.Net.Sockets.Socket.ReceiveBufferSize">
  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>
  173. <returns>An <see cref="T:System.Int32" /> that contains the size, in bytes, of the receive buffer. The default is 8192.</returns>
  174. <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket.</exception>
  175. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  176. <exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation is less than 0.</exception>
  177. <PermissionSet>
  178. <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  179. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  180. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  181. </PermissionSet>
  182. </member>
  183. <member name="M:System.Net.Sockets.Socket.ReceiveFromAsync(System.Net.Sockets.SocketAsyncEventArgs)">
  184. <summary>Begins to asynchronously receive data from a specified network device.</summary>
  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>
  186. <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
  187. <exception cref="T:System.ArgumentNullException">The <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> cannot be null.</exception>
  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>
  189. <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>
  190. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  191. <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket. </exception>
  192. </member>
  193. <member name="P:System.Net.Sockets.Socket.RemoteEndPoint">
  194. <summary>Gets the remote endpoint.</summary>
  195. <returns>The <see cref="T:System.Net.EndPoint" /> with which the <see cref="T:System.Net.Sockets.Socket" /> is communicating.</returns>
  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>
  197. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  198. <PermissionSet>
  199. <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  200. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  201. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  202. </PermissionSet>
  203. </member>
  204. <member name="M:System.Net.Sockets.Socket.SendAsync(System.Net.Sockets.SocketAsyncEventArgs)">
  205. <summary>Sends data asynchronously to a connected <see cref="T:System.Net.Sockets.Socket" /> object.</summary>
  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>
  207. <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
  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>
  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>
  210. <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>
  211. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  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>
  213. </member>
  214. <member name="P:System.Net.Sockets.Socket.SendBufferSize">
  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>
  216. <returns>An <see cref="T:System.Int32" /> that contains the size, in bytes, of the send buffer. The default is 8192.</returns>
  217. <exception cref="T:System.Net.Sockets.SocketException">An error occurred when attempting to access the socket.</exception>
  218. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  219. <exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation is less than 0.</exception>
  220. <PermissionSet>
  221. <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  222. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  223. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  224. </PermissionSet>
  225. </member>
  226. <member name="M:System.Net.Sockets.Socket.SendToAsync(System.Net.Sockets.SocketAsyncEventArgs)">
  227. <summary>Sends data asynchronously to a specific remote host.</summary>
  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>
  229. <param name="e">The <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> object to use for this asynchronous socket operation.</param>
  230. <exception cref="T:System.ArgumentNullException">The <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint" /> cannot be null.</exception>
  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>
  232. <exception cref="T:System.NotSupportedException">Windows XP or later is required for this method.</exception>
  233. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  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>
  235. </member>
  236. <member name="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)">
  237. <summary>Disables sends and receives on a <see cref="T:System.Net.Sockets.Socket" />.</summary>
  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>
  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>
  240. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  241. <PermissionSet>
  242. <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  243. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  244. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="UnmanagedCode, ControlEvidence" />
  245. </PermissionSet>
  246. </member>
  247. <member name="P:System.Net.Sockets.Socket.Ttl">
  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>
  249. <returns>The TTL value.</returns>
  250. <exception cref="T:System.ArgumentOutOfRangeException">The TTL value can't be set to a negative number.</exception>
  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>
  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>
  253. <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.Sockets.Socket" /> has been closed. </exception>
  254. <PermissionSet>
  255. <IPermission class="System.Security.Permissions.EnvironmentPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  256. <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  257. <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" />
  258. </PermissionSet>
  259. </member>
  260. <member name="T:System.Net.Sockets.SocketAsyncEventArgs">
  261. <summary>Represents an asynchronous socket operation.</summary>
  262. </member>
  263. <member name="M:System.Net.Sockets.SocketAsyncEventArgs.#ctor">
  264. <summary>Creates an empty <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> instance.</summary>
  265. <exception cref="T:System.NotSupportedException">The platform is not supported. </exception>
  266. </member>
  267. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.AcceptSocket">
  268. <summary>Gets or sets the socket to use or the socket created for accepting a connection with an asynchronous socket method.</summary>
  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>
  270. </member>
  271. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer">
  272. <summary>Gets the data buffer to use with an asynchronous socket method.</summary>
  273. <returns>A <see cref="T:System.Byte" /> array that represents the data buffer to use with an asynchronous socket method.</returns>
  274. </member>
  275. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.BufferList">
  276. <summary>Gets or sets an array of data buffers to use with an asynchronous socket method.</summary>
  277. <returns>An <see cref="T:System.Collections.IList" /> that represents an array of data buffers to use with an asynchronous socket method.</returns>
  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>
  279. </member>
  280. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.BytesTransferred">
  281. <summary>Gets the number of bytes transferred in the socket operation.</summary>
  282. <returns>An <see cref="T:System.Int32" /> that contains the number of bytes transferred in the socket operation.</returns>
  283. </member>
  284. <member name="E:System.Net.Sockets.SocketAsyncEventArgs.Completed">
  285. <summary>The event used to complete an asynchronous operation.</summary>
  286. </member>
  287. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.ConnectByNameError">
  288. <summary>Gets the exception in the case of a connection failure when a <see cref="T:System.Net.DnsEndPoint" /> was used.</summary>
  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>
  290. </member>
  291. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.ConnectSocket">
  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>
  293. <returns>The connected <see cref="T:System.Net.Sockets.Socket" /> object.</returns>
  294. </member>
  295. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.Count">
  296. <summary>Gets the maximum amount of data, in bytes, to send or receive in an asynchronous operation.</summary>
  297. <returns>An <see cref="T:System.Int32" /> that contains the maximum amount of data, in bytes, to send or receive.</returns>
  298. </member>
  299. <member name="M:System.Net.Sockets.SocketAsyncEventArgs.Dispose">
  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>
  301. </member>
  302. <member name="M:System.Net.Sockets.SocketAsyncEventArgs.Finalize">
  303. <summary>Frees resources used by the <see cref="T:System.Net.Sockets.SocketAsyncEventArgs" /> class.</summary>
  304. </member>
  305. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.LastOperation">
  306. <summary>Gets the type of socket operation most recently performed with this context object.</summary>
  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>
  308. </member>
  309. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.Offset">
  310. <summary>Gets the offset, in bytes, into the data buffer referenced by the <see cref="P:System.Net.Sockets.SocketAsyncEventArgs.Buffer" /> property.</summary>
  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>
  312. </member>
  313. <member name="M:System.Net.Sockets.SocketAsyncEventArgs.OnCompleted(System.Net.Sockets.SocketAsyncEventArgs)">
  314. <summary>Represents a method that is called when an asynchronous operation completes.</summary>
  315. <param name="e">The event that is signaled.</param>
  316. </member>
  317. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.RemoteEndPoint">
  318. <summary>Gets or sets the remote IP endpoint for an asynchronous operation.</summary>
  319. <returns>An <see cref="T:System.Net.EndPoint" /> that represents the remote IP endpoint for an asynchronous operation.</returns>
  320. </member>
  321. <member name="M:System.Net.Sockets.SocketAsyncEventArgs.SetBuffer(System.Byte[],System.Int32,System.Int32)">
  322. <summary>Sets the data buffer to use with an asynchronous socket method.</summary>
  323. <param name="buffer">The data buffer to use with an asynchronous socket method.</param>
  324. <param name="offset">The offset, in bytes, in the data buffer where the operation starts.</param>
  325. <param name="count">The maximum amount of data, in bytes, to send or receive in the buffer.</param>
  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>
  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>
  328. </member>
  329. <member name="M:System.Net.Sockets.SocketAsyncEventArgs.SetBuffer(System.Int32,System.Int32)">
  330. <summary>Sets the data buffer to use with an asynchronous socket method.</summary>
  331. <param name="offset">The offset, in bytes, in the data buffer where the operation starts.</param>
  332. <param name="count">The maximum amount of data, in bytes, to send or receive in the buffer.</param>
  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>
  334. </member>
  335. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.SocketError">
  336. <summary>Gets or sets the result of the asynchronous socket operation.</summary>
  337. <returns>A <see cref="T:System.Net.Sockets.SocketError" /> that represents the result of the asynchronous socket operation.</returns>
  338. </member>
  339. <member name="P:System.Net.Sockets.SocketAsyncEventArgs.UserToken">
  340. <summary>Gets or sets a user or application object associated with this asynchronous socket operation.</summary>
  341. <returns>An object that represents the user or application object associated with this asynchronous socket operation.</returns>
  342. </member>
  343. <member name="T:System.Net.Sockets.SocketAsyncOperation">
  344. <summary>The type of asynchronous socket operation most recently performed with this context object.</summary>
  345. </member>
  346. <member name="F:System.Net.Sockets.SocketAsyncOperation.Accept">
  347. <summary>A socket Accept operation. </summary>
  348. </member>
  349. <member name="F:System.Net.Sockets.SocketAsyncOperation.Connect">
  350. <summary>A socket Connect operation.</summary>
  351. </member>
  352. <member name="F:System.Net.Sockets.SocketAsyncOperation.None">
  353. <summary>None of the socket operations.</summary>
  354. </member>
  355. <member name="F:System.Net.Sockets.SocketAsyncOperation.Receive">
  356. <summary>A socket Receive operation.</summary>
  357. </member>
  358. <member name="F:System.Net.Sockets.SocketAsyncOperation.ReceiveFrom">
  359. <summary>A socket ReceiveFrom operation.</summary>
  360. </member>
  361. <member name="F:System.Net.Sockets.SocketAsyncOperation.Send">
  362. <summary>A socket Send operation.</summary>
  363. </member>
  364. <member name="F:System.Net.Sockets.SocketAsyncOperation.SendTo">
  365. <summary>A socket SendTo operation.</summary>
  366. </member>
  367. <member name="T:System.Net.Sockets.SocketShutdown">
  368. <summary>Defines constants that are used by the <see cref="M:System.Net.Sockets.Socket.Shutdown(System.Net.Sockets.SocketShutdown)" /> method.</summary>
  369. </member>
  370. <member name="F:System.Net.Sockets.SocketShutdown.Both">
  371. <summary>Disables a <see cref="T:System.Net.Sockets.Socket" /> for both sending and receiving. This field is constant.</summary>
  372. </member>
  373. <member name="F:System.Net.Sockets.SocketShutdown.Receive">
  374. <summary>Disables a <see cref="T:System.Net.Sockets.Socket" /> for receiving. This field is constant.</summary>
  375. </member>
  376. <member name="F:System.Net.Sockets.SocketShutdown.Send">
  377. <summary>Disables a <see cref="T:System.Net.Sockets.Socket" /> for sending. This field is constant.</summary>
  378. </member>
  379. <member name="T:System.Net.Sockets.SocketType">
  380. <summary>Specifies the type of socket that an instance of the <see cref="T:System.Net.Sockets.Socket" /> class represents.</summary>
  381. </member>
  382. <member name="F:System.Net.Sockets.SocketType.Dgram">
  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>
  384. </member>
  385. <member name="F:System.Net.Sockets.SocketType.Stream">
  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>
  387. </member>
  388. <member name="F:System.Net.Sockets.SocketType.Unknown">
  389. <summary>Specifies an unknown Socket type.</summary>
  390. </member>
  391. </members>
  392. </doc>