boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-07-30 12:57:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix async return values in docs

Browse Source
This commit is contained in:
Vinnie Falco
2017-05-23 15:50:15 -07:00
parent 24fd5ec8af
commit 600f6da5a3
5 changed files with 101 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -5,6 +5,7 @@ Version 44
* Require Boost 1.58.0 or later * Require Boost 1.58.0 or later
* Tidy up and make get_lowest_layer public * Tidy up and make get_lowest_layer public
* Use BOOST_STATIC_ASSERT * Use BOOST_STATIC_ASSERT
* Fix async return values in docs
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------

8
include/beast/core/buffered_read_stream.hpp
View File

@ -265,7 +265,11 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class MutableBufferSequence, class ReadHandler> template<class MutableBufferSequence, class ReadHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type<ReadHandler, void(error_code)> async_return_type<ReadHandler, void(error_code)>
#endif
async_read_some(MutableBufferSequence const& buffers, async_read_some(MutableBufferSequence const& buffers,
ReadHandler&& handler); ReadHandler&& handler);
@ -336,7 +340,11 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class ConstBufferSequence, class WriteHandler> template<class ConstBufferSequence, class WriteHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type<WriteHandler, void(error_code)> async_return_type<WriteHandler, void(error_code)>
#endif
async_write_some(ConstBufferSequence const& buffers, async_write_some(ConstBufferSequence const& buffers,
WriteHandler&& handler); WriteHandler&& handler);
}; };

12
include/beast/http/read.hpp
View File

