From bc183a6eda5437853327cce460c19b02b3202fdf Mon Sep 17 00:00:00 2001 From: Willy Tarreau Date: Fri, 28 Aug 2015 10:39:11 +0200 Subject: [PATCH] DOC: lua: mention than txn:close was renamed txn:done. Also indicate that it's not limited to error processing. --- doc/lua-api/index.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst index f8cfee26b..fa69e1f46 100644 --- a/doc/lua-api/index.rst +++ b/doc/lua-api/index.rst @@ -931,10 +931,11 @@ TXN class :param class_txn txn: The class txn object containing the data. :returns: an array of headers. -.. js:function:: TXN.close(txn) +.. js:function:: TXN.done(txn) - This function close the transaction and the associated session. It can be - used when a critical error is detected. + This function terminates processing of the transaction and the associated + session. It can be used when a critical error is detected or to terminate + processing after some data have been returned to the client (eg: a redirect). :param class_txn txn: The class txn object containing the data.