boost/asio
2
0
Fork 0
mirror of https://github.com/boostorg/asio.git synced 2026-01-19 16:12:09 +00:00
Code Issues Projects Releases Wiki Activity
2,376 Commits 51 Branches 106 Tags
develop
Commit Graph

30 Commits

Author SHA1 Message Date
Christopher Kohlhoff
b87a07f2cc Update doc generation config. 2025-11-05 20:43:18 +11:00
Christopher Kohlhoff
a96885268f Add documentation note on basic_signal_set's async signal safety. 2025-08-06 22:16:18 +10:00
Christopher Kohlhoff
b0fe7b2df8 Add disposition requirements to the documentation. 2024-10-31 20:31:20 +11:00
Christopher Kohlhoff
61e848d080 Mark constexpr global variables as inline. 2024-08-06 23:23:39 +10:00
Christopher Kohlhoff
da99786534 Update for newer doxygen. 2023-11-09 00:49:42 +11:00
Christopher Kohlhoff
0d4342efa0 Add new macro to doxygen configuration. 2023-04-05 19:34:42 +10:00
Christopher Kohlhoff
324a91fd0a Use deduced return types for all two-argument associator get functions. 2022-11-01 10:44:37 +11:00
Christopher Kohlhoff
756f67fab8 Use a trailing return type with decltype on initiating functions for C++11. 2022-06-30 00:43:16 +10:00
Christopher Kohlhoff
7162c9675d Rework reference documentation in terms of completion tokens. 2022-03-02 22:13:21 +11:00
Christopher Kohlhoff
08e0d07593 Ensure BOOST_ASIO_EXECUTION_EXECUTOR macro does not appear in generated docs. 2021-11-17 08:41:09 +11:00
Christopher Kohlhoff
0cc4c7093a Clean up doc generation to accommodate new features. 2021-07-07 22:47:10 +10:00
Christopher Kohlhoff
06213e7378 Tell doxygen about the BOOST_ASIO_NOEXCEPT_IF macro. 2021-04-06 19:22:20 +10:00
Christopher Kohlhoff
311d355ab4 Add experimental::as_single completion token adapter. 
The as_single completion token adapter can be used to specify that the
completion handler arguments should be combined into a single argument.
For completion signatures with a single parameter, the argument is
passed through as-is. For signatures with two or more parameters, the
arguments are combined into a tuple.

The as_single adapter may be used in conjunction with use_awaitable and
structured bindings as follows:

    auto [e, n] = co_await socket.async_read_some(
        boost::asio::buffer(data), as_single(use_awaitable));

Alternatively, it may be used as a default completion token like so:

    using default_token = as_single_t<use_awaitable_t<>>;
    using tcp_socket = default_token::as_default_on_t<tcp::socket>;
    // ...
    awaitable<void> do_read(tcp_socket socket)
    {
      // ...
      auto [e, n] = co_await socket.async_read_some(boost::asio::buffer(data));
      // ...
    }
 2020-11-02 14:03:09 +11:00
Christopher Kohlhoff
87d0d486f2 Documentation generation tweaks. 2020-07-27 09:34:51 +10:00
Christopher Kohlhoff
365661a7e3 More documentation generation tweaks for new execution facilities. 2020-07-06 23:53:55 +10:00
Christopher Kohlhoff
c55037795c Documentation generation tweaks for new execution facilities. 2020-06-23 11:08:25 +10:00
Christopher Kohlhoff
81dc9a91c2 Documentation for default completion tokens. 2019-12-04 23:40:58 +11:00
Christopher Kohlhoff
95041862ae Remove experimental directory from documentation processing. 2019-03-06 20:22:23 +11:00
Christopher Kohlhoff
4d7a656b66 Add experimental features to documentation. 2018-03-04 23:09:04 +11:00
Christopher Kohlhoff
0613d396ff Add new macros to doxygen configuration. 2017-10-24 07:32:54 +11:00
Christopher Kohlhoff
5aa758b54a Ignore new macro when generating documentation. 2017-03-08 07:10:48 +11:00
Christopher Kohlhoff
91fce6c711 Regenerate documentation. 
[SVN r85801]
 2013-09-20 12:10:45 +00:00
Christopher Kohlhoff
a05bbf3a53 Regenerate documentation. 
[SVN r84494]
 2013-05-25 13:03:48 +00:00
Christopher Kohlhoff
be0221203a Add new traits classes, handler_type and async_result, that allow 
the customisation of the return type of an initiating function.


[SVN r84308]
 2013-05-16 23:26:04 +00:00
Christopher Kohlhoff
e5818e7994 Include the io_service::service class's private member functions in the documentation. 
[SVN r72406]
 2011-06-05 14:09:04 +00:00
Christopher Kohlhoff
2f5fcaf01c * Add documentation for new features. 
* Duration type should be signed in tick_count_timer example.

* Regenerate documentation.

* Make definition of BOOST_ASIO_MOVE_ARG and BOOST_ASIO_MOVE_CAST separate to
  the definition of BOOST_ASIO_HAS_MOVE, to allow the latter to be user-defined.


[SVN r72404]
 2011-06-05 13:29:41 +00:00
Christopher Kohlhoff
b3635001fa Fix generation for some links from tutorial to reference material. 
[SVN r47298]
 2008-07-10 23:05:26 +00:00
Christopher Kohlhoff
0d06a87088 Add UNIX domain sockets, POSIX stream-oriented descriptors and Windows 
stream-oriented handles to the reference documentation.


[SVN r44682]
 2008-04-21 06:15:17 +00:00
Christopher Kohlhoff
9f319db484 Clean up documentation. 
[SVN r40356]
 2007-10-23 13:31:12 +00:00
Christopher Kohlhoff
00690b50ed Add documentation. 
[SVN r36502]
 2006-12-24 08:35:08 +00:00