From 9d941f26556f5d9cc48c5b4d0d506af62c3a9cb1 Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Wed, 22 Nov 2017 10:29:12 -0800 Subject: [PATCH] Documentation tidying --- CHANGELOG.md | 1 + doc/qbk/04_http/03_streams.qbk | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0948c58e..e761b37d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ Version 146: * Fix some typos * Faster ascii_tolower +* Documentation tidying API Changes: diff --git a/doc/qbk/04_http/03_streams.qbk b/doc/qbk/04_http/03_streams.qbk index fc4ed656..91c84fdd 100644 --- a/doc/qbk/04_http/03_streams.qbk +++ b/doc/qbk/04_http/03_streams.qbk @@ -49,7 +49,8 @@ occurs this argument will be set to contain the error code. Because a serialized header is not length-prefixed, algorithms which parse messages from a stream may read past the end of a message for efficiency. To hold this surplus data, all stream read operations use -a passed-in __DynamicBuffer__ which must be persisted between calls. +a passed-in __DynamicBuffer__ which must be persisted between calls +until the end of stream is reached or the stream object is destroyed. Each read operation may consume bytes remaining in the buffer, and leave behind new bytes. In this example we declare the buffer and a message variable, then read a complete HTTP request synchronously: