RepoMirrors/haproxy
1
0
Fork 0
mirror of http://git.haproxy.org/git/haproxy.git/ synced 2025-01-01 01:32:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

DOC: lua: Add documentation about variable manipulation from applet

Browse Source 
This patch adds documentation about set_var, unset_var and get_var
functions added in the Class AppletHTTP and AppletTCP.
This commit is contained in:
Thierry FOURNIER / OZON.IO 2016-12-12 16:25:30 +01:00 committed by Willy Tarreau
parent b210bcc559
commit c1edafe4a9
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/lua-api/index.rst
View File

@ -2056,6 +2056,29 @@ AppletHTTP class
:param class_AppletHTTP applet: An :ref:`applethttp_class`
:param opaque data: The data which is stored in the transaction.
.. js:function:: AppletHTTP.set_var(applet, var, value)
Converts a Lua type in a HAProxy type and store it in a variable <var>.
:param class_AppletHTTP applet: An :ref:`applethttp_class`
:param string var: The variable name according with the HAProxy variable syntax.
:param type value: The value associated to the variable. The type ca be string or
integer.
.. js:function:: AppletHTTP.unset_var(applet, var)
Unset the variable <var>.
:param class_AppletHTTP applet: An :ref:`applethttp_class`
:param string var: The variable name according with the HAProxy variable syntax.
.. js:function:: AppletHTTP.get_var(applet, var)
Returns data stored in the variable <var> converter in Lua type.
:param class_AppletHTTP applet: An :ref:`applethttp_class`
:param string var: The variable name according with the HAProxy variable syntax.
.. _applettcp_class:
AppletTCP class
@ -2137,6 +2160,29 @@ AppletTCP class
:param class_AppletTCP applet: An :ref:`applettcp_class`
:param opaque data: The data which is stored in the transaction.
.. js:function:: AppletTCP.set_var(applet, var, value)
Converts a Lua type in a HAProxy type and stores it in a variable <var>.
:param class_AppletTCP applet: An :ref:`applettcp_class`
:param string var: The variable name according with the HAProxy variable syntax.
:param type value: The value associated to the variable. The type can be string or
integer.
.. js:function:: AppletTCP.unset_var(applet, var)
Unsets the variable <var>.
:param class_AppletTCP applet: An :ref:`applettcp_class`
:param string var: The variable name according with the HAProxy variable syntax.
.. js:function:: AppletTCP.get_var(applet, var)
Returns data stored in the variable <var> converter in Lua type.
:param class_AppletTCP applet: An :ref:`applettcp_class`
:param string var: The variable name according with the HAProxy variable syntax.
External Lua libraries
======================