You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by am...@apache.org on 2018/12/03 14:38:43 UTC

[trafficserver] branch master updated: Doc: TSHttpHdrStatusGet.

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 6bd38f6  Doc: TSHttpHdrStatusGet.
6bd38f6 is described below

commit 6bd38f602f9cf7f164466daeb24f256180ab4cbf
Author: Alan M. Carroll <am...@apache.org>
AuthorDate: Wed Nov 28 16:27:37 2018 -0600

    Doc: TSHttpHdrStatusGet.
---
 doc/developer-guide/api/functions/TSHttpHdrStatusGet.en.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/developer-guide/api/functions/TSHttpHdrStatusGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrStatusGet.en.rst
index 50b2f1d..7d2e31d 100644
--- a/doc/developer-guide/api/functions/TSHttpHdrStatusGet.en.rst
+++ b/doc/developer-guide/api/functions/TSHttpHdrStatusGet.en.rst
@@ -30,3 +30,13 @@ Synopsis
 
 Description
 ===========
+
+Retrieve the status code value from the HTTP response header identified by :arg:`bufp` and
+:arg:`offset`. The value should be an enumeration value of :c:type:`TSHttpStatus`, although because
+plugins can call :c:func:`TSHttpHdrStatusSet` this may not be true. If the header is not a valid
+response then :c:macro:`TS_HTTP_STATUS_NONE` is returned.
+
+See Also
+========
+
+:c:func:`TSHttpTxnClientRespGet`, :c:func:`TSHttpTxnServerRespGet`, :c:func:`TSHttpHdrTypeGet`.