From b5c87084afaef42b2d058f68091be31988a6a874 Mon Sep 17 00:00:00 2001 From: DongHun Kwak Date: Wed, 13 Sep 2017 11:08:07 +0900 Subject: Imported Upstream version 1.64.0 Change-Id: Id9212edd016dd55f21172c427aa7894d1d24148b Signed-off-by: DongHun Kwak --- .../basic_seq_packet_socket/cancel/overload1.html | 113 ++++++++++++++++++++ .../basic_seq_packet_socket/cancel/overload2.html | 114 +++++++++++++++++++++ 2 files changed, 227 insertions(+) create mode 100644 doc/html/boost_asio/reference/basic_seq_packet_socket/cancel/overload1.html create mode 100644 doc/html/boost_asio/reference/basic_seq_packet_socket/cancel/overload2.html (limited to 'doc/html/boost_asio/reference/basic_seq_packet_socket/cancel') diff --git a/doc/html/boost_asio/reference/basic_seq_packet_socket/cancel/overload1.html b/doc/html/boost_asio/reference/basic_seq_packet_socket/cancel/overload1.html new file mode 100644 index 0000000000..f04c017973 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_seq_packet_socket/cancel/overload1.html @@ -0,0 +1,113 @@ + + + +basic_seq_packet_socket::cancel (1 of 2 overloads) + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Cancel all asynchronous operations associated with the socket. +

+
void cancel();
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the boost::asio::error::operation_aborted + error. +

+
+ + Exceptions +
+
+

+
+
boost::system::system_error
+

+ Thrown on failure. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with boost::asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless BOOST_ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining BOOST_ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+ + + +
Copyright © 2003-2017 Christopher M. Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/doc/html/boost_asio/reference/basic_seq_packet_socket/cancel/overload2.html b/doc/html/boost_asio/reference/basic_seq_packet_socket/cancel/overload2.html new file mode 100644 index 0000000000..fc28fd4fcf --- /dev/null +++ b/doc/html/boost_asio/reference/basic_seq_packet_socket/cancel/overload2.html @@ -0,0 +1,114 @@ + + + +basic_seq_packet_socket::cancel (2 of 2 overloads) + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+

+ Inherited from basic_socket. +

+

+ Cancel all asynchronous operations associated with the socket. +

+
boost::system::error_code cancel(
+    boost::system::error_code & ec);
+
+

+ This function causes all outstanding asynchronous connect, send and receive + operations to finish immediately, and the handlers for cancelled operations + will be passed the boost::asio::error::operation_aborted + error. +

+
+ + Parameters +
+
+

+
+
ec
+

+ Set to indicate what error occurred, if any. +

+
+
+
+ + Remarks +
+

+ Calls to cancel() + will always fail with boost::asio::error::operation_not_supported + when run on Windows XP, Windows Server 2003, and earlier versions of + Windows, unless BOOST_ASIO_ENABLE_CANCELIO is defined. However, the CancelIo + function has two issues that should be considered before enabling its + use: +

+
    +
  • + It will only cancel asynchronous operations that were initiated in + the current thread. +
    • +
  • + It can appear to complete without error, but the request to cancel + the unfinished operations may be silently ignored by the operating + system. Whether it works or not seems to depend on the drivers that + are installed. +
    • +
+

+ For portable cancellation, consider using one of the following alternatives: +

+
    +
  • + Disable asio's I/O completion port backend by defining BOOST_ASIO_DISABLE_IOCP. +
    • +
  • + Use the close() + function to simultaneously cancel the outstanding operations and + close the socket. +
    • +
+

+ When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx + function is always used. This function does not have the problems described + above. +

+
+ + + +
Copyright © 2003-2017 Christopher M. Kohlhoff

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + -- cgit v1.2.3