diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst index 22c053884..9fc4105ff 100644 --- a/doc/lua-api/index.rst +++ b/doc/lua-api/index.rst @@ -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 . + + :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 . + + :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 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 . + + :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 . + + :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 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 ======================