[trafficserver] branch master updated: Doc: Adding API documentation for TSHttpTxnAborted

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

maskit 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 ea354cc  Doc: Adding API documentation for TSHttpTxnAborted
ea354cc is described below

commit ea354ccb6a46694294ef3358f845bcf6e82d7c99
Author: Rick Pufky <ri...@omniti.com>
AuthorDate: Wed May 31 10:54:01 2017 -0400

    Doc: Adding API documentation for TSHttpTxnAborted
---
 .../api/functions/TSHttpTxnAborted.en.rst          | 42 ++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/doc/developer-guide/api/functions/TSHttpTxnAborted.en.rst b/doc/developer-guide/api/functions/TSHttpTxnAborted.en.rst
new file mode 100644
index 0000000..d0638c5
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnAborted.en.rst
@@ -0,0 +1,42 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed
+   with this work for additional information regarding copyright
+   ownership.  The ASF licenses this file to you under the Apache
+   License, Version 2.0 (the "License"); you may not use this file
+   except in compliance with the License.  You may obtain a copy of
+   the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied.  See the License for the specific language governing
+   permissions and limitations under the License.
+
+.. include:: ../../../common.defs
+
+.. default-domain:: c
+
+TSHttpTxnAborted
+================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSReturnCode TSHttpTxnAborted(TSHttpTxn txnp)
+
+Description
+-----------
+
+:c:func:`TSHttpTxnAborted` returns :c:data:`TS_SUCCESS` if the requested
+transaction is aborted. This function should be used to determine whether
+a transaction has been aborted before attempting to cache the results.
+
+Return values
+-------------
+
+The API returns :c:data:`TS_SUCCESS`, if the requested transaction is aborted,
+:c:data:`TS_ERROR` otherwise.
\ No newline at end of file

-- 
To stop receiving notification emails like this one, please contact
['"commits@trafficserver.apache.org" <co...@trafficserver.apache.org>'].