[trafficserver] 05/05: Add documentation for TSHttpTxnRedoCacheLookup

[am...@apache.org]

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

commit 4a19b32446427b98be43fb357ca7ccffbb9d7a86
Author: David Calavera <da...@gmail.com>
AuthorDate: Fri Sep 13 15:07:16 2019 -0700

    Add documentation for TSHttpTxnRedoCacheLookup
    
    Signed-off-by: David Calavera <da...@gmail.com>
---
 .../api/functions/TSHttpTxnRedoCacheLookup.en.rst  | 48 ++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/doc/developer-guide/api/functions/TSHttpTxnRedoCacheLookup.en.rst b/doc/developer-guide/api/functions/TSHttpTxnRedoCacheLookup.en.rst
new file mode 100644
index 0000000..01f174b
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnRedoCacheLookup.en.rst
@@ -0,0 +1,48 @@
+.. 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
+
+TSHttpTxnRedoCacheLookup
+*******************
+
+Synopsis
+========
+
+`#include <ts/experimental.h>`
+
+.. function:: TSReturnCode TSHttpTxnRedoCacheLookup(TSHttpTxn txnp, const char *url, int length)
+
+Description
+===========
+
+Perform a cache lookup with a different url.
+This function rewinds the state machine to perform the new cache lookup. The cache_info for the new
+url must have been initialized before calling this function.
+
+If the length argument is -1, this function will take the length from the url argument.
+
+Notes
+=====
+
+This API may be changed in the future version since it is experimental.
+
+See Also
+========
+
+:manpage:`TSAPI(3ts)`,