trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a..@apache.org
Subject [trafficserver] branch master updated: Doc: TSHttpTxnHdrLengthGet, TSMBuffer, TSMLoc.
Date Tue, 05 Feb 2019 06:14:09 GMT
This is an automated email from the ASF dual-hosted git repository.

amc 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 ad2461d  Doc: TSHttpTxnHdrLengthGet, TSMBuffer, TSMLoc.
ad2461d is described below

commit ad2461db80947f5072327268bdacfe3ed6917984
Author: Alan M. Carroll <amc@apache.org>
AuthorDate: Mon Feb 4 15:47:39 2019 -0600

    Doc: TSHttpTxnHdrLengthGet, TSMBuffer, TSMLoc.
---
 doc/developer-guide/api/functions/TSHttpHdrLengthGet.en.rst | 11 ++++++++++-
 doc/developer-guide/api/functions/TSTypes.en.rst            | 11 +++++++++++
 doc/developer-guide/core-architecture/heap.en.rst           |  2 +-
 3 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/doc/developer-guide/api/functions/TSHttpHdrLengthGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrLengthGet.en.rst
index 9db63fd..495ef1a 100644
--- a/doc/developer-guide/api/functions/TSHttpHdrLengthGet.en.rst
+++ b/doc/developer-guide/api/functions/TSHttpHdrLengthGet.en.rst
@@ -26,7 +26,16 @@ Synopsis
 
 `#include <ts/ts.h>`
 
-.. function:: int TSHttpHdrLengthGet(TSMBuffer bufp, TSMLoc offset)
+.. function:: int TSHttpHdrLengthGet(TSMBuffer bufp, TSMLoc mloc)
 
 Description
 ===========
+
+Return the length in characters of the HTTP header specified by :arg:`bufp` and :arg:`mloc`
which
+must specify a valid HTTP header. Usually these values would have been obtained via an earlier
call
+to
+:func:`TSHttpTxnServerReqGet`,
+:func:`TSHttpTxnClientReqGet`,
+:func:`TSHttpTxnServerRespGet`,
+:func:`TSHttpTxnClientRespGet`,
+or via calls to create a new HTTP header such as :func:`TSHttpHdrCreate`.
diff --git a/doc/developer-guide/api/functions/TSTypes.en.rst b/doc/developer-guide/api/functions/TSTypes.en.rst
index 8abbea6..675029a 100644
--- a/doc/developer-guide/api/functions/TSTypes.en.rst
+++ b/doc/developer-guide/api/functions/TSTypes.en.rst
@@ -102,6 +102,11 @@ more widely. Those are described on this page.
 
 .. type:: TSMBuffer
 
+   Internally, data for a transaction is stored in one more more :term:`header heap`\s. These
are
+   storage local to the transaction, and generally each HTTP header is stored in a separate
one.
+   This type is a handle to a header heap, and is provided or required by functions that
locate HTTP
+   header related data.
+
 .. type:: TSMgmtCounter
 
 .. type:: TSMgmtFloat
@@ -120,6 +125,12 @@ more widely. Those are described on this page.
 
 .. type:: TSMLoc
 
+   This is a memory location relative to a :term:`header heap` represented by a :c:type:`TSMBuffer`
and
+   must always be used in conjuction with that :c:type:`TSMBuffer` instance. It identifies
a specific
+   object in the :c:type:`TSMBuffer`. This indirection is needed so that the :c:type:`TSMBuffer`
+   can reallocate space as needed. Therefore a raw address obtained from a :c:type:`TSMLoc`
should
+   be considered volatile that may become invalid across any API call.
+
 .. var:: TSMLoc TS_NULL_MLOC
 
    A predefined null valued :type:`TSMLoc` used to indicate the absence of an :type:`TSMLoc`.
diff --git a/doc/developer-guide/core-architecture/heap.en.rst b/doc/developer-guide/core-architecture/heap.en.rst
index 188b2c9..f05fbbb 100644
--- a/doc/developer-guide/core-architecture/heap.en.rst
+++ b/doc/developer-guide/core-architecture/heap.en.rst
@@ -121,7 +121,7 @@ Classes
 
       :arg:`type` must be one of the values specified in :class:`HdrHeapObjImpl`.
 
-   .. function:: int marshal_length
+   .. function:: int marshal_length()
 
       Compute and return the size of the buffer needed to serialize :arg:`this`.
 


Mime
View raw message