@ -194,8 +194,12 @@ template<
class DynamicBuffer, class DynamicBuffer,
bool isRequest, bool isDirect, class Derived, bool isRequest, bool isDirect, class Derived,
class ReadHandler> class ReadHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
ReadHandler, void(error_code, std::size_t)> ReadHandler, void(error_code, std::size_t)>
#endif
async_read_some( async_read_some(
AsyncReadStream& stream, AsyncReadStream& stream,
DynamicBuffer& buffer, DynamicBuffer& buffer,
@ -344,8 +348,12 @@ template<
class DynamicBuffer, class DynamicBuffer,
bool isRequest, bool isDirect, class Derived, bool isRequest, bool isDirect, class Derived,
class ReadHandler> class ReadHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
ReadHandler, void(error_code)> ReadHandler, void(error_code)>
#endif
async_read( async_read(
AsyncReadStream& stream, AsyncReadStream& stream,
DynamicBuffer& buffer, DynamicBuffer& buffer,
@ -499,8 +507,12 @@ template<
class DynamicBuffer, class DynamicBuffer,
bool isRequest, class Body, class Fields, bool isRequest, class Body, class Fields,
class ReadHandler> class ReadHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
ReadHandler, void(error_code)> ReadHandler, void(error_code)>
#endif
async_read( async_read(
AsyncReadStream& stream, AsyncReadStream& stream,
DynamicBuffer& buffer, DynamicBuffer& buffer,

4
include/beast/http/write.hpp
View File

@ -121,8 +121,12 @@ write(SyncWriteStream& stream,
template<class AsyncWriteStream, template<class AsyncWriteStream,
bool isRequest, class Fields, bool isRequest, class Fields,
class WriteHandler> class WriteHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
WriteHandler, void(error_code)> WriteHandler, void(error_code)>
#endif
async_write(AsyncWriteStream& stream, async_write(AsyncWriteStream& stream,
header<isRequest, Fields> const& msg, header<isRequest, Fields> const& msg,
WriteHandler&& handler); WriteHandler&& handler);

76
include/beast/websocket/stream.hpp
View File

@ -965,8 +965,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class AcceptHandler> template<class AcceptHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
AcceptHandler, void(error_code)> AcceptHandler, void(error_code)>
#endif
async_accept(AcceptHandler&& handler); async_accept(AcceptHandler&& handler);
/** Start reading and responding to a WebSocket HTTP Upgrade request. /** Start reading and responding to a WebSocket HTTP Upgrade request.
@ -1020,8 +1024,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class ResponseDecorator, class AcceptHandler> template<class ResponseDecorator, class AcceptHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
AcceptHandler, void(error_code)> AcceptHandler, void(error_code)>
#endif
async_accept_ex(ResponseDecorator const& decorator, async_accept_ex(ResponseDecorator const& decorator,
AcceptHandler&& handler); AcceptHandler&& handler);
@ -1074,8 +1082,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class ConstBufferSequence, class AcceptHandler> template<class ConstBufferSequence, class AcceptHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
AcceptHandler, void(error_code)> AcceptHandler, void(error_code)>
#endif
async_accept(ConstBufferSequence const& buffers, async_accept(ConstBufferSequence const& buffers,
AcceptHandler&& handler); AcceptHandler&& handler);
@ -1138,8 +1150,12 @@ public:
*/ */
template<class ConstBufferSequence, template<class ConstBufferSequence,
class ResponseDecorator, class AcceptHandler> class ResponseDecorator, class AcceptHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
AcceptHandler, void(error_code)> AcceptHandler, void(error_code)>
#endif
async_accept_ex(ConstBufferSequence const& buffers, async_accept_ex(ConstBufferSequence const& buffers,
ResponseDecorator const& decorator, ResponseDecorator const& decorator,
AcceptHandler&& handler); AcceptHandler&& handler);
@ -1190,8 +1206,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class Fields, class AcceptHandler> template<class Fields, class AcceptHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
AcceptHandler, void(error_code)> AcceptHandler, void(error_code)>
#endif
async_accept(http::header<true, Fields> const& req, async_accept(http::header<true, Fields> const& req,
AcceptHandler&& handler); AcceptHandler&& handler);
@ -1251,8 +1271,12 @@ public:
*/ */
template<class Fields, template<class Fields,
class ResponseDecorator, class AcceptHandler> class ResponseDecorator, class AcceptHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
AcceptHandler, void(error_code)> AcceptHandler, void(error_code)>
#endif
async_accept_ex(http::header<true, Fields> const& req, async_accept_ex(http::header<true, Fields> const& req,
ResponseDecorator const& decorator, ResponseDecorator const& decorator,
AcceptHandler&& handler); AcceptHandler&& handler);
@ -1311,8 +1335,12 @@ public:
*/ */
template<class Fields, template<class Fields,
class ConstBufferSequence, class AcceptHandler> class ConstBufferSequence, class AcceptHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
AcceptHandler, void(error_code)> AcceptHandler, void(error_code)>
#endif
async_accept(http::header<true, Fields> const& req, async_accept(http::header<true, Fields> const& req,
ConstBufferSequence const& buffers, ConstBufferSequence const& buffers,
AcceptHandler&& handler); AcceptHandler&& handler);
@ -1380,8 +1408,12 @@ public:
*/ */
template<class Fields, class ConstBufferSequence, template<class Fields, class ConstBufferSequence,
class ResponseDecorator, class AcceptHandler> class ResponseDecorator, class AcceptHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
AcceptHandler, void(error_code)> AcceptHandler, void(error_code)>
#endif
async_accept_ex(http::header<true, Fields> const& req, async_accept_ex(http::header<true, Fields> const& req,
ConstBufferSequence const& buffers, ConstBufferSequence const& buffers,
ResponseDecorator const& decorator, ResponseDecorator const& decorator,
@ -1858,8 +1890,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class HandshakeHandler> template<class HandshakeHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
HandshakeHandler, void(error_code)> HandshakeHandler, void(error_code)>
#endif
async_handshake(string_view const& host, async_handshake(string_view const& host,
string_view const& target, string_view const& target,
HandshakeHandler&& handler); HandshakeHandler&& handler);
@ -1910,8 +1946,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class HandshakeHandler> template<class HandshakeHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
HandshakeHandler, void(error_code)> HandshakeHandler, void(error_code)>
#endif
async_handshake(response_type& res, async_handshake(response_type& res,
string_view const& host, string_view const& host,
string_view const& target, string_view const& target,
@ -1968,8 +2008,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class RequestDecorator, class HandshakeHandler> template<class RequestDecorator, class HandshakeHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
HandshakeHandler, void(error_code)> HandshakeHandler, void(error_code)>
#endif
async_handshake_ex(string_view const& host, async_handshake_ex(string_view const& host,
string_view const& target, string_view const& target,
RequestDecorator const& decorator, RequestDecorator const& decorator,
@ -2030,8 +2074,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class RequestDecorator, class HandshakeHandler> template<class RequestDecorator, class HandshakeHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
HandshakeHandler, void(error_code)> HandshakeHandler, void(error_code)>
#endif
async_handshake_ex(response_type& res, async_handshake_ex(response_type& res,
string_view const& host, string_view const& host,
string_view const& target, string_view const& target,
@ -2140,8 +2188,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class CloseHandler> template<class CloseHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
CloseHandler, void(error_code)> CloseHandler, void(error_code)>
#endif
async_close(close_reason const& cr, CloseHandler&& handler); async_close(close_reason const& cr, CloseHandler&& handler);
/** Send a WebSocket ping frame. /** Send a WebSocket ping frame.
@ -2218,8 +2270,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class WriteHandler> template<class WriteHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
WriteHandler, void(error_code)> WriteHandler, void(error_code)>
#endif
async_ping(ping_data const& payload, WriteHandler&& handler); async_ping(ping_data const& payload, WriteHandler&& handler);
/** Send a WebSocket pong frame. /** Send a WebSocket pong frame.
@ -2311,8 +2367,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class WriteHandler> template<class WriteHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
WriteHandler, void(error_code)> WriteHandler, void(error_code)>
#endif
async_pong(ping_data const& payload, WriteHandler&& handler); async_pong(ping_data const& payload, WriteHandler&& handler);
/** Read a message from the stream. /** Read a message from the stream.
@ -2455,8 +2515,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class DynamicBuffer, class ReadHandler> template<class DynamicBuffer, class ReadHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
ReadHandler, void(error_code)> ReadHandler, void(error_code)>
#endif
async_read(opcode& op, DynamicBuffer& buffer, ReadHandler&& handler); async_read(opcode& op, DynamicBuffer& buffer, ReadHandler&& handler);
/** Read a message frame from the stream. /** Read a message frame from the stream.
@ -2609,8 +2673,12 @@ public:
manner equivalent to using boost::asio::io_service::post(). manner equivalent to using boost::asio::io_service::post().
*/ */
template<class DynamicBuffer, class ReadHandler> template<class DynamicBuffer, class ReadHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
ReadHandler, void(error_code)> ReadHandler, void(error_code)>
#endif
async_read_frame(frame_info& fi, async_read_frame(frame_info& fi,
DynamicBuffer& buffer, ReadHandler&& handler); DynamicBuffer& buffer, ReadHandler&& handler);
@ -2731,8 +2799,12 @@ public:
manner equivalent to using `boost::asio::io_service::post`. manner equivalent to using `boost::asio::io_service::post`.
*/ */
template<class ConstBufferSequence, class WriteHandler> template<class ConstBufferSequence, class WriteHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
WriteHandler, void(error_code)> WriteHandler, void(error_code)>
#endif
async_write(ConstBufferSequence const& buffers, async_write(ConstBufferSequence const& buffers,
WriteHandler&& handler); WriteHandler&& handler);
@ -2843,8 +2915,12 @@ public:
); @endcode ); @endcode
*/ */
template<class ConstBufferSequence, class WriteHandler> template<class ConstBufferSequence, class WriteHandler>
#if BEAST_DOXYGEN
void_or_deduced
#else
async_return_type< async_return_type<
WriteHandler, void(error_code)> WriteHandler, void(error_code)>
#endif
async_write_frame(bool fin, async_write_frame(bool fin,
ConstBufferSequence const& buffers, WriteHandler&& handler); ConstBufferSequence const& buffers, WriteHandler&& handler);