Merge 990846e into 01f939d

vinniefalco · Oct 17, 2016 · 0c477e2 · 0c477e2
2 parents 01f939d + 990846e
commit 0c477e2
Show file tree

Hide file tree

Showing 66 changed files with 2,312 additions and 1,521 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,36 @@
+1.0.0-b17
+
+* Change implicit to default value in example
+* Tidy up some declarations
+* Fix basic_streambuf::capacity
+* Add basic_streambuf::alloc_size
+* Parser callbacks may not throw
+* Fix Reader concept doc typo
+* Add is_Reader trait
+* Tidy up basic_headers for documentation
+* Tidy up documentation
+* Add basic_parser_v1::reset
+* Fix handling of body_what::pause in basic_parser_v1
+* Add headers_parser
+
+API Changes:
+
+* Added init() to Reader requirements
+* Reader must be nothrow constructible
+* Reader is now constructed right before reading the body
+  - The message passed on construction is filled in
+* Rework HTTP concepts:
+  - Writer uses write instead of operator()
+  - Refactor traits to use void_t
+  - Remove is_ReadableBody, is_WritableBody
+  - Add has_reader, has_writer, is_Reader, is_Writer
+  - More friendly compile errors on failed concept checks
+* basic_parser_v1 requires all callbacks present
+* on_headers parser callback now returns void
+* on_body_what is a new required parser callback returning body_what
+
+--------------------------------------------------------------------------------
+
 1.0.0-b16
 
 * Make value optional in param-list
@@ -17,6 +50,17 @@ API Changes:
 * Rename mask_buffer_size to write_buffer_size
 * Make auto_fragment a boolean option
 
+The message class hierarchy is refactored (breaking change):
+
+* One message class now models both HTTP/1 and HTTP/2 messages
+* message_v1, request_v1, response_v1 removed
+* New classes basic_request and basic_response model
+  messages without the body.
+
+    Error resolution: Callers should use message, request,
+    and response instead of message_v1, request_v1, and
+    response_v1 respectively.
+
 --------------------------------------------------------------------------------
 
 1.0.0-b15

