mirror of
https://github.com/boostorg/beast.git
synced 2025-07-31 13:27:33 +02:00
Tidy up use of GENERATING_DOCS
This commit is contained in:
@@ -1,6 +1,8 @@
|
|||||||
1.0.0-b6
|
1.0.0-b6
|
||||||
|
|
||||||
|
* Add HTTP field value parsers
|
||||||
* Use SFINAE on return values
|
* Use SFINAE on return values
|
||||||
* Use beast::error_code instead of nested types
|
* Use beast::error_code instead of nested types
|
||||||
|
* Tidy up use of GENERATING_DOCS
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
--------------------------------------------------------------------------------
|
||||||
|
14
TODO.txt
14
TODO.txt
@@ -7,11 +7,7 @@ Boost.Http
|
|||||||
Docs:
|
Docs:
|
||||||
* Include Example program listings in the docs
|
* Include Example program listings in the docs
|
||||||
* Fix index in docs
|
* Fix index in docs
|
||||||
* Figure out why namespace rfc2616 is included in docs
|
|
||||||
(currently disabled via GENERATING_DOCS macro)
|
|
||||||
* melpon sandbox?
|
* melpon sandbox?
|
||||||
* Check DOXYGEN, GENERATIC_DOCS directives in source
|
|
||||||
- See if we can include them now that xsl is fixed
|
|
||||||
* Implement cleanup-param to remove spaces around template arguments
|
* Implement cleanup-param to remove spaces around template arguments
|
||||||
e.g. in basic_streambuf move constructor members
|
e.g. in basic_streambuf move constructor members
|
||||||
* Don't put using namespace at file scope in examples,
|
* Don't put using namespace at file scope in examples,
|
||||||
@@ -23,15 +19,12 @@ Core:
|
|||||||
* Complete allocator testing in basic_streambuf
|
* Complete allocator testing in basic_streambuf
|
||||||
|
|
||||||
WebSocket:
|
WebSocket:
|
||||||
|
* more invokable unit test coverage
|
||||||
|
* More control over the HTTP request and response during handshakes
|
||||||
* optimized versions of key/masking, choose prepared_key size
|
* optimized versions of key/masking, choose prepared_key size
|
||||||
* invokable unit test
|
|
||||||
* Don't try to read requests into empty_body
|
|
||||||
* Give callers control over the http request/response used during handshake
|
* Give callers control over the http request/response used during handshake
|
||||||
* Investigate poor autobahn results in Debug builds
|
* Investigate poor autobahn results in Debug builds
|
||||||
* Fall through composed operation switch cases
|
* Fall through composed operation switch cases
|
||||||
* Replace stream::error_ with stream::state_, example states: ok, error, abort_io
|
|
||||||
Need a cancel state so waking up a ping stored in invokable knows to call the
|
|
||||||
final handler with operation_aborted
|
|
||||||
* Use close_code::no_code instead of close_code::none
|
* Use close_code::no_code instead of close_code::none
|
||||||
* Make request_type, response_type public APIs,
|
* Make request_type, response_type public APIs,
|
||||||
use in stream member function signatures
|
use in stream member function signatures
|
||||||
@@ -56,8 +49,5 @@ HTTP:
|
|||||||
* Complete allocator testing in basic_streambuf, basic_headers
|
* Complete allocator testing in basic_streambuf, basic_headers
|
||||||
* Add tests for writer using the resume function / coros
|
* Add tests for writer using the resume function / coros
|
||||||
* Custom HTTP error codes for various situations
|
* Custom HTTP error codes for various situations
|
||||||
* Make empty_body write-only, remove reader nested type
|
|
||||||
* Add concepts WritableBody ReadableBody with type checks,
|
|
||||||
check them in read and write functions
|
|
||||||
* Branch prediction hints in parser
|
* Branch prediction hints in parser
|
||||||
* Check basic_parser_v1 against rfc7230 for leading message whitespace
|
* Check basic_parser_v1 against rfc7230 for leading message whitespace
|
||||||
|
@@ -321,12 +321,12 @@ public:
|
|||||||
*/
|
*/
|
||||||
template<bool isRequest, class Body, class Headers,
|
template<bool isRequest, class Body, class Headers,
|
||||||
class ReadHandler>
|
class ReadHandler>
|
||||||
#if GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
ReadHandler, void(error_code)>::result_type
|
ReadHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_read(message_v1<isRequest, Body, Headers>& msg,
|
async_read(message_v1<isRequest, Body, Headers>& msg,
|
||||||
ReadHandler&& handler);
|
ReadHandler&& handler);
|
||||||
|
|
||||||
@@ -416,12 +416,12 @@ public:
|
|||||||
*/
|
*/
|
||||||
template<bool isRequest, class Body, class Headers,
|
template<bool isRequest, class Body, class Headers,
|
||||||
class WriteHandler>
|
class WriteHandler>
|
||||||
#if GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
WriteHandler, void(error_code)>::result_type
|
WriteHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_write(message_v1<isRequest, Body, Headers> const& msg,
|
async_write(message_v1<isRequest, Body, Headers> const& msg,
|
||||||
WriteHandler&& handler);
|
WriteHandler&& handler);
|
||||||
|
|
||||||
|
@@ -506,8 +506,6 @@ compare(
|
|||||||
|
|
||||||
} // detail
|
} // detail
|
||||||
|
|
||||||
#if ! GENERATING_DOCS
|
|
||||||
|
|
||||||
template<std::size_t N, std::size_t M, class CharT, class Traits>
|
template<std::size_t N, std::size_t M, class CharT, class Traits>
|
||||||
bool
|
bool
|
||||||
operator==(
|
operator==(
|
||||||
@@ -672,8 +670,6 @@ operator>=(
|
|||||||
return detail::compare(lhs, s) >= 0;
|
return detail::compare(lhs, s) >= 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
||||||
} // beast
|
} // beast
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
@@ -373,14 +373,14 @@ public:
|
|||||||
@return The number of bytes consumed in the input sequence.
|
@return The number of bytes consumed in the input sequence.
|
||||||
*/
|
*/
|
||||||
template<class ConstBufferSequence>
|
template<class ConstBufferSequence>
|
||||||
#if GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
std::size_t
|
std::size_t
|
||||||
#else
|
#else
|
||||||
typename std::enable_if<
|
typename std::enable_if<
|
||||||
! std::is_convertible<ConstBufferSequence,
|
! std::is_convertible<ConstBufferSequence,
|
||||||
boost::asio::const_buffer>::value,
|
boost::asio::const_buffer>::value,
|
||||||
std::size_t>::type
|
std::size_t>::type
|
||||||
#endif
|
#endif
|
||||||
write(ConstBufferSequence const& buffers, error_code& ec);
|
write(ConstBufferSequence const& buffers, error_code& ec);
|
||||||
|
|
||||||
/** Write a single buffer of data to the parser.
|
/** Write a single buffer of data to the parser.
|
||||||
|
@@ -145,8 +145,6 @@ private:
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
#if ! GENERATING_DOCS
|
|
||||||
|
|
||||||
/// A typical HTTP request
|
/// A typical HTTP request
|
||||||
template<class Body,
|
template<class Body,
|
||||||
class Headers = basic_headers<std::allocator<char>>>
|
class Headers = basic_headers<std::allocator<char>>>
|
||||||
@@ -157,8 +155,6 @@ template<class Body,
|
|||||||
class Headers = basic_headers<std::allocator<char>>>
|
class Headers = basic_headers<std::allocator<char>>>
|
||||||
using response = message<false, Body, Headers>;
|
using response = message<false, Body, Headers>;
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
||||||
} // http
|
} // http
|
||||||
} // beast
|
} // beast
|
||||||
|
|
||||||
|
@@ -50,8 +50,6 @@ struct message_v1 : message<isRequest, Body, Headers>
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
#if ! GENERATING_DOCS
|
|
||||||
|
|
||||||
/// A typical HTTP/1 request
|
/// A typical HTTP/1 request
|
||||||
template<class Body,
|
template<class Body,
|
||||||
class Headers = basic_headers<std::allocator<char>>>
|
class Headers = basic_headers<std::allocator<char>>>
|
||||||
@@ -62,8 +60,6 @@ template<class Body,
|
|||||||
class Headers = basic_headers<std::allocator<char>>>
|
class Headers = basic_headers<std::allocator<char>>>
|
||||||
using response_v1 = message_v1<false, Body, Headers>;
|
using response_v1 = message_v1<false, Body, Headers>;
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/// Returns `true` if a HTTP/1 message indicates a keep alive
|
/// Returns `true` if a HTTP/1 message indicates a keep alive
|
||||||
template<bool isRequest, class Body, class Headers>
|
template<bool isRequest, class Body, class Headers>
|
||||||
bool
|
bool
|
||||||
|
@@ -95,12 +95,12 @@ public:
|
|||||||
|
|
||||||
/// The type of the lowest layer.
|
/// The type of the lowest layer.
|
||||||
using lowest_layer_type =
|
using lowest_layer_type =
|
||||||
#if GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
implementation_defined;
|
implementation_defined;
|
||||||
#else
|
#else
|
||||||
typename beast::detail::get_lowest_layer<
|
typename beast::detail::get_lowest_layer<
|
||||||
next_layer_type>::type;
|
next_layer_type>::type;
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/** Move-construct a stream.
|
/** Move-construct a stream.
|
||||||
|
|
||||||
@@ -404,12 +404,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 GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
AcceptHandler, void(error_code)>::result_type
|
AcceptHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_accept(AcceptHandler&& handler);
|
async_accept(AcceptHandler&& handler);
|
||||||
|
|
||||||
/** Read and respond to a WebSocket HTTP Upgrade request.
|
/** Read and respond to a WebSocket HTTP Upgrade request.
|
||||||
@@ -530,12 +530,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 GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
AcceptHandler, void(error_code)>::result_type
|
AcceptHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_accept(ConstBufferSequence const& buffers,
|
async_accept(ConstBufferSequence const& buffers,
|
||||||
AcceptHandler&& handler);
|
AcceptHandler&& handler);
|
||||||
|
|
||||||
@@ -647,12 +647,12 @@ public:
|
|||||||
manner equivalent to using `boost::asio::io_service::post`.
|
manner equivalent to using `boost::asio::io_service::post`.
|
||||||
*/
|
*/
|
||||||
template<class Body, class Headers, class AcceptHandler>
|
template<class Body, class Headers, class AcceptHandler>
|
||||||
#if GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
AcceptHandler, void(error_code)>::result_type
|
AcceptHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_accept(http::request_v1<Body, Headers> const& request,
|
async_accept(http::request_v1<Body, Headers> const& request,
|
||||||
AcceptHandler&& handler);
|
AcceptHandler&& handler);
|
||||||
|
|
||||||
@@ -784,12 +784,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 GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
HandshakeHandler, void(error_code)>::result_type
|
HandshakeHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_handshake(boost::string_ref const& host,
|
async_handshake(boost::string_ref const& host,
|
||||||
boost::string_ref const& resource, HandshakeHandler&& h);
|
boost::string_ref const& resource, HandshakeHandler&& h);
|
||||||
|
|
||||||
@@ -895,12 +895,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 GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
CloseHandler, void(error_code)>::result_type
|
CloseHandler, void(error_code)>::result_type
|
||||||
#endif
|
#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.
|
||||||
@@ -973,12 +973,12 @@ public:
|
|||||||
manner equivalent to using `boost::asio::io_service::post`.
|
manner equivalent to using `boost::asio::io_service::post`.
|
||||||
*/
|
*/
|
||||||
template<class PingHandler>
|
template<class PingHandler>
|
||||||
#if GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
PingHandler, void(error_code)>::result_type
|
PingHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_ping(ping_data const& payload, PingHandler&& handler);
|
async_ping(ping_data const& payload, PingHandler&& handler);
|
||||||
|
|
||||||
/** Read a message from the stream.
|
/** Read a message from the stream.
|
||||||
@@ -1103,12 +1103,12 @@ public:
|
|||||||
manner equivalent to using `boost::asio::io_service::post`.
|
manner equivalent to using `boost::asio::io_service::post`.
|
||||||
*/
|
*/
|
||||||
template<class Streambuf, class ReadHandler>
|
template<class Streambuf, class ReadHandler>
|
||||||
#if GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
ReadHandler, void(error_code)>::result_type
|
ReadHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_read(opcode& op,
|
async_read(opcode& op,
|
||||||
Streambuf& streambuf, ReadHandler&& handler);
|
Streambuf& streambuf, ReadHandler&& handler);
|
||||||
|
|
||||||
@@ -1243,12 +1243,12 @@ public:
|
|||||||
manner equivalent to using boost::asio::io_service::post().
|
manner equivalent to using boost::asio::io_service::post().
|
||||||
*/
|
*/
|
||||||
template<class Streambuf, class ReadHandler>
|
template<class Streambuf, class ReadHandler>
|
||||||
#if GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
ReadHandler, void(error_code)>::result_type
|
ReadHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_read_frame(frame_info& fi,
|
async_read_frame(frame_info& fi,
|
||||||
Streambuf& streambuf, ReadHandler&& handler);
|
Streambuf& streambuf, ReadHandler&& handler);
|
||||||
|
|
||||||
@@ -1369,12 +1369,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 GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
WriteHandler, void(error_code)>::result_type
|
WriteHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_write(ConstBufferSequence const& buffers,
|
async_write(ConstBufferSequence const& buffers,
|
||||||
WriteHandler&& handler);
|
WriteHandler&& handler);
|
||||||
|
|
||||||
@@ -1478,12 +1478,12 @@ public:
|
|||||||
); @endcode
|
); @endcode
|
||||||
*/
|
*/
|
||||||
template<class ConstBufferSequence, class WriteHandler>
|
template<class ConstBufferSequence, class WriteHandler>
|
||||||
#if GENERATING_DOCS
|
#if GENERATING_DOCS
|
||||||
void_or_deduced
|
void_or_deduced
|
||||||
#else
|
#else
|
||||||
typename async_completion<
|
typename async_completion<
|
||||||
WriteHandler, void(error_code)>::result_type
|
WriteHandler, void(error_code)>::result_type
|
||||||
#endif
|
#endif
|
||||||
async_write_frame(bool fin,
|
async_write_frame(bool fin,
|
||||||
ConstBufferSequence const& buffers, WriteHandler&& handler);
|
ConstBufferSequence const& buffers, WriteHandler&& handler);
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user