From b4c2073973c5dd8cff4ac6e167db9f4b9cbbe3b2 Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Thu, 15 Jun 2017 09:36:36 -0700 Subject: [PATCH] basic_parser::put doc fix #494 --- CHANGELOG.md | 1 + include/beast/http/basic_parser.hpp | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index de04b991..8a579db4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ Version 58: * Avoid `std::string` in websocket * Fix basic_fields insert ordering * basic_fields::set optimization +* basic_parser::put doc API Changes: diff --git a/include/beast/http/basic_parser.hpp b/include/beast/http/basic_parser.hpp index 07ecb9e0..79612c64 100644 --- a/include/beast/http/basic_parser.hpp +++ b/include/beast/http/basic_parser.hpp @@ -323,7 +323,11 @@ public: the parser may not be restarted. @param buffers An object meeting the requirements of - @b ConstBufferSequence that represents the message. + @b ConstBufferSequence that represents the next chunk of + message data. If the length of this buffer sequence is + one, the implementation will not allocate additional memory. + The class @ref flat_buffer is provided as one way to + meet this requirement @param ec Set to the error, if any occurred.