diff --git a/doc/http.qbk b/doc/http.qbk
@@ -11,7 +11,7 @@
 
 [block '''
 <informaltable frame="all"><tgroup cols="1"><colspec colname="a"/><tbody><row><entry valign="top"><simplelist>
-  <member><link linkend="beast.http.message">Message</link></member>
+  <member><link linkend="beast.http.message">Messages</link></member>
   <member><link linkend="beast.http.headers">Headers</link></member>
   <member><link linkend="beast.http.body">Body</link></member>
   <member><link linkend="beast.http.algorithms">Algorithms</link></member>
@@ -44,25 +44,25 @@ messages called responses.
 
 
 
-[section:message Message]
+[section:message Messages]
 
-The __message__ class template models HTTP/2 requests and responses, while the
-derived class __message_v1__ models HTTP/1 requests and responses, adding the
-required version field. These objects are complete: they contain
-all the information required to permit the algorithms to operate. These objects
-are first class: They may be returned from functions, moved, copied, passed
-as arguments, and stored in containers. Request and response messages are
-distinct types; functions may be overloaded on just one or the other if
-desired. Because this class template supports HTTP/1 and HTTP/2, it is
-sometimes referred to as the universal message model.
+The __message__ class template models HTTP/1 and HTTP/2 requests and responses.
+These class templates are complete: they contain all the information needed
+by the algorithms. Objects of this type are first class: They may be returned
+from functions, moved, copied, passed as arguments, and stored in containers.
+Request and response messages are distinct types; functions may be overloaded
+on just one or the other if desired. Because this class template supports
+HTTP/1 and HTTP/2, it is sometimes referred to as the universal message model.
 
-These class templates have three template parameters:
+There are three important template parameters in the message class:
 ```
-    template<bool isRequest, class Body, class Headers>
+    template<
+        bool isRequest,
+        class Body,
+        class Headers
+    >
     class message;
 
-    template<bool isRequest, class Body, class Headers>
-    class message_v1;
 ```
 
 * [*`isRequest`]: Controls whether or not the message is a request or response.
@@ -76,38 +76,36 @@ These class templates have three template parameters:
 
 For notational convenience, the following template type aliases are provided:
 ```
-    template<class Body, class Headers = basic_headers<std::allocator<char>>>
+    template<
+        class Body,
+        class Headers = basic_headers<std::allocator<char>>>
     using request = message<true, Body, Headers>;
 
-    template<class Body, class Headers = basic_headers<std::allocator<char>>>
+    template<
+        class Body,
+        class Headers = basic_headers<std::allocator<char>>>
     using response = message<false, Body, Headers>;
-
-    template<class Body, class Headers = basic_headers<std::allocator<char>>>
-    using request_v1 = message_v1<true, Body, Headers>;
-
-    template<class Body, class Headers = basic_headers<std::allocator<char>>>
-    using response_v1 = message_v1<false, Body, Headers>;
 ```
 
-Although these aliases have a common base class, they have different fields
-depending on whether the message is a request or a response. These simplified
-declarations notionally illustrate the members of HTTP/1 messages:
+The message class template has different data members depending on whether
+it represents a request or response. These simplified declarations
+notionally illustrate the members of HTTP/1 messages:
 
 ```
     template<class Body, class Headers>
-    struct request_v1
+    struct request
     {
-        int version;  10 or 11
+        int version;            // 10 for HTTP/1.0, 11 for HTTP/1.1
         std::string method;
         std::string url;
         Headers headers;
         typename Body::value_type body;
     };
 
     template<class Body, class Headers>
-    struct response_v1
+    struct response
     {
-        int version;  10 or 11
+        int version;            // 10 for HTTP/1.0, 11 for HTTP/1.1
         int status;
         std::string reason;
         Headers headers;
@@ -117,17 +115,17 @@ declarations notionally illustrate the members of HTTP/1 messages:
 
 These statements set fields in request and response message objects:
 ```
-    request_v1<string_body> req;
+    request<string_body> req;
+    req.version = 11;           // HTTP/1.1
     req.method = "GET";
     req.url = "/index.html";
-    req.version = 11;           // HTTP/1.1
     req.headers.insert("User-Agent", "Beast.HTTP");
     req.body = "";
 
-    response_v1<string_body> res;
+    response<string_body> res;
+    res.version = 10;          // HTTP/1.0
     res.status = 404;
     res.reason = "Not Found";
-    res.version = 10;          // HTTP/1.0
     res.headers.insert("Server", "Beast.HTTP");
     res.body = "The requested resource was not found.";
 ```
@@ -147,7 +145,7 @@ The field names are not case-sensitive.
 These statements change the values of the headers in the message passed:
 ```
     template<class Body>
-    void set_fields(request_v1<Body>& req)
+    void set_fields(request<Body>& req)
     {
         if(! req.exists("User-Agent"))
             req.insert("User-Agent", "myWebClient");
@@ -184,7 +182,7 @@ and serialization. Beast provides three very common [*`Body`] types:
 * [link beast.ref.http__empty_body [*`empty_body`:]] An empty message body.
 Used in GET requests where there is no message body. Example:
 ```
-    request_v1<empty_body> req;
+    request<empty_body> req;
     req.version = 11;
     req.method = "GET";
     req.url = "/index.html";
@@ -196,7 +194,7 @@ or response with simple text in the message body (such as an error message).
 Has the same insertion complexity of `std::string`. This is the type of body
 used in the examples:
 ```
-    response_v1<string_body> res;
+    response<string_body> res;
     static_assert(std::is_same<decltype(res.body), std::string>::value);
     res.body = "Here is the data you requested";
 ```
@@ -282,7 +280,7 @@ An asynchronous interface is available:
 ```
     void handle_write(boost::system::error_code);
     ...
-    request_v1<empty_body> req;
+    request<empty_body> req;
     ...
     async_write(sock, req, std::bind(&handle_write, std::placeholders::_1));
 ```
@@ -297,7 +295,7 @@ stored in the streambuf parameter for use in a subsequent call to read:
 ```
     boost::asio::streambuf sb;
     ...
-    response_v1<string_body> res;
+    response<string_body> res;
     read(sock, sb, res); // Throws exception on error
     ...
     // Alternatively
@@ -314,7 +312,7 @@ called:
     void handle_read(boost::system::error_code);
     ...
     boost::asio::streambuf sb;
-    response_v1<string_body> res;
+    response<string_body> res;
     ...
     async_read(sock, res, std::bind(&handle_read, std::placeholders::_1));
 ```
@@ -326,7 +324,7 @@ is optimized for performance:
     void handle_read(boost::system::error_code);
     ...
     beast::streambuf sb;
-    response_v1<string_body> res;
+    response<string_body> res;
     read(sock, sb, res);
 ```
 

diff --git a/doc/quickref.xml b/doc/quickref.xml
@@ -16,10 +16,10 @@
     <colspec colname="d"/>
     <thead>
       <row>
-        <entry valign="center" namest="a" nameend="b">
+        <entry valign="center" namest="a" nameend="c">
           <bridgehead renderas="sect2">HTTP</bridgehead>
         </entry>
-        <entry valign="center" namest="c" nameend="d">
+        <entry valign="center" namest="d" nameend="d">
           <bridgehead renderas="sect2">WebSocket</bridgehead>
         </entry>
       </row>
@@ -34,24 +34,23 @@
             <member><link linkend="beast.ref.http__basic_parser_v1">basic_parser_v1</link></member>
             <member><link linkend="beast.ref.http__empty_body">empty_body</link></member>
             <member><link linkend="beast.ref.http__headers">headers</link></member>
+            <member><link linkend="beast.ref.http__headers_parser">headers_parser</link></member>
             <member><link linkend="beast.ref.http__message">message</link></member>
-            <member><link linkend="beast.ref.http__message_v1">message_v1</link></member>
+            <member><link linkend="beast.ref.http__message_headers">message_headers</link></member>
+            <member><link linkend="beast.ref.http__parser_v1">parser_v1</link></member>
+            <member><link linkend="beast.ref.http__request">request</link></member>
+            <member><link linkend="beast.ref.http__request_headers">request_headers</link></member>
+            <member><link linkend="beast.ref.http__response">response</link></member>
+            <member><link linkend="beast.ref.http__response_headers">response_headers</link></member>
             <member><link linkend="beast.ref.http__resume_context">resume_context</link></member>
             <member><link linkend="beast.ref.http__streambuf_body">streambuf_body</link></member>
             <member><link linkend="beast.ref.http__string_body">string_body</link></member>
           </simplelist>
-          <bridgehead renderas="sect3">Options</bridgehead>
+          <bridgehead renderas="sect3">rfc7230</bridgehead>
           <simplelist type="vert" columns="1">
-            <member><link linkend="beast.ref.http__body_max_size">body_max_size</link></member>
-            <member><link linkend="beast.ref.http__headers_max_size">headers_max_size</link></member>
-            <member><link linkend="beast.ref.http__skip_body">skip_body</link></member>
-          </simplelist>
-          <bridgehead renderas="sect3">Type Traits</bridgehead>
-          <simplelist type="vert" columns="1">
-           <member><link linkend="beast.ref.http__is_Body">is_Body</link></member>
-           <member><link linkend="beast.ref.http__is_Parser">is_Parser</link></member>
-           <member><link linkend="beast.ref.http__is_ReadableBody">is_ReadableBody</link></member>
-           <member><link linkend="beast.ref.http__is_WritableBody">is_WritableBody</link></member>
+           <member><link linkend="beast.ref.http__ext_list">ext_list</link></member>
+           <member><link linkend="beast.ref.http__param_list">param_list</link></member>
+           <member><link linkend="beast.ref.http__token_list">token_list</link></member>
           </simplelist>
         </entry>
         <entry valign="top">
@@ -60,12 +59,33 @@
             <member><link linkend="beast.ref.http__async_parse">async_parse</link></member>
             <member><link linkend="beast.ref.http__async_read">async_read</link></member>
             <member><link linkend="beast.ref.http__async_write">async_write</link></member>
+            <member><link linkend="beast.ref.http__async_write">async_write</link></member>
+            <member><link linkend="beast.ref.http__is_keep_alive">is_keep_alive</link></member>
+            <member><link linkend="beast.ref.http__is_upgrade">is_upgrade</link></member>
             <member><link linkend="beast.ref.http__parse">parse</link></member>
             <member><link linkend="beast.ref.http__prepare">prepare</link></member>
             <member><link linkend="beast.ref.http__read">read</link></member>
             <member><link linkend="beast.ref.http__swap">swap</link></member>
+            <member><link linkend="beast.ref.http__with_body">with_body</link></member>
             <member><link linkend="beast.ref.http__write">write</link></member>
           </simplelist>
+          <bridgehead renderas="sect3">Type Traits</bridgehead>
+          <simplelist type="vert" columns="1">
+           <member><link linkend="beast.ref.http__is_Body">is_Body</link></member>
+           <member><link linkend="beast.ref.http__is_Parser">is_Parser</link></member>
+           <member><link linkend="beast.ref.http__is_Reader">is_Reader</link></member>
+           <member><link linkend="beast.ref.http__is_Writer">is_Reader</link></member>
+           <member><link linkend="beast.ref.http__has_reader">has_reader</link></member>
+           <member><link linkend="beast.ref.http__has_writer">has_writer</link></member>
+          </simplelist>
+        </entry>
+        <entry valign="top">
+          <bridgehead renderas="sect3">Options</bridgehead>
+          <simplelist type="vert" columns="1">
+            <member><link linkend="beast.ref.http__body_max_size">body_max_size</link></member>
+            <member><link linkend="beast.ref.http__headers_max_size">headers_max_size</link></member>
+            <member><link linkend="beast.ref.http__skip_body">skip_body</link></member>
+          </simplelist>
           <bridgehead renderas="sect3">Constants</bridgehead>
           <simplelist type="vert" columns="1">
             <member><link linkend="beast.ref.http__body_what">body_what</link></member>
@@ -90,6 +110,11 @@
             <member><link linkend="beast.ref.websocket__reason_string">reason_string</link></member>
             <member><link linkend="beast.ref.websocket__teardown_tag">teardown_tag</link></member>
           </simplelist>
+          <bridgehead renderas="sect3">Functions</bridgehead>
+          <simplelist type="vert" columns="1">
+            <member><link linkend="beast.ref.websocket__async_teardown">async_teardown</link></member>
+            <member><link linkend="beast.ref.websocket__teardown">teardown</link></member>
+          </simplelist>
           <bridgehead renderas="sect3">Options</bridgehead>
           <simplelist type="vert" columns="1">
             <member><link linkend="beast.ref.websocket__auto_fragment">auto_fragment</link></member>
@@ -101,13 +126,6 @@
             <member><link linkend="beast.ref.websocket__read_message_max">read_message_max</link></member>
             <member><link linkend="beast.ref.websocket__write_buffer_size">write_buffer_size</link></member>
           </simplelist>
-        </entry>
-        <entry valign="top">
-          <bridgehead renderas="sect3">Functions</bridgehead>
-          <simplelist type="vert" columns="1">
-            <member><link linkend="beast.ref.websocket__async_teardown">async_teardown</link></member>
-            <member><link linkend="beast.ref.websocket__teardown">teardown</link></member>
-          </simplelist>
           <bridgehead renderas="sect3">Constants</bridgehead>
           <simplelist type="vert" columns="1">
             <member><link linkend="beast.ref.websocket__close_code">close_code</link></member>
@@ -169,7 +187,6 @@
         <entry valign="top">
           <bridgehead renderas="sect3">Type Traits</bridgehead>
           <simplelist type="vert" columns="1">
-
             <member><link linkend="beast.ref.is_AsyncReadStream">is_AsyncReadStream</link></member>
             <member><link linkend="beast.ref.is_AsyncWriteStream">is_AsyncWriteStream</link></member>
             <member><link linkend="beast.ref.is_AsyncStream">is_AsyncStream</link></member>

diff --git a/doc/source.dox b/doc/source.dox
@@ -103,11 +103,10 @@ WARN_LOGFILE           =
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
 INPUT = \
-        ../include/beast/ \
         ../include/beast/core \
         ../include/beast/http \
         ../include/beast/websocket \
-        ../include/beast/doc_debug.hpp \
+        ../extras/beast/doc_debug.hpp \
 
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          =