Commit bf1afdd3 by Nils Goroll

auto-updated documentation

parent dcc90f18
......@@ -6,8 +6,6 @@
.. role:: ref(emphasis)
.. _vmod_re(3):
=======
vmod_re
=======
......@@ -18,10 +16,6 @@ Varnish Module for Regular Expression Matching with Subexpression Capture
:Manual section: 3
SYNOPSIS
========
......@@ -119,11 +113,10 @@ since it re-uses the compiled expression obtained at VCL
initialization. So if you are matching against a fixed pattern that
never changes during the lifetime of VCL, use ``match``.
.. _vmod_re.regex:
.. _obj_regex:
regex(...)
----------
new xregex = re.regex(STRING, INT limit, INT limit_recursion)
-------------------------------------------------------------
::
......@@ -144,12 +137,12 @@ Description
The optional parameters ``limit`` and ``limit_recursion`` are
per-object defaults for the respective parameters of the
`func_regex.match`_ method.
`vmod_re.regex.match`_ method.
Example
``new myregex = re.regex("\bmax-age\s*=\s*(\d+)");``
.. _func_regex.match:
.. _vmod_re.regex.match:
BOOL xregex.match(STRING, INT limit, INT limit_recursion)
---------------------------------------------------------
......@@ -167,20 +160,19 @@ Description
internal matching function calls in a ``pcre_exec()``
execution, analogous to the varnishd ``pcre_match_limit``
parameter. For the default value 0, the ``limit`` given to the
constructor `obj_regex`_ is used.
constructor `vmod_re.regex`_ is used.
The optional parameter ``limit_recursion`` restricts the
number of internal matching function recursions in a
``pcre_exec()`` execution, analogous to the varnishd
``pcre_match_limit_recursion`` parameter. For the default
value 0, the ``limit_recursion`` given to the constructor
`obj_regex`_ is used.
`vmod_re.regex`_ is used.
Example
``if (myregex.match(beresp.http.Surrogate-Control)) { # ...``
.. _func_regex.backref:
.. _vmod_re.regex.backref:
STRING xregex.backref(INT, STRING fallback)
-------------------------------------------
......@@ -216,14 +208,10 @@ Description
Example
``set beresp.ttl = std.duration(myregex.backref(1, "120"), 120s);``
.. _vmod_re.match_dyn:
.. _func_match_dyn:
match_dyn(...)
--------------
BOOL match_dyn(STRING, STRING, INT limit, INT limit_recursion)
--------------------------------------------------------------
::
......@@ -245,14 +233,13 @@ Description
``false``.
For parameters ``limit`` and ``limit_recursion`` see
`func_regex.match`_, except that there is no object to inherit
`vmod_re.regex.match`_, except that there is no object to inherit
defaults from.
Example
``if (re.match_dyn(req.http.Foo + "(\d+)", beresp.http.Bar)) { # ...``
.. _func_backref_dyn:
.. _vmod_re.backref_dyn:
STRING backref_dyn(INT, STRING fallback)
----------------------------------------
......@@ -278,8 +265,7 @@ Description
in the same task scope, then a ``VCL_Error`` message is logged, and
the fallback string is returned.
.. _func_version:
.. _vmod_re.version:
STRING version()
----------------
......@@ -337,10 +323,6 @@ SEE ALSO
* source repository: https://code.uplex.de/uplex-varnish/libvmod-re
COPYRIGHT
=========
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment