You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2018/03/09 01:15:53 UTC
[trafficserver] branch master updated: Fixing docs of
TSIOBufferReaderAvail
This is an automated email from the ASF dual-hosted git repository.
zwoop pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new 214b594 Fixing docs of TSIOBufferReaderAvail
214b594 is described below
commit 214b5946ae386448064b37a1222ec20ea8af73ea
Author: Zizhong Zhang <zi...@linkedin.com>
AuthorDate: Thu Mar 8 16:42:42 2018 -0800
Fixing docs of TSIOBufferReaderAvail
---
doc/developer-guide/api/functions/TSIOBufferReader.en.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/developer-guide/api/functions/TSIOBufferReader.en.rst b/doc/developer-guide/api/functions/TSIOBufferReader.en.rst
index 1ec5874..9591962 100644
--- a/doc/developer-guide/api/functions/TSIOBufferReader.en.rst
+++ b/doc/developer-guide/api/functions/TSIOBufferReader.en.rst
@@ -32,7 +32,7 @@ Synopsis
.. function:: void TSIOBufferReaderFree(TSIOBufferReader readerp)
.. function:: void TSIOBufferReaderConsume(TSIOBufferReader readerp, int64_t nbytes)
.. function:: TSIOBufferBlock TSIOBufferReaderStart(TSIOBufferReader readerp)
-.. function:: int64_t TSIOBufferReadAvail(TSIOBufferReader readerp)
+.. function:: int64_t TSIOBufferReaderAvail(TSIOBufferReader readerp)
.. function:: bool TSIOBufferReaderIsAvailAtLeast(TSIOBufferReader, int64_t nbytes)
.. function:: int64_t TSIOBufferReaderRead(TSIOBufferReader reader, const void * buf, int64_t length)
.. function:: bool TSIOBufferReaderIterate(TSIOBufferReader reader, TSIOBufferBlockFunc* func, void* context)
@@ -79,12 +79,12 @@ time. Reader allocation is fast and cheap until this maxium is reached at which
.. note:: The byte at the position of :arg:`reader` is in the block but is not necessarily the first byte of the block.
-:func:`TSIOBufferReadAvail` returns the number of bytes which :arg:`reader` could consume. That is
+:func:`TSIOBufferReaderAvail` returns the number of bytes which :arg:`reader` could consume. That is
the number of bytes in the IO buffer starting at the current position of :arg:`reader`.
:func:`TSIOBufferReaderIsAvailAtLeast` return ``true`` if the available number of bytes for
:arg:`reader` is at least :arg:`nbytes`, ``false`` if not. This can be more efficient than
- :func:`TSIOBufferReadAvail` because the latter must walk all the IO buffer blocks in the IO
+ :func:`TSIOBufferReaderAvail` because the latter must walk all the IO buffer blocks in the IO
buffer. This function returns as soon as the return value can be determined. In particular a
value of ``1`` for :arg:`nbytes` means only the first buffer block will be checked.
--
To stop receiving notification emails like this one, please contact
zwoop@apache.org.