Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
V
varnish-objvar
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Jobs
Commits
Open sidebar
uplex-varnish
varnish-objvar
Commits
d829df72
Commit
d829df72
authored
Sep 13, 2019
by
Nils Goroll
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
update generated RSTs
parent
8d0fa8cd
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
660 additions
and
660 deletions
+660
-660
vmod_constant.rst
src/vmod_constant.rst
+90
-90
vmod_globalvar.rst
src/vmod_globalvar.rst
+150
-150
vmod_taskvar.rst
src/vmod_taskvar.rst
+210
-210
vmod_topvar.rst
src/vmod_topvar.rst
+210
-210
No files found.
src/vmod_constant.rst
View file @
d829df72
...
@@ -20,95 +20,95 @@ SYNOPSIS
...
@@ -20,95 +20,95 @@ SYNOPSIS
import constant [as name] [from "path"]
import constant [as name] [from "path"]
:ref:`
vmod_constant.acl
`
:ref:`
constant.acl()
`
:ref:`
vmod_constant.acl.get
`
:ref:`
xacl.get()
`
:ref:`
vmod_constant.acl.defined
`
:ref:`
xacl.defined()
`
:ref:`
vmod_constant.backend
`
:ref:`
constant.backend()
`
:ref:`
vmod_constant.backend.get
`
:ref:`
xbackend.get()
`
:ref:`
vmod_constant.backend.defined
`
:ref:`
xbackend.defined()
`
:ref:`
vmod_constant.blob
`
:ref:`
constant.blob()
`
:ref:`
vmod_constant.blob.get
`
:ref:`
xblob.get()
`
:ref:`
vmod_constant.blob.defined
`
:ref:`
xblob.defined()
`
:ref:`
vmod_constant.body
`
:ref:`
constant.body()
`
:ref:`
vmod_constant.body.get
`
:ref:`
xbody.get()
`
:ref:`
vmod_constant.body.defined
`
:ref:`
xbody.defined()
`
:ref:`
vmod_constant.bool
`
:ref:`
constant.bool()
`
:ref:`
vmod_constant.bool.get
`
:ref:`
xbool.get()
`
:ref:`
vmod_constant.bool.defined
`
:ref:`
xbool.defined()
`
:ref:`
vmod_constant.bytes
`
:ref:`
constant.bytes()
`
:ref:`
vmod_constant.bytes.get
`
:ref:`
xbytes.get()
`
:ref:`
vmod_constant.bytes.defined
`
:ref:`
xbytes.defined()
`
:ref:`
vmod_constant.duration
`
:ref:`
constant.duration()
`
:ref:`
vmod_constant.duration.get
`
:ref:`
xduration.get()
`
:ref:`
vmod_constant.duration.defined
`
:ref:`
xduration.defined()
`
:ref:`
vmod_constant.header
`
:ref:`
constant.header()
`
:ref:`
vmod_constant.header.get
`
:ref:`
xheader.get()
`
:ref:`
vmod_constant.header.defined
`
:ref:`
xheader.defined()
`
:ref:`
vmod_constant.int
`
:ref:`
constant.int()
`
:ref:`
vmod_constant.int.get
`
:ref:`
xint.get()
`
:ref:`
vmod_constant.int.defined
`
:ref:`
xint.defined()
`
:ref:`
vmod_constant.ip
`
:ref:`
constant.ip()
`
:ref:`
vmod_constant.ip.get
`
:ref:`
xip.get()
`
:ref:`
vmod_constant.ip.defined
`
:ref:`
xip.defined()
`
:ref:`
vmod_constant.probe
`
:ref:`
constant.probe()
`
:ref:`
vmod_constant.probe.get
`
:ref:`
xprobe.get()
`
:ref:`
vmod_constant.probe.defined
`
:ref:`
xprobe.defined()
`
:ref:`
vmod_constant.real
`
:ref:`
constant.real()
`
:ref:`
vmod_constant.real.get
`
:ref:`
xreal.get()
`
:ref:`
vmod_constant.real.defined
`
:ref:`
xreal.defined()
`
:ref:`
vmod_constant.stevedore
`
:ref:`
constant.stevedore()
`
:ref:`
vmod_constant.stevedore.get
`
:ref:`
xstevedore.get()
`
:ref:`
vmod_constant.stevedore.defined
`
:ref:`
xstevedore.defined()
`
:ref:`
vmod_constant.string
`
:ref:`
constant.string()
`
:ref:`
vmod_constant.string.get
`
:ref:`
xstring.get()
`
:ref:`
vmod_constant.string.defined
`
:ref:`
xstring.defined()
`
:ref:`
vmod_constant.time
`
:ref:`
constant.time()
`
:ref:`
vmod_constant.time.get
`
:ref:`
xtime.get()
`
:ref:`
vmod_constant.time.defined
`
:ref:`
xtime.defined()
`
DESCRIPTION
DESCRIPTION
===========
===========
...
@@ -148,7 +148,7 @@ for the respective type names and the ``.get()`` fallback.
...
@@ -148,7 +148,7 @@ for the respective type names and the ``.get()`` fallback.
.. just a newline
.. just a newline
.. _
vmod_constant.acl
:
.. _
constant.acl()
:
new xacl = constant.acl([ACL init])
new xacl = constant.acl([ACL init])
-----------------------------------
-----------------------------------
...
@@ -157,7 +157,7 @@ Construct a(n) ACL constant with the value `init`,
...
@@ -157,7 +157,7 @@ Construct a(n) ACL constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.acl.get
:
.. _
xacl.get()
:
ACL xacl.get(ACL fallback)
ACL xacl.get(ACL fallback)
--------------------------
--------------------------
...
@@ -165,14 +165,14 @@ ACL xacl.get(ACL fallback)
...
@@ -165,14 +165,14 @@ ACL xacl.get(ACL fallback)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_constant.acl.defined
:
.. _
xacl.defined()
:
BOOL xacl.defined()
BOOL xacl.defined()
-------------------
-------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.backend
:
.. _
constant.backend()
:
new xbackend = constant.backend([BACKEND init])
new xbackend = constant.backend([BACKEND init])
-----------------------------------------------
-----------------------------------------------
...
@@ -181,7 +181,7 @@ Construct a(n) BACKEND constant with the value `init`,
...
@@ -181,7 +181,7 @@ Construct a(n) BACKEND constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.backend.get
:
.. _
xbackend.get()
:
BACKEND xbackend.get(BACKEND fallback=0)
BACKEND xbackend.get(BACKEND fallback=0)
----------------------------------------
----------------------------------------
...
@@ -189,14 +189,14 @@ BACKEND xbackend.get(BACKEND fallback=0)
...
@@ -189,14 +189,14 @@ BACKEND xbackend.get(BACKEND fallback=0)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is no backend.
if it is undefined. The default fallback is no backend.
.. _
vmod_constant.backend.defined
:
.. _
xbackend.defined()
:
BOOL xbackend.defined()
BOOL xbackend.defined()
-----------------------
-----------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.blob
:
.. _
constant.blob()
:
new xblob = constant.blob([BLOB init])
new xblob = constant.blob([BLOB init])
--------------------------------------
--------------------------------------
...
@@ -205,7 +205,7 @@ Construct a(n) BLOB constant with the value `init`,
...
@@ -205,7 +205,7 @@ Construct a(n) BLOB constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.blob.get
:
.. _
xblob.get()
:
BLOB xblob.get(BLOB fallback)
BLOB xblob.get(BLOB fallback)
-----------------------------
-----------------------------
...
@@ -213,14 +213,14 @@ BLOB xblob.get(BLOB fallback)
...
@@ -213,14 +213,14 @@ BLOB xblob.get(BLOB fallback)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_constant.blob.defined
:
.. _
xblob.defined()
:
BOOL xblob.defined()
BOOL xblob.defined()
--------------------
--------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.body
:
.. _
constant.body()
:
new xbody = constant.body([BODY init])
new xbody = constant.body([BODY init])
--------------------------------------
--------------------------------------
...
@@ -229,7 +229,7 @@ Construct a(n) BODY constant with the value `init`,
...
@@ -229,7 +229,7 @@ Construct a(n) BODY constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.body.get
:
.. _
xbody.get()
:
BODY xbody.get(BODY fallback)
BODY xbody.get(BODY fallback)
-----------------------------
-----------------------------
...
@@ -237,14 +237,14 @@ BODY xbody.get(BODY fallback)
...
@@ -237,14 +237,14 @@ BODY xbody.get(BODY fallback)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_constant.body.defined
:
.. _
xbody.defined()
:
BOOL xbody.defined()
BOOL xbody.defined()
--------------------
--------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.bool
:
.. _
constant.bool()
:
new xbool = constant.bool([BOOL init])
new xbool = constant.bool([BOOL init])
--------------------------------------
--------------------------------------
...
@@ -253,7 +253,7 @@ Construct a(n) BOOL constant with the value `init`,
...
@@ -253,7 +253,7 @@ Construct a(n) BOOL constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.bool.get
:
.. _
xbool.get()
:
BOOL xbool.get(BOOL fallback)
BOOL xbool.get(BOOL fallback)
-----------------------------
-----------------------------
...
@@ -261,14 +261,14 @@ BOOL xbool.get(BOOL fallback)
...
@@ -261,14 +261,14 @@ BOOL xbool.get(BOOL fallback)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_constant.bool.defined
:
.. _
xbool.defined()
:
BOOL xbool.defined()
BOOL xbool.defined()
--------------------
--------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.bytes
:
.. _
constant.bytes()
:
new xbytes = constant.bytes([BYTES init])
new xbytes = constant.bytes([BYTES init])
-----------------------------------------
-----------------------------------------
...
@@ -277,7 +277,7 @@ Construct a(n) BYTES constant with the value `init`,
...
@@ -277,7 +277,7 @@ Construct a(n) BYTES constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.bytes.get
:
.. _
xbytes.get()
:
BYTES xbytes.get(BYTES fallback)
BYTES xbytes.get(BYTES fallback)
--------------------------------
--------------------------------
...
@@ -285,14 +285,14 @@ BYTES xbytes.get(BYTES fallback)
...
@@ -285,14 +285,14 @@ BYTES xbytes.get(BYTES fallback)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_constant.bytes.defined
:
.. _
xbytes.defined()
:
BOOL xbytes.defined()
BOOL xbytes.defined()
---------------------
---------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.duration
:
.. _
constant.duration()
:
new xduration = constant.duration([DURATION init])
new xduration = constant.duration([DURATION init])
--------------------------------------------------
--------------------------------------------------
...
@@ -301,7 +301,7 @@ Construct a(n) DURATION constant with the value `init`,
...
@@ -301,7 +301,7 @@ Construct a(n) DURATION constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.duration.get
:
.. _
xduration.get()
:
DURATION xduration.get(DURATION fallback=0)
DURATION xduration.get(DURATION fallback=0)
-------------------------------------------
-------------------------------------------
...
@@ -309,14 +309,14 @@ DURATION xduration.get(DURATION fallback=0)
...
@@ -309,14 +309,14 @@ DURATION xduration.get(DURATION fallback=0)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is 0s.
if it is undefined. The default fallback is 0s.
.. _
vmod_constant.duration.defined
:
.. _
xduration.defined()
:
BOOL xduration.defined()
BOOL xduration.defined()
------------------------
------------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.header
:
.. _
constant.header()
:
new xheader = constant.header([HEADER init])
new xheader = constant.header([HEADER init])
--------------------------------------------
--------------------------------------------
...
@@ -325,7 +325,7 @@ Construct a(n) HEADER constant with the value `init`,
...
@@ -325,7 +325,7 @@ Construct a(n) HEADER constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.header.get
:
.. _
xheader.get()
:
HEADER xheader.get(HEADER fallback)
HEADER xheader.get(HEADER fallback)
-----------------------------------
-----------------------------------
...
@@ -333,14 +333,14 @@ HEADER xheader.get(HEADER fallback)
...
@@ -333,14 +333,14 @@ HEADER xheader.get(HEADER fallback)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_constant.header.defined
:
.. _
xheader.defined()
:
BOOL xheader.defined()
BOOL xheader.defined()
----------------------
----------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.int
:
.. _
constant.int()
:
new xint = constant.int([INT init])
new xint = constant.int([INT init])
-----------------------------------
-----------------------------------
...
@@ -349,7 +349,7 @@ Construct a(n) INT constant with the value `init`,
...
@@ -349,7 +349,7 @@ Construct a(n) INT constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.int.get
:
.. _
xint.get()
:
INT xint.get(INT fallback=0)
INT xint.get(INT fallback=0)
----------------------------
----------------------------
...
@@ -357,14 +357,14 @@ INT xint.get(INT fallback=0)
...
@@ -357,14 +357,14 @@ INT xint.get(INT fallback=0)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is 0.
if it is undefined. The default fallback is 0.
.. _
vmod_constant.int.defined
:
.. _
xint.defined()
:
BOOL xint.defined()
BOOL xint.defined()
-------------------
-------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.ip
:
.. _
constant.ip()
:
new xip = constant.ip([IP init])
new xip = constant.ip([IP init])
--------------------------------
--------------------------------
...
@@ -373,7 +373,7 @@ Construct a(n) IP constant with the value `init`,
...
@@ -373,7 +373,7 @@ Construct a(n) IP constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.ip.get
:
.. _
xip.get()
:
IP xip.get(IP fallback)
IP xip.get(IP fallback)
-----------------------
-----------------------
...
@@ -381,14 +381,14 @@ IP xip.get(IP fallback)
...
@@ -381,14 +381,14 @@ IP xip.get(IP fallback)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_constant.ip.defined
:
.. _
xip.defined()
:
BOOL xip.defined()
BOOL xip.defined()
------------------
------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.probe
:
.. _
constant.probe()
:
new xprobe = constant.probe([PROBE init])
new xprobe = constant.probe([PROBE init])
-----------------------------------------
-----------------------------------------
...
@@ -397,7 +397,7 @@ Construct a(n) PROBE constant with the value `init`,
...
@@ -397,7 +397,7 @@ Construct a(n) PROBE constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.probe.get
:
.. _
xprobe.get()
:
PROBE xprobe.get(PROBE fallback)
PROBE xprobe.get(PROBE fallback)
--------------------------------
--------------------------------
...
@@ -405,14 +405,14 @@ PROBE xprobe.get(PROBE fallback)
...
@@ -405,14 +405,14 @@ PROBE xprobe.get(PROBE fallback)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_constant.probe.defined
:
.. _
xprobe.defined()
:
BOOL xprobe.defined()
BOOL xprobe.defined()
---------------------
---------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.real
:
.. _
constant.real()
:
new xreal = constant.real([REAL init])
new xreal = constant.real([REAL init])
--------------------------------------
--------------------------------------
...
@@ -421,7 +421,7 @@ Construct a(n) REAL constant with the value `init`,
...
@@ -421,7 +421,7 @@ Construct a(n) REAL constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.real.get
:
.. _
xreal.get()
:
REAL xreal.get(REAL fallback=0.0)
REAL xreal.get(REAL fallback=0.0)
---------------------------------
---------------------------------
...
@@ -429,14 +429,14 @@ REAL xreal.get(REAL fallback=0.0)
...
@@ -429,14 +429,14 @@ REAL xreal.get(REAL fallback=0.0)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is 0.0.
if it is undefined. The default fallback is 0.0.
.. _
vmod_constant.real.defined
:
.. _
xreal.defined()
:
BOOL xreal.defined()
BOOL xreal.defined()
--------------------
--------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.stevedore
:
.. _
constant.stevedore()
:
new xstevedore = constant.stevedore([STEVEDORE init])
new xstevedore = constant.stevedore([STEVEDORE init])
-----------------------------------------------------
-----------------------------------------------------
...
@@ -445,7 +445,7 @@ Construct a(n) STEVEDORE constant with the value `init`,
...
@@ -445,7 +445,7 @@ Construct a(n) STEVEDORE constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.stevedore.get
:
.. _
xstevedore.get()
:
STEVEDORE xstevedore.get(STEVEDORE fallback)
STEVEDORE xstevedore.get(STEVEDORE fallback)
--------------------------------------------
--------------------------------------------
...
@@ -453,14 +453,14 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
...
@@ -453,14 +453,14 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_constant.stevedore.defined
:
.. _
xstevedore.defined()
:
BOOL xstevedore.defined()
BOOL xstevedore.defined()
-------------------------
-------------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.string
:
.. _
constant.string()
:
new xstring = constant.string([STRING init])
new xstring = constant.string([STRING init])
--------------------------------------------
--------------------------------------------
...
@@ -469,7 +469,7 @@ Construct a(n) STRING constant with the value `init`,
...
@@ -469,7 +469,7 @@ Construct a(n) STRING constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.string.get
:
.. _
xstring.get()
:
STRING xstring.get(STRING fallback=0)
STRING xstring.get(STRING fallback=0)
-------------------------------------
-------------------------------------
...
@@ -477,14 +477,14 @@ STRING xstring.get(STRING fallback=0)
...
@@ -477,14 +477,14 @@ STRING xstring.get(STRING fallback=0)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is the empty string.
if it is undefined. The default fallback is the empty string.
.. _
vmod_constant.string.defined
:
.. _
xstring.defined()
:
BOOL xstring.defined()
BOOL xstring.defined()
----------------------
----------------------
Return whether the constant is defined.
Return whether the constant is defined.
.. _
vmod_constant.time
:
.. _
constant.time()
:
new xtime = constant.time([TIME init])
new xtime = constant.time([TIME init])
--------------------------------------
--------------------------------------
...
@@ -493,7 +493,7 @@ Construct a(n) TIME constant with the value `init`,
...
@@ -493,7 +493,7 @@ Construct a(n) TIME constant with the value `init`,
if provided. If no `init` value is provided, the constant
if provided. If no `init` value is provided, the constant
will be undefined.
will be undefined.
.. _
vmod_constant.time.get
:
.. _
xtime.get()
:
TIME xtime.get(TIME fallback=0)
TIME xtime.get(TIME fallback=0)
-------------------------------
-------------------------------
...
@@ -501,7 +501,7 @@ TIME xtime.get(TIME fallback=0)
...
@@ -501,7 +501,7 @@ TIME xtime.get(TIME fallback=0)
Return the value of the constant or the `fallback` argument
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is the epoch (1970/1/1 0:00:00 GMT).
if it is undefined. The default fallback is the epoch (1970/1/1 0:00:00 GMT).
.. _
vmod_constant.time.defined
:
.. _
xtime.defined()
:
BOOL xtime.defined()
BOOL xtime.defined()
--------------------
--------------------
...
...
src/vmod_globalvar.rst
View file @
d829df72
...
@@ -20,155 +20,155 @@ SYNOPSIS
...
@@ -20,155 +20,155 @@ SYNOPSIS
import globalvar [as name] [from "path"]
import globalvar [as name] [from "path"]
:ref:`
vmod_globalvar.acl
`
:ref:`
globalvar.acl()
`
:ref:`
vmod_globalvar.acl.get
`
:ref:`
xacl.get()
`
:ref:`
vmod_globalvar.acl.set
`
:ref:`
xacl.set()
`
:ref:`
vmod_globalvar.acl.undefine
`
:ref:`
xacl.undefine()
`
:ref:`
vmod_globalvar.acl.defined
`
:ref:`
xacl.defined()
`
:ref:`
vmod_globalvar.backend
`
:ref:`
globalvar.backend()
`
:ref:`
vmod_globalvar.backend.get
`
:ref:`
xbackend.get()
`
:ref:`
vmod_globalvar.backend.set
`
:ref:`
xbackend.set()
`
:ref:`
vmod_globalvar.backend.undefine
`
:ref:`
xbackend.undefine()
`
:ref:`
vmod_globalvar.backend.defined
`
:ref:`
xbackend.defined()
`
:ref:`
vmod_globalvar.blob
`
:ref:`
globalvar.blob()
`
:ref:`
vmod_globalvar.blob.get
`
:ref:`
xblob.get()
`
:ref:`
vmod_globalvar.blob.set
`
:ref:`
xblob.set()
`
:ref:`
vmod_globalvar.blob.undefine
`
:ref:`
xblob.undefine()
`
:ref:`
vmod_globalvar.blob.defined
`
:ref:`
xblob.defined()
`
:ref:`
vmod_globalvar.body
`
:ref:`
globalvar.body()
`
:ref:`
vmod_globalvar.body.get
`
:ref:`
xbody.get()
`
:ref:`
vmod_globalvar.body.set
`
:ref:`
xbody.set()
`
:ref:`
vmod_globalvar.body.undefine
`
:ref:`
xbody.undefine()
`
:ref:`
vmod_globalvar.body.defined
`
:ref:`
xbody.defined()
`
:ref:`
vmod_globalvar.bool
`
:ref:`
globalvar.bool()
`
:ref:`
vmod_globalvar.bool.get
`
:ref:`
xbool.get()
`
:ref:`
vmod_globalvar.bool.set
`
:ref:`
xbool.set()
`
:ref:`
vmod_globalvar.bool.undefine
`
:ref:`
xbool.undefine()
`
:ref:`
vmod_globalvar.bool.defined
`
:ref:`
xbool.defined()
`
:ref:`
vmod_globalvar.bytes
`
:ref:`
globalvar.bytes()
`
:ref:`
vmod_globalvar.bytes.get
`
:ref:`
xbytes.get()
`
:ref:`
vmod_globalvar.bytes.set
`
:ref:`
xbytes.set()
`
:ref:`
vmod_globalvar.bytes.undefine
`
:ref:`
xbytes.undefine()
`
:ref:`
vmod_globalvar.bytes.defined
`
:ref:`
xbytes.defined()
`
:ref:`
vmod_globalvar.duration
`
:ref:`
globalvar.duration()
`
:ref:`
vmod_globalvar.duration.get
`
:ref:`
xduration.get()
`
:ref:`
vmod_globalvar.duration.set
`
:ref:`
xduration.set()
`
:ref:`
vmod_globalvar.duration.undefine
`
:ref:`
xduration.undefine()
`
:ref:`
vmod_globalvar.duration.defined
`
:ref:`
xduration.defined()
`
:ref:`
vmod_globalvar.header
`
:ref:`
globalvar.header()
`
:ref:`
vmod_globalvar.header.get
`
:ref:`
xheader.get()
`
:ref:`
vmod_globalvar.header.set
`
:ref:`
xheader.set()
`
:ref:`
vmod_globalvar.header.undefine
`
:ref:`
xheader.undefine()
`
:ref:`
vmod_globalvar.header.defined
`
:ref:`
xheader.defined()
`
:ref:`
vmod_globalvar.int
`
:ref:`
globalvar.int()
`
:ref:`
vmod_globalvar.int.get
`
:ref:`
xint.get()
`
:ref:`
vmod_globalvar.int.set
`
:ref:`
xint.set()
`
:ref:`
vmod_globalvar.int.undefine
`
:ref:`
xint.undefine()
`
:ref:`
vmod_globalvar.int.defined
`
:ref:`
xint.defined()
`
:ref:`
vmod_globalvar.ip
`
:ref:`
globalvar.ip()
`
:ref:`
vmod_globalvar.ip.get
`
:ref:`
xip.get()
`
:ref:`
vmod_globalvar.ip.set
`
:ref:`
xip.set()
`
:ref:`
vmod_globalvar.ip.undefine
`
:ref:`
xip.undefine()
`
:ref:`
vmod_globalvar.ip.defined
`
:ref:`
xip.defined()
`
:ref:`
vmod_globalvar.probe
`
:ref:`
globalvar.probe()
`
:ref:`
vmod_globalvar.probe.get
`
:ref:`
xprobe.get()
`
:ref:`
vmod_globalvar.probe.set
`
:ref:`
xprobe.set()
`
:ref:`
vmod_globalvar.probe.undefine
`
:ref:`
xprobe.undefine()
`
:ref:`
vmod_globalvar.probe.defined
`
:ref:`
xprobe.defined()
`
:ref:`
vmod_globalvar.real
`
:ref:`
globalvar.real()
`
:ref:`
vmod_globalvar.real.get
`
:ref:`
xreal.get()
`
:ref:`
vmod_globalvar.real.set
`
:ref:`
xreal.set()
`
:ref:`
vmod_globalvar.real.undefine
`
:ref:`
xreal.undefine()
`
:ref:`
vmod_globalvar.real.defined
`
:ref:`
xreal.defined()
`
:ref:`
vmod_globalvar.stevedore
`
:ref:`
globalvar.stevedore()
`
:ref:`
vmod_globalvar.stevedore.get
`
:ref:`
xstevedore.get()
`
:ref:`
vmod_globalvar.stevedore.set
`
:ref:`
xstevedore.set()
`
:ref:`
vmod_globalvar.stevedore.undefine
`
:ref:`
xstevedore.undefine()
`
:ref:`
vmod_globalvar.stevedore.defined
`
:ref:`
xstevedore.defined()
`
:ref:`
vmod_globalvar.string
`
:ref:`
globalvar.string()
`
:ref:`
vmod_globalvar.string.get
`
:ref:`
xstring.get()
`
:ref:`
vmod_globalvar.string.set
`
:ref:`
xstring.set()
`
:ref:`
vmod_globalvar.string.undefine
`
:ref:`
xstring.undefine()
`
:ref:`
vmod_globalvar.string.defined
`
:ref:`
xstring.defined()
`
:ref:`
vmod_globalvar.time
`
:ref:`
globalvar.time()
`
:ref:`
vmod_globalvar.time.get
`
:ref:`
xtime.get()
`
:ref:`
vmod_globalvar.time.set
`
:ref:`
xtime.set()
`
:ref:`
vmod_globalvar.time.undefine
`
:ref:`
xtime.undefine()
`
:ref:`
vmod_globalvar.time.defined
`
:ref:`
xtime.defined()
`
DESCRIPTION
DESCRIPTION
===========
===========
...
@@ -216,7 +216,7 @@ for the respective type names and the ``.get()`` fallback.
...
@@ -216,7 +216,7 @@ for the respective type names and the ``.get()`` fallback.
.. just a newline
.. just a newline
.. _
vmod_globalvar.acl
:
.. _
globalvar.acl()
:
new xacl = globalvar.acl([ACL init])
new xacl = globalvar.acl([ACL init])
------------------------------------
------------------------------------
...
@@ -225,7 +225,7 @@ Construct a(n) ACL globalvar with the default value `init`,
...
@@ -225,7 +225,7 @@ Construct a(n) ACL globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.acl.get
:
.. _
xacl.get()
:
ACL xacl.get(ACL fallback)
ACL xacl.get(ACL fallback)
--------------------------
--------------------------
...
@@ -233,28 +233,28 @@ ACL xacl.get(ACL fallback)
...
@@ -233,28 +233,28 @@ ACL xacl.get(ACL fallback)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_globalvar.acl.set
:
.. _
xacl.set()
:
VOID xacl.set(ACL)
VOID xacl.set(ACL)
------------------
------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.acl.undefine
:
.. _
xacl.undefine()
:
VOID xacl.undefine()
VOID xacl.undefine()
--------------------
--------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.acl.defined
:
.. _
xacl.defined()
:
BOOL xacl.defined()
BOOL xacl.defined()
-------------------
-------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.backend
:
.. _
globalvar.backend()
:
new xbackend = globalvar.backend([BACKEND init])
new xbackend = globalvar.backend([BACKEND init])
------------------------------------------------
------------------------------------------------
...
@@ -263,7 +263,7 @@ Construct a(n) BACKEND globalvar with the default value `init`,
...
@@ -263,7 +263,7 @@ Construct a(n) BACKEND globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.backend.get
:
.. _
xbackend.get()
:
BACKEND xbackend.get(BACKEND fallback=0)
BACKEND xbackend.get(BACKEND fallback=0)
----------------------------------------
----------------------------------------
...
@@ -271,28 +271,28 @@ BACKEND xbackend.get(BACKEND fallback=0)
...
@@ -271,28 +271,28 @@ BACKEND xbackend.get(BACKEND fallback=0)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is no backend.
if it is undefined. The default fallback is no backend.
.. _
vmod_globalvar.backend.set
:
.. _
xbackend.set()
:
VOID xbackend.set(BACKEND)
VOID xbackend.set(BACKEND)
--------------------------
--------------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.backend.undefine
:
.. _
xbackend.undefine()
:
VOID xbackend.undefine()
VOID xbackend.undefine()
------------------------
------------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.backend.defined
:
.. _
xbackend.defined()
:
BOOL xbackend.defined()
BOOL xbackend.defined()
-----------------------
-----------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.blob
:
.. _
globalvar.blob()
:
new xblob = globalvar.blob([BLOB init])
new xblob = globalvar.blob([BLOB init])
---------------------------------------
---------------------------------------
...
@@ -301,7 +301,7 @@ Construct a(n) BLOB globalvar with the default value `init`,
...
@@ -301,7 +301,7 @@ Construct a(n) BLOB globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.blob.get
:
.. _
xblob.get()
:
BLOB xblob.get(BLOB fallback)
BLOB xblob.get(BLOB fallback)
-----------------------------
-----------------------------
...
@@ -309,28 +309,28 @@ BLOB xblob.get(BLOB fallback)
...
@@ -309,28 +309,28 @@ BLOB xblob.get(BLOB fallback)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_globalvar.blob.set
:
.. _
xblob.set()
:
VOID xblob.set(BLOB)
VOID xblob.set(BLOB)
--------------------
--------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.blob.undefine
:
.. _
xblob.undefine()
:
VOID xblob.undefine()
VOID xblob.undefine()
---------------------
---------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.blob.defined
:
.. _
xblob.defined()
:
BOOL xblob.defined()
BOOL xblob.defined()
--------------------
--------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.body
:
.. _
globalvar.body()
:
new xbody = globalvar.body([BODY init])
new xbody = globalvar.body([BODY init])
---------------------------------------
---------------------------------------
...
@@ -339,7 +339,7 @@ Construct a(n) BODY globalvar with the default value `init`,
...
@@ -339,7 +339,7 @@ Construct a(n) BODY globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.body.get
:
.. _
xbody.get()
:
BODY xbody.get(BODY fallback)
BODY xbody.get(BODY fallback)
-----------------------------
-----------------------------
...
@@ -347,28 +347,28 @@ BODY xbody.get(BODY fallback)
...
@@ -347,28 +347,28 @@ BODY xbody.get(BODY fallback)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_globalvar.body.set
:
.. _
xbody.set()
:
VOID xbody.set(BODY)
VOID xbody.set(BODY)
--------------------
--------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.body.undefine
:
.. _
xbody.undefine()
:
VOID xbody.undefine()
VOID xbody.undefine()
---------------------
---------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.body.defined
:
.. _
xbody.defined()
:
BOOL xbody.defined()
BOOL xbody.defined()
--------------------
--------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.bool
:
.. _
globalvar.bool()
:
new xbool = globalvar.bool([BOOL init])
new xbool = globalvar.bool([BOOL init])
---------------------------------------
---------------------------------------
...
@@ -377,7 +377,7 @@ Construct a(n) BOOL globalvar with the default value `init`,
...
@@ -377,7 +377,7 @@ Construct a(n) BOOL globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.bool.get
:
.. _
xbool.get()
:
BOOL xbool.get(BOOL fallback)
BOOL xbool.get(BOOL fallback)
-----------------------------
-----------------------------
...
@@ -385,28 +385,28 @@ BOOL xbool.get(BOOL fallback)
...
@@ -385,28 +385,28 @@ BOOL xbool.get(BOOL fallback)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_globalvar.bool.set
:
.. _
xbool.set()
:
VOID xbool.set(BOOL)
VOID xbool.set(BOOL)
--------------------
--------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.bool.undefine
:
.. _
xbool.undefine()
:
VOID xbool.undefine()
VOID xbool.undefine()
---------------------
---------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.bool.defined
:
.. _
xbool.defined()
:
BOOL xbool.defined()
BOOL xbool.defined()
--------------------
--------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.bytes
:
.. _
globalvar.bytes()
:
new xbytes = globalvar.bytes([BYTES init])
new xbytes = globalvar.bytes([BYTES init])
------------------------------------------
------------------------------------------
...
@@ -415,7 +415,7 @@ Construct a(n) BYTES globalvar with the default value `init`,
...
@@ -415,7 +415,7 @@ Construct a(n) BYTES globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.bytes.get
:
.. _
xbytes.get()
:
BYTES xbytes.get(BYTES fallback)
BYTES xbytes.get(BYTES fallback)
--------------------------------
--------------------------------
...
@@ -423,28 +423,28 @@ BYTES xbytes.get(BYTES fallback)
...
@@ -423,28 +423,28 @@ BYTES xbytes.get(BYTES fallback)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_globalvar.bytes.set
:
.. _
xbytes.set()
:
VOID xbytes.set(BYTES)
VOID xbytes.set(BYTES)
----------------------
----------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.bytes.undefine
:
.. _
xbytes.undefine()
:
VOID xbytes.undefine()
VOID xbytes.undefine()
----------------------
----------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.bytes.defined
:
.. _
xbytes.defined()
:
BOOL xbytes.defined()
BOOL xbytes.defined()
---------------------
---------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.duration
:
.. _
globalvar.duration()
:
new xduration = globalvar.duration([DURATION init])
new xduration = globalvar.duration([DURATION init])
---------------------------------------------------
---------------------------------------------------
...
@@ -453,7 +453,7 @@ Construct a(n) DURATION globalvar with the default value `init`,
...
@@ -453,7 +453,7 @@ Construct a(n) DURATION globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.duration.get
:
.. _
xduration.get()
:
DURATION xduration.get(DURATION fallback=0)
DURATION xduration.get(DURATION fallback=0)
-------------------------------------------
-------------------------------------------
...
@@ -461,28 +461,28 @@ DURATION xduration.get(DURATION fallback=0)
...
@@ -461,28 +461,28 @@ DURATION xduration.get(DURATION fallback=0)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is 0s.
if it is undefined. The default fallback is 0s.
.. _
vmod_globalvar.duration.set
:
.. _
xduration.set()
:
VOID xduration.set(DURATION)
VOID xduration.set(DURATION)
----------------------------
----------------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.duration.undefine
:
.. _
xduration.undefine()
:
VOID xduration.undefine()
VOID xduration.undefine()
-------------------------
-------------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.duration.defined
:
.. _
xduration.defined()
:
BOOL xduration.defined()
BOOL xduration.defined()
------------------------
------------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.header
:
.. _
globalvar.header()
:
new xheader = globalvar.header([HEADER init])
new xheader = globalvar.header([HEADER init])
---------------------------------------------
---------------------------------------------
...
@@ -491,7 +491,7 @@ Construct a(n) HEADER globalvar with the default value `init`,
...
@@ -491,7 +491,7 @@ Construct a(n) HEADER globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.header.get
:
.. _
xheader.get()
:
HEADER xheader.get(HEADER fallback)
HEADER xheader.get(HEADER fallback)
-----------------------------------
-----------------------------------
...
@@ -499,28 +499,28 @@ HEADER xheader.get(HEADER fallback)
...
@@ -499,28 +499,28 @@ HEADER xheader.get(HEADER fallback)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_globalvar.header.set
:
.. _
xheader.set()
:
VOID xheader.set(HEADER)
VOID xheader.set(HEADER)
------------------------
------------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.header.undefine
:
.. _
xheader.undefine()
:
VOID xheader.undefine()
VOID xheader.undefine()
-----------------------
-----------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.header.defined
:
.. _
xheader.defined()
:
BOOL xheader.defined()
BOOL xheader.defined()
----------------------
----------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.int
:
.. _
globalvar.int()
:
new xint = globalvar.int([INT init])
new xint = globalvar.int([INT init])
------------------------------------
------------------------------------
...
@@ -529,7 +529,7 @@ Construct a(n) INT globalvar with the default value `init`,
...
@@ -529,7 +529,7 @@ Construct a(n) INT globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.int.get
:
.. _
xint.get()
:
INT xint.get(INT fallback=0)
INT xint.get(INT fallback=0)
----------------------------
----------------------------
...
@@ -537,28 +537,28 @@ INT xint.get(INT fallback=0)
...
@@ -537,28 +537,28 @@ INT xint.get(INT fallback=0)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is 0.
if it is undefined. The default fallback is 0.
.. _
vmod_globalvar.int.set
:
.. _
xint.set()
:
VOID xint.set(INT)
VOID xint.set(INT)
------------------
------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.int.undefine
:
.. _
xint.undefine()
:
VOID xint.undefine()
VOID xint.undefine()
--------------------
--------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.int.defined
:
.. _
xint.defined()
:
BOOL xint.defined()
BOOL xint.defined()
-------------------
-------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.ip
:
.. _
globalvar.ip()
:
new xip = globalvar.ip([IP init])
new xip = globalvar.ip([IP init])
---------------------------------
---------------------------------
...
@@ -567,7 +567,7 @@ Construct a(n) IP globalvar with the default value `init`,
...
@@ -567,7 +567,7 @@ Construct a(n) IP globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.ip.get
:
.. _
xip.get()
:
IP xip.get(IP fallback)
IP xip.get(IP fallback)
-----------------------
-----------------------
...
@@ -575,28 +575,28 @@ IP xip.get(IP fallback)
...
@@ -575,28 +575,28 @@ IP xip.get(IP fallback)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_globalvar.ip.set
:
.. _
xip.set()
:
VOID xip.set(IP)
VOID xip.set(IP)
----------------
----------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.ip.undefine
:
.. _
xip.undefine()
:
VOID xip.undefine()
VOID xip.undefine()
-------------------
-------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.ip.defined
:
.. _
xip.defined()
:
BOOL xip.defined()
BOOL xip.defined()
------------------
------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.probe
:
.. _
globalvar.probe()
:
new xprobe = globalvar.probe([PROBE init])
new xprobe = globalvar.probe([PROBE init])
------------------------------------------
------------------------------------------
...
@@ -605,7 +605,7 @@ Construct a(n) PROBE globalvar with the default value `init`,
...
@@ -605,7 +605,7 @@ Construct a(n) PROBE globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.probe.get
:
.. _
xprobe.get()
:
PROBE xprobe.get(PROBE fallback)
PROBE xprobe.get(PROBE fallback)
--------------------------------
--------------------------------
...
@@ -613,28 +613,28 @@ PROBE xprobe.get(PROBE fallback)
...
@@ -613,28 +613,28 @@ PROBE xprobe.get(PROBE fallback)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_globalvar.probe.set
:
.. _
xprobe.set()
:
VOID xprobe.set(PROBE)
VOID xprobe.set(PROBE)
----------------------
----------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.probe.undefine
:
.. _
xprobe.undefine()
:
VOID xprobe.undefine()
VOID xprobe.undefine()
----------------------
----------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.probe.defined
:
.. _
xprobe.defined()
:
BOOL xprobe.defined()
BOOL xprobe.defined()
---------------------
---------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.real
:
.. _
globalvar.real()
:
new xreal = globalvar.real([REAL init])
new xreal = globalvar.real([REAL init])
---------------------------------------
---------------------------------------
...
@@ -643,7 +643,7 @@ Construct a(n) REAL globalvar with the default value `init`,
...
@@ -643,7 +643,7 @@ Construct a(n) REAL globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.real.get
:
.. _
xreal.get()
:
REAL xreal.get(REAL fallback=0.0)
REAL xreal.get(REAL fallback=0.0)
---------------------------------
---------------------------------
...
@@ -651,28 +651,28 @@ REAL xreal.get(REAL fallback=0.0)
...
@@ -651,28 +651,28 @@ REAL xreal.get(REAL fallback=0.0)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is 0.0.
if it is undefined. The default fallback is 0.0.
.. _
vmod_globalvar.real.set
:
.. _
xreal.set()
:
VOID xreal.set(REAL)
VOID xreal.set(REAL)
--------------------
--------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.real.undefine
:
.. _
xreal.undefine()
:
VOID xreal.undefine()
VOID xreal.undefine()
---------------------
---------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.real.defined
:
.. _
xreal.defined()
:
BOOL xreal.defined()
BOOL xreal.defined()
--------------------
--------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.stevedore
:
.. _
globalvar.stevedore()
:
new xstevedore = globalvar.stevedore([STEVEDORE init])
new xstevedore = globalvar.stevedore([STEVEDORE init])
------------------------------------------------------
------------------------------------------------------
...
@@ -681,7 +681,7 @@ Construct a(n) STEVEDORE globalvar with the default value `init`,
...
@@ -681,7 +681,7 @@ Construct a(n) STEVEDORE globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.stevedore.get
:
.. _
xstevedore.get()
:
STEVEDORE xstevedore.get(STEVEDORE fallback)
STEVEDORE xstevedore.get(STEVEDORE fallback)
--------------------------------------------
--------------------------------------------
...
@@ -689,28 +689,28 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
...
@@ -689,28 +689,28 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_globalvar.stevedore.set
:
.. _
xstevedore.set()
:
VOID xstevedore.set(STEVEDORE)
VOID xstevedore.set(STEVEDORE)
------------------------------
------------------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.stevedore.undefine
:
.. _
xstevedore.undefine()
:
VOID xstevedore.undefine()
VOID xstevedore.undefine()
--------------------------
--------------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.stevedore.defined
:
.. _
xstevedore.defined()
:
BOOL xstevedore.defined()
BOOL xstevedore.defined()
-------------------------
-------------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.string
:
.. _
globalvar.string()
:
new xstring = globalvar.string([STRING init])
new xstring = globalvar.string([STRING init])
---------------------------------------------
---------------------------------------------
...
@@ -719,7 +719,7 @@ Construct a(n) STRING globalvar with the default value `init`,
...
@@ -719,7 +719,7 @@ Construct a(n) STRING globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.string.get
:
.. _
xstring.get()
:
STRING xstring.get(STRING fallback=0)
STRING xstring.get(STRING fallback=0)
-------------------------------------
-------------------------------------
...
@@ -727,28 +727,28 @@ STRING xstring.get(STRING fallback=0)
...
@@ -727,28 +727,28 @@ STRING xstring.get(STRING fallback=0)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is the empty string.
if it is undefined. The default fallback is the empty string.
.. _
vmod_globalvar.string.set
:
.. _
xstring.set()
:
VOID xstring.set(STRING)
VOID xstring.set(STRING)
------------------------
------------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.string.undefine
:
.. _
xstring.undefine()
:
VOID xstring.undefine()
VOID xstring.undefine()
-----------------------
-----------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.string.defined
:
.. _
xstring.defined()
:
BOOL xstring.defined()
BOOL xstring.defined()
----------------------
----------------------
Return whether the globalvar is defined.
Return whether the globalvar is defined.
.. _
vmod_globalvar.time
:
.. _
globalvar.time()
:
new xtime = globalvar.time([TIME init])
new xtime = globalvar.time([TIME init])
---------------------------------------
---------------------------------------
...
@@ -757,7 +757,7 @@ Construct a(n) TIME globalvar with the default value `init`,
...
@@ -757,7 +757,7 @@ Construct a(n) TIME globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_globalvar.time.get
:
.. _
xtime.get()
:
TIME xtime.get(TIME fallback=0)
TIME xtime.get(TIME fallback=0)
-------------------------------
-------------------------------
...
@@ -765,21 +765,21 @@ TIME xtime.get(TIME fallback=0)
...
@@ -765,21 +765,21 @@ TIME xtime.get(TIME fallback=0)
Return the value of the globalvar or the `fallback` argument
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is the epoch (1970/1/1 0:00:00 GMT).
if it is undefined. The default fallback is the epoch (1970/1/1 0:00:00 GMT).
.. _
vmod_globalvar.time.set
:
.. _
xtime.set()
:
VOID xtime.set(TIME)
VOID xtime.set(TIME)
--------------------
--------------------
Set the value of the globalvar.
Set the value of the globalvar.
.. _
vmod_globalvar.time.undefine
:
.. _
xtime.undefine()
:
VOID xtime.undefine()
VOID xtime.undefine()
---------------------
---------------------
Undefine the globalvar.
Undefine the globalvar.
.. _
vmod_globalvar.time.defined
:
.. _
xtime.defined()
:
BOOL xtime.defined()
BOOL xtime.defined()
--------------------
--------------------
...
...
src/vmod_taskvar.rst
View file @
d829df72
...
@@ -20,215 +20,215 @@ SYNOPSIS
...
@@ -20,215 +20,215 @@ SYNOPSIS
import taskvar [as name] [from "path"]
import taskvar [as name] [from "path"]
:ref:`
vmod_taskvar.acl
`
:ref:`
taskvar.acl()
`
:ref:`
vmod_taskvar.acl.get
`
:ref:`
xacl.get()
`
:ref:`
vmod_taskvar.acl.set
`
:ref:`
xacl.set()
`
:ref:`
vmod_taskvar.acl.undefine
`
:ref:`
xacl.undefine()
`
:ref:`
vmod_taskvar.acl.defined
`
:ref:`
xacl.defined()
`
:ref:`
vmod_taskvar.acl.protect
`
:ref:`
xacl.protect()
`
:ref:`
vmod_taskvar.acl.protected
`
:ref:`
xacl.protected()
`
:ref:`
vmod_taskvar.backend
`
:ref:`
taskvar.backend()
`
:ref:`
vmod_taskvar.backend.get
`
:ref:`
xbackend.get()
`
:ref:`
vmod_taskvar.backend.set
`
:ref:`
xbackend.set()
`
:ref:`
vmod_taskvar.backend.undefine
`
:ref:`
xbackend.undefine()
`
:ref:`
vmod_taskvar.backend.defined
`
:ref:`
xbackend.defined()
`
:ref:`
vmod_taskvar.backend.protect
`
:ref:`
xbackend.protect()
`
:ref:`
vmod_taskvar.backend.protected
`
:ref:`
xbackend.protected()
`
:ref:`
vmod_taskvar.blob
`
:ref:`
taskvar.blob()
`
:ref:`
vmod_taskvar.blob.get
`
:ref:`
xblob.get()
`
:ref:`
vmod_taskvar.blob.set
`
:ref:`
xblob.set()
`
:ref:`
vmod_taskvar.blob.undefine
`
:ref:`
xblob.undefine()
`
:ref:`
vmod_taskvar.blob.defined
`
:ref:`
xblob.defined()
`
:ref:`
vmod_taskvar.blob.protect
`
:ref:`
xblob.protect()
`
:ref:`
vmod_taskvar.blob.protected
`
:ref:`
xblob.protected()
`
:ref:`
vmod_taskvar.body
`
:ref:`
taskvar.body()
`
:ref:`
vmod_taskvar.body.get
`
:ref:`
xbody.get()
`
:ref:`
vmod_taskvar.body.set
`
:ref:`
xbody.set()
`
:ref:`
vmod_taskvar.body.undefine
`
:ref:`
xbody.undefine()
`
:ref:`
vmod_taskvar.body.defined
`
:ref:`
xbody.defined()
`
:ref:`
vmod_taskvar.body.protect
`
:ref:`
xbody.protect()
`
:ref:`
vmod_taskvar.body.protected
`
:ref:`
xbody.protected()
`
:ref:`
vmod_taskvar.bool
`
:ref:`
taskvar.bool()
`
:ref:`
vmod_taskvar.bool.get
`
:ref:`
xbool.get()
`
:ref:`
vmod_taskvar.bool.set
`
:ref:`
xbool.set()
`
:ref:`
vmod_taskvar.bool.undefine
`
:ref:`
xbool.undefine()
`
:ref:`
vmod_taskvar.bool.defined
`
:ref:`
xbool.defined()
`
:ref:`
vmod_taskvar.bool.protect
`
:ref:`
xbool.protect()
`
:ref:`
vmod_taskvar.bool.protected
`
:ref:`
xbool.protected()
`
:ref:`
vmod_taskvar.bytes
`
:ref:`
taskvar.bytes()
`
:ref:`
vmod_taskvar.bytes.get
`
:ref:`
xbytes.get()
`
:ref:`
vmod_taskvar.bytes.set
`
:ref:`
xbytes.set()
`
:ref:`
vmod_taskvar.bytes.undefine
`
:ref:`
xbytes.undefine()
`
:ref:`
vmod_taskvar.bytes.defined
`
:ref:`
xbytes.defined()
`
:ref:`
vmod_taskvar.bytes.protect
`
:ref:`
xbytes.protect()
`
:ref:`
vmod_taskvar.bytes.protected
`
:ref:`
xbytes.protected()
`
:ref:`
vmod_taskvar.duration
`
:ref:`
taskvar.duration()
`
:ref:`
vmod_taskvar.duration.get
`
:ref:`
xduration.get()
`
:ref:`
vmod_taskvar.duration.set
`
:ref:`
xduration.set()
`
:ref:`
vmod_taskvar.duration.undefine
`
:ref:`
xduration.undefine()
`
:ref:`
vmod_taskvar.duration.defined
`
:ref:`
xduration.defined()
`
:ref:`
vmod_taskvar.duration.protect
`
:ref:`
xduration.protect()
`
:ref:`
vmod_taskvar.duration.protected
`
:ref:`
xduration.protected()
`
:ref:`
vmod_taskvar.header
`
:ref:`
taskvar.header()
`
:ref:`
vmod_taskvar.header.get
`
:ref:`
xheader.get()
`
:ref:`
vmod_taskvar.header.set
`
:ref:`
xheader.set()
`
:ref:`
vmod_taskvar.header.undefine
`
:ref:`
xheader.undefine()
`
:ref:`
vmod_taskvar.header.defined
`
:ref:`
xheader.defined()
`
:ref:`
vmod_taskvar.header.protect
`
:ref:`
xheader.protect()
`
:ref:`
vmod_taskvar.header.protected
`
:ref:`
xheader.protected()
`
:ref:`
vmod_taskvar.int
`
:ref:`
taskvar.int()
`
:ref:`
vmod_taskvar.int.get
`
:ref:`
xint.get()
`
:ref:`
vmod_taskvar.int.set
`
:ref:`
xint.set()
`
:ref:`
vmod_taskvar.int.undefine
`
:ref:`
xint.undefine()
`
:ref:`
vmod_taskvar.int.defined
`
:ref:`
xint.defined()
`
:ref:`
vmod_taskvar.int.protect
`
:ref:`
xint.protect()
`
:ref:`
vmod_taskvar.int.protected
`
:ref:`
xint.protected()
`
:ref:`
vmod_taskvar.ip
`
:ref:`
taskvar.ip()
`
:ref:`
vmod_taskvar.ip.get
`
:ref:`
xip.get()
`
:ref:`
vmod_taskvar.ip.set
`
:ref:`
xip.set()
`
:ref:`
vmod_taskvar.ip.undefine
`
:ref:`
xip.undefine()
`
:ref:`
vmod_taskvar.ip.defined
`
:ref:`
xip.defined()
`
:ref:`
vmod_taskvar.ip.protect
`
:ref:`
xip.protect()
`
:ref:`
vmod_taskvar.ip.protected
`
:ref:`
xip.protected()
`
:ref:`
vmod_taskvar.probe
`
:ref:`
taskvar.probe()
`
:ref:`
vmod_taskvar.probe.get
`
:ref:`
xprobe.get()
`
:ref:`
vmod_taskvar.probe.set
`
:ref:`
xprobe.set()
`
:ref:`
vmod_taskvar.probe.undefine
`
:ref:`
xprobe.undefine()
`
:ref:`
vmod_taskvar.probe.defined
`
:ref:`
xprobe.defined()
`
:ref:`
vmod_taskvar.probe.protect
`
:ref:`
xprobe.protect()
`
:ref:`
vmod_taskvar.probe.protected
`
:ref:`
xprobe.protected()
`
:ref:`
vmod_taskvar.real
`
:ref:`
taskvar.real()
`
:ref:`
vmod_taskvar.real.get
`
:ref:`
xreal.get()
`
:ref:`
vmod_taskvar.real.set
`
:ref:`
xreal.set()
`
:ref:`
vmod_taskvar.real.undefine
`
:ref:`
xreal.undefine()
`
:ref:`
vmod_taskvar.real.defined
`
:ref:`
xreal.defined()
`
:ref:`
vmod_taskvar.real.protect
`
:ref:`
xreal.protect()
`
:ref:`
vmod_taskvar.real.protected
`
:ref:`
xreal.protected()
`
:ref:`
vmod_taskvar.stevedore
`
:ref:`
taskvar.stevedore()
`
:ref:`
vmod_taskvar.stevedore.get
`
:ref:`
xstevedore.get()
`
:ref:`
vmod_taskvar.stevedore.set
`
:ref:`
xstevedore.set()
`
:ref:`
vmod_taskvar.stevedore.undefine
`
:ref:`
xstevedore.undefine()
`
:ref:`
vmod_taskvar.stevedore.defined
`
:ref:`
xstevedore.defined()
`
:ref:`
vmod_taskvar.stevedore.protect
`
:ref:`
xstevedore.protect()
`
:ref:`
vmod_taskvar.stevedore.protected
`
:ref:`
xstevedore.protected()
`
:ref:`
vmod_taskvar.string
`
:ref:`
taskvar.string()
`
:ref:`
vmod_taskvar.string.get
`
:ref:`
xstring.get()
`
:ref:`
vmod_taskvar.string.set
`
:ref:`
xstring.set()
`
:ref:`
vmod_taskvar.string.undefine
`
:ref:`
xstring.undefine()
`
:ref:`
vmod_taskvar.string.defined
`
:ref:`
xstring.defined()
`
:ref:`
vmod_taskvar.string.protect
`
:ref:`
xstring.protect()
`
:ref:`
vmod_taskvar.string.protected
`
:ref:`
xstring.protected()
`
:ref:`
vmod_taskvar.time
`
:ref:`
taskvar.time()
`
:ref:`
vmod_taskvar.time.get
`
:ref:`
xtime.get()
`
:ref:`
vmod_taskvar.time.set
`
:ref:`
xtime.set()
`
:ref:`
vmod_taskvar.time.undefine
`
:ref:`
xtime.undefine()
`
:ref:`
vmod_taskvar.time.defined
`
:ref:`
xtime.defined()
`
:ref:`
vmod_taskvar.time.protect
`
:ref:`
xtime.protect()
`
:ref:`
vmod_taskvar.time.protected
`
:ref:`
xtime.protected()
`
DESCRIPTION
DESCRIPTION
===========
===========
...
@@ -293,7 +293,7 @@ for the respective type names and the ``.get()`` fallback.
...
@@ -293,7 +293,7 @@ for the respective type names and the ``.get()`` fallback.
.. just a newline
.. just a newline
.. _
vmod_taskvar.acl
:
.. _
taskvar.acl()
:
new xacl = taskvar.acl([ACL init])
new xacl = taskvar.acl([ACL init])
----------------------------------
----------------------------------
...
@@ -302,7 +302,7 @@ Construct a(n) ACL taskvar with the default value `init`,
...
@@ -302,7 +302,7 @@ Construct a(n) ACL taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.acl.get
:
.. _
xacl.get()
:
ACL xacl.get(ACL fallback)
ACL xacl.get(ACL fallback)
--------------------------
--------------------------
...
@@ -310,7 +310,7 @@ ACL xacl.get(ACL fallback)
...
@@ -310,7 +310,7 @@ ACL xacl.get(ACL fallback)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_taskvar.acl.set
:
.. _
xacl.set()
:
VOID xacl.set(ACL)
VOID xacl.set(ACL)
------------------
------------------
...
@@ -319,21 +319,21 @@ Set the value of the taskvar.
...
@@ -319,21 +319,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.acl.undefine
:
.. _
xacl.undefine()
:
VOID xacl.undefine()
VOID xacl.undefine()
--------------------
--------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.acl.defined
:
.. _
xacl.defined()
:
BOOL xacl.defined()
BOOL xacl.defined()
-------------------
-------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.acl.protect
:
.. _
xacl.protect()
:
VOID xacl.protect()
VOID xacl.protect()
-------------------
-------------------
...
@@ -341,14 +341,14 @@ VOID xacl.protect()
...
@@ -341,14 +341,14 @@ VOID xacl.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.acl.protected
:
.. _
xacl.protected()
:
BOOL xacl.protected()
BOOL xacl.protected()
---------------------
---------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.backend
:
.. _
taskvar.backend()
:
new xbackend = taskvar.backend([BACKEND init])
new xbackend = taskvar.backend([BACKEND init])
----------------------------------------------
----------------------------------------------
...
@@ -357,7 +357,7 @@ Construct a(n) BACKEND taskvar with the default value `init`,
...
@@ -357,7 +357,7 @@ Construct a(n) BACKEND taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.backend.get
:
.. _
xbackend.get()
:
BACKEND xbackend.get(BACKEND fallback=0)
BACKEND xbackend.get(BACKEND fallback=0)
----------------------------------------
----------------------------------------
...
@@ -365,7 +365,7 @@ BACKEND xbackend.get(BACKEND fallback=0)
...
@@ -365,7 +365,7 @@ BACKEND xbackend.get(BACKEND fallback=0)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is no backend.
if it is undefined. The default fallback is no backend.
.. _
vmod_taskvar.backend.set
:
.. _
xbackend.set()
:
VOID xbackend.set(BACKEND)
VOID xbackend.set(BACKEND)
--------------------------
--------------------------
...
@@ -374,21 +374,21 @@ Set the value of the taskvar.
...
@@ -374,21 +374,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.backend.undefine
:
.. _
xbackend.undefine()
:
VOID xbackend.undefine()
VOID xbackend.undefine()
------------------------
------------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.backend.defined
:
.. _
xbackend.defined()
:
BOOL xbackend.defined()
BOOL xbackend.defined()
-----------------------
-----------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.backend.protect
:
.. _
xbackend.protect()
:
VOID xbackend.protect()
VOID xbackend.protect()
-----------------------
-----------------------
...
@@ -396,14 +396,14 @@ VOID xbackend.protect()
...
@@ -396,14 +396,14 @@ VOID xbackend.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.backend.protected
:
.. _
xbackend.protected()
:
BOOL xbackend.protected()
BOOL xbackend.protected()
-------------------------
-------------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.blob
:
.. _
taskvar.blob()
:
new xblob = taskvar.blob([BLOB init])
new xblob = taskvar.blob([BLOB init])
-------------------------------------
-------------------------------------
...
@@ -412,7 +412,7 @@ Construct a(n) BLOB taskvar with the default value `init`,
...
@@ -412,7 +412,7 @@ Construct a(n) BLOB taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.blob.get
:
.. _
xblob.get()
:
BLOB xblob.get(BLOB fallback)
BLOB xblob.get(BLOB fallback)
-----------------------------
-----------------------------
...
@@ -420,7 +420,7 @@ BLOB xblob.get(BLOB fallback)
...
@@ -420,7 +420,7 @@ BLOB xblob.get(BLOB fallback)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_taskvar.blob.set
:
.. _
xblob.set()
:
VOID xblob.set(BLOB)
VOID xblob.set(BLOB)
--------------------
--------------------
...
@@ -429,21 +429,21 @@ Set the value of the taskvar.
...
@@ -429,21 +429,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.blob.undefine
:
.. _
xblob.undefine()
:
VOID xblob.undefine()
VOID xblob.undefine()
---------------------
---------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.blob.defined
:
.. _
xblob.defined()
:
BOOL xblob.defined()
BOOL xblob.defined()
--------------------
--------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.blob.protect
:
.. _
xblob.protect()
:
VOID xblob.protect()
VOID xblob.protect()
--------------------
--------------------
...
@@ -451,14 +451,14 @@ VOID xblob.protect()
...
@@ -451,14 +451,14 @@ VOID xblob.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.blob.protected
:
.. _
xblob.protected()
:
BOOL xblob.protected()
BOOL xblob.protected()
----------------------
----------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.body
:
.. _
taskvar.body()
:
new xbody = taskvar.body([BODY init])
new xbody = taskvar.body([BODY init])
-------------------------------------
-------------------------------------
...
@@ -467,7 +467,7 @@ Construct a(n) BODY taskvar with the default value `init`,
...
@@ -467,7 +467,7 @@ Construct a(n) BODY taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.body.get
:
.. _
xbody.get()
:
BODY xbody.get(BODY fallback)
BODY xbody.get(BODY fallback)
-----------------------------
-----------------------------
...
@@ -475,7 +475,7 @@ BODY xbody.get(BODY fallback)
...
@@ -475,7 +475,7 @@ BODY xbody.get(BODY fallback)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_taskvar.body.set
:
.. _
xbody.set()
:
VOID xbody.set(BODY)
VOID xbody.set(BODY)
--------------------
--------------------
...
@@ -484,21 +484,21 @@ Set the value of the taskvar.
...
@@ -484,21 +484,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.body.undefine
:
.. _
xbody.undefine()
:
VOID xbody.undefine()
VOID xbody.undefine()
---------------------
---------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.body.defined
:
.. _
xbody.defined()
:
BOOL xbody.defined()
BOOL xbody.defined()
--------------------
--------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.body.protect
:
.. _
xbody.protect()
:
VOID xbody.protect()
VOID xbody.protect()
--------------------
--------------------
...
@@ -506,14 +506,14 @@ VOID xbody.protect()
...
@@ -506,14 +506,14 @@ VOID xbody.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.body.protected
:
.. _
xbody.protected()
:
BOOL xbody.protected()
BOOL xbody.protected()
----------------------
----------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.bool
:
.. _
taskvar.bool()
:
new xbool = taskvar.bool([BOOL init])
new xbool = taskvar.bool([BOOL init])
-------------------------------------
-------------------------------------
...
@@ -522,7 +522,7 @@ Construct a(n) BOOL taskvar with the default value `init`,
...
@@ -522,7 +522,7 @@ Construct a(n) BOOL taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.bool.get
:
.. _
xbool.get()
:
BOOL xbool.get(BOOL fallback)
BOOL xbool.get(BOOL fallback)
-----------------------------
-----------------------------
...
@@ -530,7 +530,7 @@ BOOL xbool.get(BOOL fallback)
...
@@ -530,7 +530,7 @@ BOOL xbool.get(BOOL fallback)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_taskvar.bool.set
:
.. _
xbool.set()
:
VOID xbool.set(BOOL)
VOID xbool.set(BOOL)
--------------------
--------------------
...
@@ -539,21 +539,21 @@ Set the value of the taskvar.
...
@@ -539,21 +539,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.bool.undefine
:
.. _
xbool.undefine()
:
VOID xbool.undefine()
VOID xbool.undefine()
---------------------
---------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.bool.defined
:
.. _
xbool.defined()
:
BOOL xbool.defined()
BOOL xbool.defined()
--------------------
--------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.bool.protect
:
.. _
xbool.protect()
:
VOID xbool.protect()
VOID xbool.protect()
--------------------
--------------------
...
@@ -561,14 +561,14 @@ VOID xbool.protect()
...
@@ -561,14 +561,14 @@ VOID xbool.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.bool.protected
:
.. _
xbool.protected()
:
BOOL xbool.protected()
BOOL xbool.protected()
----------------------
----------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.bytes
:
.. _
taskvar.bytes()
:
new xbytes = taskvar.bytes([BYTES init])
new xbytes = taskvar.bytes([BYTES init])
----------------------------------------
----------------------------------------
...
@@ -577,7 +577,7 @@ Construct a(n) BYTES taskvar with the default value `init`,
...
@@ -577,7 +577,7 @@ Construct a(n) BYTES taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.bytes.get
:
.. _
xbytes.get()
:
BYTES xbytes.get(BYTES fallback)
BYTES xbytes.get(BYTES fallback)
--------------------------------
--------------------------------
...
@@ -585,7 +585,7 @@ BYTES xbytes.get(BYTES fallback)
...
@@ -585,7 +585,7 @@ BYTES xbytes.get(BYTES fallback)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_taskvar.bytes.set
:
.. _
xbytes.set()
:
VOID xbytes.set(BYTES)
VOID xbytes.set(BYTES)
----------------------
----------------------
...
@@ -594,21 +594,21 @@ Set the value of the taskvar.
...
@@ -594,21 +594,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.bytes.undefine
:
.. _
xbytes.undefine()
:
VOID xbytes.undefine()
VOID xbytes.undefine()
----------------------
----------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.bytes.defined
:
.. _
xbytes.defined()
:
BOOL xbytes.defined()
BOOL xbytes.defined()
---------------------
---------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.bytes.protect
:
.. _
xbytes.protect()
:
VOID xbytes.protect()
VOID xbytes.protect()
---------------------
---------------------
...
@@ -616,14 +616,14 @@ VOID xbytes.protect()
...
@@ -616,14 +616,14 @@ VOID xbytes.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.bytes.protected
:
.. _
xbytes.protected()
:
BOOL xbytes.protected()
BOOL xbytes.protected()
-----------------------
-----------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.duration
:
.. _
taskvar.duration()
:
new xduration = taskvar.duration([DURATION init])
new xduration = taskvar.duration([DURATION init])
-------------------------------------------------
-------------------------------------------------
...
@@ -632,7 +632,7 @@ Construct a(n) DURATION taskvar with the default value `init`,
...
@@ -632,7 +632,7 @@ Construct a(n) DURATION taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.duration.get
:
.. _
xduration.get()
:
DURATION xduration.get(DURATION fallback=0)
DURATION xduration.get(DURATION fallback=0)
-------------------------------------------
-------------------------------------------
...
@@ -640,7 +640,7 @@ DURATION xduration.get(DURATION fallback=0)
...
@@ -640,7 +640,7 @@ DURATION xduration.get(DURATION fallback=0)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is 0s.
if it is undefined. The default fallback is 0s.
.. _
vmod_taskvar.duration.set
:
.. _
xduration.set()
:
VOID xduration.set(DURATION)
VOID xduration.set(DURATION)
----------------------------
----------------------------
...
@@ -649,21 +649,21 @@ Set the value of the taskvar.
...
@@ -649,21 +649,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.duration.undefine
:
.. _
xduration.undefine()
:
VOID xduration.undefine()
VOID xduration.undefine()
-------------------------
-------------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.duration.defined
:
.. _
xduration.defined()
:
BOOL xduration.defined()
BOOL xduration.defined()
------------------------
------------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.duration.protect
:
.. _
xduration.protect()
:
VOID xduration.protect()
VOID xduration.protect()
------------------------
------------------------
...
@@ -671,14 +671,14 @@ VOID xduration.protect()
...
@@ -671,14 +671,14 @@ VOID xduration.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.duration.protected
:
.. _
xduration.protected()
:
BOOL xduration.protected()
BOOL xduration.protected()
--------------------------
--------------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.header
:
.. _
taskvar.header()
:
new xheader = taskvar.header([HEADER init])
new xheader = taskvar.header([HEADER init])
-------------------------------------------
-------------------------------------------
...
@@ -687,7 +687,7 @@ Construct a(n) HEADER taskvar with the default value `init`,
...
@@ -687,7 +687,7 @@ Construct a(n) HEADER taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.header.get
:
.. _
xheader.get()
:
HEADER xheader.get(HEADER fallback)
HEADER xheader.get(HEADER fallback)
-----------------------------------
-----------------------------------
...
@@ -695,7 +695,7 @@ HEADER xheader.get(HEADER fallback)
...
@@ -695,7 +695,7 @@ HEADER xheader.get(HEADER fallback)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_taskvar.header.set
:
.. _
xheader.set()
:
VOID xheader.set(HEADER)
VOID xheader.set(HEADER)
------------------------
------------------------
...
@@ -704,21 +704,21 @@ Set the value of the taskvar.
...
@@ -704,21 +704,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.header.undefine
:
.. _
xheader.undefine()
:
VOID xheader.undefine()
VOID xheader.undefine()
-----------------------
-----------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.header.defined
:
.. _
xheader.defined()
:
BOOL xheader.defined()
BOOL xheader.defined()
----------------------
----------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.header.protect
:
.. _
xheader.protect()
:
VOID xheader.protect()
VOID xheader.protect()
----------------------
----------------------
...
@@ -726,14 +726,14 @@ VOID xheader.protect()
...
@@ -726,14 +726,14 @@ VOID xheader.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.header.protected
:
.. _
xheader.protected()
:
BOOL xheader.protected()
BOOL xheader.protected()
------------------------
------------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.int
:
.. _
taskvar.int()
:
new xint = taskvar.int([INT init])
new xint = taskvar.int([INT init])
----------------------------------
----------------------------------
...
@@ -742,7 +742,7 @@ Construct a(n) INT taskvar with the default value `init`,
...
@@ -742,7 +742,7 @@ Construct a(n) INT taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.int.get
:
.. _
xint.get()
:
INT xint.get(INT fallback=0)
INT xint.get(INT fallback=0)
----------------------------
----------------------------
...
@@ -750,7 +750,7 @@ INT xint.get(INT fallback=0)
...
@@ -750,7 +750,7 @@ INT xint.get(INT fallback=0)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is 0.
if it is undefined. The default fallback is 0.
.. _
vmod_taskvar.int.set
:
.. _
xint.set()
:
VOID xint.set(INT)
VOID xint.set(INT)
------------------
------------------
...
@@ -759,21 +759,21 @@ Set the value of the taskvar.
...
@@ -759,21 +759,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.int.undefine
:
.. _
xint.undefine()
:
VOID xint.undefine()
VOID xint.undefine()
--------------------
--------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.int.defined
:
.. _
xint.defined()
:
BOOL xint.defined()
BOOL xint.defined()
-------------------
-------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.int.protect
:
.. _
xint.protect()
:
VOID xint.protect()
VOID xint.protect()
-------------------
-------------------
...
@@ -781,14 +781,14 @@ VOID xint.protect()
...
@@ -781,14 +781,14 @@ VOID xint.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.int.protected
:
.. _
xint.protected()
:
BOOL xint.protected()
BOOL xint.protected()
---------------------
---------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.ip
:
.. _
taskvar.ip()
:
new xip = taskvar.ip([IP init])
new xip = taskvar.ip([IP init])
-------------------------------
-------------------------------
...
@@ -797,7 +797,7 @@ Construct a(n) IP taskvar with the default value `init`,
...
@@ -797,7 +797,7 @@ Construct a(n) IP taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.ip.get
:
.. _
xip.get()
:
IP xip.get(IP fallback)
IP xip.get(IP fallback)
-----------------------
-----------------------
...
@@ -805,7 +805,7 @@ IP xip.get(IP fallback)
...
@@ -805,7 +805,7 @@ IP xip.get(IP fallback)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_taskvar.ip.set
:
.. _
xip.set()
:
VOID xip.set(IP)
VOID xip.set(IP)
----------------
----------------
...
@@ -814,21 +814,21 @@ Set the value of the taskvar.
...
@@ -814,21 +814,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.ip.undefine
:
.. _
xip.undefine()
:
VOID xip.undefine()
VOID xip.undefine()
-------------------
-------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.ip.defined
:
.. _
xip.defined()
:
BOOL xip.defined()
BOOL xip.defined()
------------------
------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.ip.protect
:
.. _
xip.protect()
:
VOID xip.protect()
VOID xip.protect()
------------------
------------------
...
@@ -836,14 +836,14 @@ VOID xip.protect()
...
@@ -836,14 +836,14 @@ VOID xip.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.ip.protected
:
.. _
xip.protected()
:
BOOL xip.protected()
BOOL xip.protected()
--------------------
--------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.probe
:
.. _
taskvar.probe()
:
new xprobe = taskvar.probe([PROBE init])
new xprobe = taskvar.probe([PROBE init])
----------------------------------------
----------------------------------------
...
@@ -852,7 +852,7 @@ Construct a(n) PROBE taskvar with the default value `init`,
...
@@ -852,7 +852,7 @@ Construct a(n) PROBE taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.probe.get
:
.. _
xprobe.get()
:
PROBE xprobe.get(PROBE fallback)
PROBE xprobe.get(PROBE fallback)
--------------------------------
--------------------------------
...
@@ -860,7 +860,7 @@ PROBE xprobe.get(PROBE fallback)
...
@@ -860,7 +860,7 @@ PROBE xprobe.get(PROBE fallback)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_taskvar.probe.set
:
.. _
xprobe.set()
:
VOID xprobe.set(PROBE)
VOID xprobe.set(PROBE)
----------------------
----------------------
...
@@ -869,21 +869,21 @@ Set the value of the taskvar.
...
@@ -869,21 +869,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.probe.undefine
:
.. _
xprobe.undefine()
:
VOID xprobe.undefine()
VOID xprobe.undefine()
----------------------
----------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.probe.defined
:
.. _
xprobe.defined()
:
BOOL xprobe.defined()
BOOL xprobe.defined()
---------------------
---------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.probe.protect
:
.. _
xprobe.protect()
:
VOID xprobe.protect()
VOID xprobe.protect()
---------------------
---------------------
...
@@ -891,14 +891,14 @@ VOID xprobe.protect()
...
@@ -891,14 +891,14 @@ VOID xprobe.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.probe.protected
:
.. _
xprobe.protected()
:
BOOL xprobe.protected()
BOOL xprobe.protected()
-----------------------
-----------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.real
:
.. _
taskvar.real()
:
new xreal = taskvar.real([REAL init])
new xreal = taskvar.real([REAL init])
-------------------------------------
-------------------------------------
...
@@ -907,7 +907,7 @@ Construct a(n) REAL taskvar with the default value `init`,
...
@@ -907,7 +907,7 @@ Construct a(n) REAL taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.real.get
:
.. _
xreal.get()
:
REAL xreal.get(REAL fallback=0.0)
REAL xreal.get(REAL fallback=0.0)
---------------------------------
---------------------------------
...
@@ -915,7 +915,7 @@ REAL xreal.get(REAL fallback=0.0)
...
@@ -915,7 +915,7 @@ REAL xreal.get(REAL fallback=0.0)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is 0.0.
if it is undefined. The default fallback is 0.0.
.. _
vmod_taskvar.real.set
:
.. _
xreal.set()
:
VOID xreal.set(REAL)
VOID xreal.set(REAL)
--------------------
--------------------
...
@@ -924,21 +924,21 @@ Set the value of the taskvar.
...
@@ -924,21 +924,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.real.undefine
:
.. _
xreal.undefine()
:
VOID xreal.undefine()
VOID xreal.undefine()
---------------------
---------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.real.defined
:
.. _
xreal.defined()
:
BOOL xreal.defined()
BOOL xreal.defined()
--------------------
--------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.real.protect
:
.. _
xreal.protect()
:
VOID xreal.protect()
VOID xreal.protect()
--------------------
--------------------
...
@@ -946,14 +946,14 @@ VOID xreal.protect()
...
@@ -946,14 +946,14 @@ VOID xreal.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.real.protected
:
.. _
xreal.protected()
:
BOOL xreal.protected()
BOOL xreal.protected()
----------------------
----------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.stevedore
:
.. _
taskvar.stevedore()
:
new xstevedore = taskvar.stevedore([STEVEDORE init])
new xstevedore = taskvar.stevedore([STEVEDORE init])
----------------------------------------------------
----------------------------------------------------
...
@@ -962,7 +962,7 @@ Construct a(n) STEVEDORE taskvar with the default value `init`,
...
@@ -962,7 +962,7 @@ Construct a(n) STEVEDORE taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.stevedore.get
:
.. _
xstevedore.get()
:
STEVEDORE xstevedore.get(STEVEDORE fallback)
STEVEDORE xstevedore.get(STEVEDORE fallback)
--------------------------------------------
--------------------------------------------
...
@@ -970,7 +970,7 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
...
@@ -970,7 +970,7 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_taskvar.stevedore.set
:
.. _
xstevedore.set()
:
VOID xstevedore.set(STEVEDORE)
VOID xstevedore.set(STEVEDORE)
------------------------------
------------------------------
...
@@ -979,21 +979,21 @@ Set the value of the taskvar.
...
@@ -979,21 +979,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.stevedore.undefine
:
.. _
xstevedore.undefine()
:
VOID xstevedore.undefine()
VOID xstevedore.undefine()
--------------------------
--------------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.stevedore.defined
:
.. _
xstevedore.defined()
:
BOOL xstevedore.defined()
BOOL xstevedore.defined()
-------------------------
-------------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.stevedore.protect
:
.. _
xstevedore.protect()
:
VOID xstevedore.protect()
VOID xstevedore.protect()
-------------------------
-------------------------
...
@@ -1001,14 +1001,14 @@ VOID xstevedore.protect()
...
@@ -1001,14 +1001,14 @@ VOID xstevedore.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.stevedore.protected
:
.. _
xstevedore.protected()
:
BOOL xstevedore.protected()
BOOL xstevedore.protected()
---------------------------
---------------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.string
:
.. _
taskvar.string()
:
new xstring = taskvar.string([STRING init])
new xstring = taskvar.string([STRING init])
-------------------------------------------
-------------------------------------------
...
@@ -1017,7 +1017,7 @@ Construct a(n) STRING taskvar with the default value `init`,
...
@@ -1017,7 +1017,7 @@ Construct a(n) STRING taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.string.get
:
.. _
xstring.get()
:
STRING xstring.get(STRING fallback=0)
STRING xstring.get(STRING fallback=0)
-------------------------------------
-------------------------------------
...
@@ -1025,7 +1025,7 @@ STRING xstring.get(STRING fallback=0)
...
@@ -1025,7 +1025,7 @@ STRING xstring.get(STRING fallback=0)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is the empty string.
if it is undefined. The default fallback is the empty string.
.. _
vmod_taskvar.string.set
:
.. _
xstring.set()
:
VOID xstring.set(STRING)
VOID xstring.set(STRING)
------------------------
------------------------
...
@@ -1034,21 +1034,21 @@ Set the value of the taskvar.
...
@@ -1034,21 +1034,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.string.undefine
:
.. _
xstring.undefine()
:
VOID xstring.undefine()
VOID xstring.undefine()
-----------------------
-----------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.string.defined
:
.. _
xstring.defined()
:
BOOL xstring.defined()
BOOL xstring.defined()
----------------------
----------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.string.protect
:
.. _
xstring.protect()
:
VOID xstring.protect()
VOID xstring.protect()
----------------------
----------------------
...
@@ -1056,14 +1056,14 @@ VOID xstring.protect()
...
@@ -1056,14 +1056,14 @@ VOID xstring.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.string.protected
:
.. _
xstring.protected()
:
BOOL xstring.protected()
BOOL xstring.protected()
------------------------
------------------------
Return whether the taskvar is protected.
Return whether the taskvar is protected.
.. _
vmod_taskvar.time
:
.. _
taskvar.time()
:
new xtime = taskvar.time([TIME init])
new xtime = taskvar.time([TIME init])
-------------------------------------
-------------------------------------
...
@@ -1072,7 +1072,7 @@ Construct a(n) TIME taskvar with the default value `init`,
...
@@ -1072,7 +1072,7 @@ Construct a(n) TIME taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_taskvar.time.get
:
.. _
xtime.get()
:
TIME xtime.get(TIME fallback=0)
TIME xtime.get(TIME fallback=0)
-------------------------------
-------------------------------
...
@@ -1080,7 +1080,7 @@ TIME xtime.get(TIME fallback=0)
...
@@ -1080,7 +1080,7 @@ TIME xtime.get(TIME fallback=0)
Return the value of the taskvar or the `fallback` argument
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is the epoch (1970/1/1 0:00:00 GMT).
if it is undefined. The default fallback is the epoch (1970/1/1 0:00:00 GMT).
.. _
vmod_taskvar.time.set
:
.. _
xtime.set()
:
VOID xtime.set(TIME)
VOID xtime.set(TIME)
--------------------
--------------------
...
@@ -1089,21 +1089,21 @@ Set the value of the taskvar.
...
@@ -1089,21 +1089,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_taskvar.time.undefine
:
.. _
xtime.undefine()
:
VOID xtime.undefine()
VOID xtime.undefine()
---------------------
---------------------
Undefine the taskvar.
Undefine the taskvar.
.. _
vmod_taskvar.time.defined
:
.. _
xtime.defined()
:
BOOL xtime.defined()
BOOL xtime.defined()
--------------------
--------------------
Return whether the taskvar is defined.
Return whether the taskvar is defined.
.. _
vmod_taskvar.time.protect
:
.. _
xtime.protect()
:
VOID xtime.protect()
VOID xtime.protect()
--------------------
--------------------
...
@@ -1111,7 +1111,7 @@ VOID xtime.protect()
...
@@ -1111,7 +1111,7 @@ VOID xtime.protect()
Protect the taskvar, so any future .set() calls on it
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_taskvar.time.protected
:
.. _
xtime.protected()
:
BOOL xtime.protected()
BOOL xtime.protected()
----------------------
----------------------
...
...
src/vmod_topvar.rst
View file @
d829df72
...
@@ -20,215 +20,215 @@ SYNOPSIS
...
@@ -20,215 +20,215 @@ SYNOPSIS
import topvar [as name] [from "path"]
import topvar [as name] [from "path"]
:ref:`
vmod_topvar.acl
`
:ref:`
topvar.acl()
`
:ref:`
vmod_topvar.acl.get
`
:ref:`
xacl.get()
`
:ref:`
vmod_topvar.acl.set
`
:ref:`
xacl.set()
`
:ref:`
vmod_topvar.acl.undefine
`
:ref:`
xacl.undefine()
`
:ref:`
vmod_topvar.acl.defined
`
:ref:`
xacl.defined()
`
:ref:`
vmod_topvar.acl.protect
`
:ref:`
xacl.protect()
`
:ref:`
vmod_topvar.acl.protected
`
:ref:`
xacl.protected()
`
:ref:`
vmod_topvar.backend
`
:ref:`
topvar.backend()
`
:ref:`
vmod_topvar.backend.get
`
:ref:`
xbackend.get()
`
:ref:`
vmod_topvar.backend.set
`
:ref:`
xbackend.set()
`
:ref:`
vmod_topvar.backend.undefine
`
:ref:`
xbackend.undefine()
`
:ref:`
vmod_topvar.backend.defined
`
:ref:`
xbackend.defined()
`
:ref:`
vmod_topvar.backend.protect
`
:ref:`
xbackend.protect()
`
:ref:`
vmod_topvar.backend.protected
`
:ref:`
xbackend.protected()
`
:ref:`
vmod_topvar.blob
`
:ref:`
topvar.blob()
`
:ref:`
vmod_topvar.blob.get
`
:ref:`
xblob.get()
`
:ref:`
vmod_topvar.blob.set
`
:ref:`
xblob.set()
`
:ref:`
vmod_topvar.blob.undefine
`
:ref:`
xblob.undefine()
`
:ref:`
vmod_topvar.blob.defined
`
:ref:`
xblob.defined()
`
:ref:`
vmod_topvar.blob.protect
`
:ref:`
xblob.protect()
`
:ref:`
vmod_topvar.blob.protected
`
:ref:`
xblob.protected()
`
:ref:`
vmod_topvar.body
`
:ref:`
topvar.body()
`
:ref:`
vmod_topvar.body.get
`
:ref:`
xbody.get()
`
:ref:`
vmod_topvar.body.set
`
:ref:`
xbody.set()
`
:ref:`
vmod_topvar.body.undefine
`
:ref:`
xbody.undefine()
`
:ref:`
vmod_topvar.body.defined
`
:ref:`
xbody.defined()
`
:ref:`
vmod_topvar.body.protect
`
:ref:`
xbody.protect()
`
:ref:`
vmod_topvar.body.protected
`
:ref:`
xbody.protected()
`
:ref:`
vmod_topvar.bool
`
:ref:`
topvar.bool()
`
:ref:`
vmod_topvar.bool.get
`
:ref:`
xbool.get()
`
:ref:`
vmod_topvar.bool.set
`
:ref:`
xbool.set()
`
:ref:`
vmod_topvar.bool.undefine
`
:ref:`
xbool.undefine()
`
:ref:`
vmod_topvar.bool.defined
`
:ref:`
xbool.defined()
`
:ref:`
vmod_topvar.bool.protect
`
:ref:`
xbool.protect()
`
:ref:`
vmod_topvar.bool.protected
`
:ref:`
xbool.protected()
`
:ref:`
vmod_topvar.bytes
`
:ref:`
topvar.bytes()
`
:ref:`
vmod_topvar.bytes.get
`
:ref:`
xbytes.get()
`
:ref:`
vmod_topvar.bytes.set
`
:ref:`
xbytes.set()
`
:ref:`
vmod_topvar.bytes.undefine
`
:ref:`
xbytes.undefine()
`
:ref:`
vmod_topvar.bytes.defined
`
:ref:`
xbytes.defined()
`
:ref:`
vmod_topvar.bytes.protect
`
:ref:`
xbytes.protect()
`
:ref:`
vmod_topvar.bytes.protected
`
:ref:`
xbytes.protected()
`
:ref:`
vmod_topvar.duration
`
:ref:`
topvar.duration()
`
:ref:`
vmod_topvar.duration.get
`
:ref:`
xduration.get()
`
:ref:`
vmod_topvar.duration.set
`
:ref:`
xduration.set()
`
:ref:`
vmod_topvar.duration.undefine
`
:ref:`
xduration.undefine()
`
:ref:`
vmod_topvar.duration.defined
`
:ref:`
xduration.defined()
`
:ref:`
vmod_topvar.duration.protect
`
:ref:`
xduration.protect()
`
:ref:`
vmod_topvar.duration.protected
`
:ref:`
xduration.protected()
`
:ref:`
vmod_topvar.header
`
:ref:`
topvar.header()
`
:ref:`
vmod_topvar.header.get
`
:ref:`
xheader.get()
`
:ref:`
vmod_topvar.header.set
`
:ref:`
xheader.set()
`
:ref:`
vmod_topvar.header.undefine
`
:ref:`
xheader.undefine()
`
:ref:`
vmod_topvar.header.defined
`
:ref:`
xheader.defined()
`
:ref:`
vmod_topvar.header.protect
`
:ref:`
xheader.protect()
`
:ref:`
vmod_topvar.header.protected
`
:ref:`
xheader.protected()
`
:ref:`
vmod_topvar.int
`
:ref:`
topvar.int()
`
:ref:`
vmod_topvar.int.get
`
:ref:`
xint.get()
`
:ref:`
vmod_topvar.int.set
`
:ref:`
xint.set()
`
:ref:`
vmod_topvar.int.undefine
`
:ref:`
xint.undefine()
`
:ref:`
vmod_topvar.int.defined
`
:ref:`
xint.defined()
`
:ref:`
vmod_topvar.int.protect
`
:ref:`
xint.protect()
`
:ref:`
vmod_topvar.int.protected
`
:ref:`
xint.protected()
`
:ref:`
vmod_topvar.ip
`
:ref:`
topvar.ip()
`
:ref:`
vmod_topvar.ip.get
`
:ref:`
xip.get()
`
:ref:`
vmod_topvar.ip.set
`
:ref:`
xip.set()
`
:ref:`
vmod_topvar.ip.undefine
`
:ref:`
xip.undefine()
`
:ref:`
vmod_topvar.ip.defined
`
:ref:`
xip.defined()
`
:ref:`
vmod_topvar.ip.protect
`
:ref:`
xip.protect()
`
:ref:`
vmod_topvar.ip.protected
`
:ref:`
xip.protected()
`
:ref:`
vmod_topvar.probe
`
:ref:`
topvar.probe()
`
:ref:`
vmod_topvar.probe.get
`
:ref:`
xprobe.get()
`
:ref:`
vmod_topvar.probe.set
`
:ref:`
xprobe.set()
`
:ref:`
vmod_topvar.probe.undefine
`
:ref:`
xprobe.undefine()
`
:ref:`
vmod_topvar.probe.defined
`
:ref:`
xprobe.defined()
`
:ref:`
vmod_topvar.probe.protect
`
:ref:`
xprobe.protect()
`
:ref:`
vmod_topvar.probe.protected
`
:ref:`
xprobe.protected()
`
:ref:`
vmod_topvar.real
`
:ref:`
topvar.real()
`
:ref:`
vmod_topvar.real.get
`
:ref:`
xreal.get()
`
:ref:`
vmod_topvar.real.set
`
:ref:`
xreal.set()
`
:ref:`
vmod_topvar.real.undefine
`
:ref:`
xreal.undefine()
`
:ref:`
vmod_topvar.real.defined
`
:ref:`
xreal.defined()
`
:ref:`
vmod_topvar.real.protect
`
:ref:`
xreal.protect()
`
:ref:`
vmod_topvar.real.protected
`
:ref:`
xreal.protected()
`
:ref:`
vmod_topvar.stevedore
`
:ref:`
topvar.stevedore()
`
:ref:`
vmod_topvar.stevedore.get
`
:ref:`
xstevedore.get()
`
:ref:`
vmod_topvar.stevedore.set
`
:ref:`
xstevedore.set()
`
:ref:`
vmod_topvar.stevedore.undefine
`
:ref:`
xstevedore.undefine()
`
:ref:`
vmod_topvar.stevedore.defined
`
:ref:`
xstevedore.defined()
`
:ref:`
vmod_topvar.stevedore.protect
`
:ref:`
xstevedore.protect()
`
:ref:`
vmod_topvar.stevedore.protected
`
:ref:`
xstevedore.protected()
`
:ref:`
vmod_topvar.string
`
:ref:`
topvar.string()
`
:ref:`
vmod_topvar.string.get
`
:ref:`
xstring.get()
`
:ref:`
vmod_topvar.string.set
`
:ref:`
xstring.set()
`
:ref:`
vmod_topvar.string.undefine
`
:ref:`
xstring.undefine()
`
:ref:`
vmod_topvar.string.defined
`
:ref:`
xstring.defined()
`
:ref:`
vmod_topvar.string.protect
`
:ref:`
xstring.protect()
`
:ref:`
vmod_topvar.string.protected
`
:ref:`
xstring.protected()
`
:ref:`
vmod_topvar.time
`
:ref:`
topvar.time()
`
:ref:`
vmod_topvar.time.get
`
:ref:`
xtime.get()
`
:ref:`
vmod_topvar.time.set
`
:ref:`
xtime.set()
`
:ref:`
vmod_topvar.time.undefine
`
:ref:`
xtime.undefine()
`
:ref:`
vmod_topvar.time.defined
`
:ref:`
xtime.defined()
`
:ref:`
vmod_topvar.time.protect
`
:ref:`
xtime.protect()
`
:ref:`
vmod_topvar.time.protected
`
:ref:`
xtime.protected()
`
DESCRIPTION
DESCRIPTION
===========
===========
...
@@ -276,7 +276,7 @@ for the respective type names and the ``.get()`` fallback.
...
@@ -276,7 +276,7 @@ for the respective type names and the ``.get()`` fallback.
.. just a newline
.. just a newline
.. _
vmod_topvar.acl
:
.. _
topvar.acl()
:
new xacl = topvar.acl([ACL init])
new xacl = topvar.acl([ACL init])
---------------------------------
---------------------------------
...
@@ -285,7 +285,7 @@ Construct a(n) ACL topvar with the default value `init`,
...
@@ -285,7 +285,7 @@ Construct a(n) ACL topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.acl.get
:
.. _
xacl.get()
:
ACL xacl.get(ACL fallback)
ACL xacl.get(ACL fallback)
--------------------------
--------------------------
...
@@ -293,7 +293,7 @@ ACL xacl.get(ACL fallback)
...
@@ -293,7 +293,7 @@ ACL xacl.get(ACL fallback)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_topvar.acl.set
:
.. _
xacl.set()
:
VOID xacl.set(ACL)
VOID xacl.set(ACL)
------------------
------------------
...
@@ -302,21 +302,21 @@ Set the value of the topvar.
...
@@ -302,21 +302,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.acl.undefine
:
.. _
xacl.undefine()
:
VOID xacl.undefine()
VOID xacl.undefine()
--------------------
--------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.acl.defined
:
.. _
xacl.defined()
:
BOOL xacl.defined()
BOOL xacl.defined()
-------------------
-------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.acl.protect
:
.. _
xacl.protect()
:
VOID xacl.protect()
VOID xacl.protect()
-------------------
-------------------
...
@@ -324,14 +324,14 @@ VOID xacl.protect()
...
@@ -324,14 +324,14 @@ VOID xacl.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.acl.protected
:
.. _
xacl.protected()
:
BOOL xacl.protected()
BOOL xacl.protected()
---------------------
---------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.backend
:
.. _
topvar.backend()
:
new xbackend = topvar.backend([BACKEND init])
new xbackend = topvar.backend([BACKEND init])
---------------------------------------------
---------------------------------------------
...
@@ -340,7 +340,7 @@ Construct a(n) BACKEND topvar with the default value `init`,
...
@@ -340,7 +340,7 @@ Construct a(n) BACKEND topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.backend.get
:
.. _
xbackend.get()
:
BACKEND xbackend.get(BACKEND fallback=0)
BACKEND xbackend.get(BACKEND fallback=0)
----------------------------------------
----------------------------------------
...
@@ -348,7 +348,7 @@ BACKEND xbackend.get(BACKEND fallback=0)
...
@@ -348,7 +348,7 @@ BACKEND xbackend.get(BACKEND fallback=0)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is no backend.
if it is undefined. The default fallback is no backend.
.. _
vmod_topvar.backend.set
:
.. _
xbackend.set()
:
VOID xbackend.set(BACKEND)
VOID xbackend.set(BACKEND)
--------------------------
--------------------------
...
@@ -357,21 +357,21 @@ Set the value of the topvar.
...
@@ -357,21 +357,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.backend.undefine
:
.. _
xbackend.undefine()
:
VOID xbackend.undefine()
VOID xbackend.undefine()
------------------------
------------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.backend.defined
:
.. _
xbackend.defined()
:
BOOL xbackend.defined()
BOOL xbackend.defined()
-----------------------
-----------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.backend.protect
:
.. _
xbackend.protect()
:
VOID xbackend.protect()
VOID xbackend.protect()
-----------------------
-----------------------
...
@@ -379,14 +379,14 @@ VOID xbackend.protect()
...
@@ -379,14 +379,14 @@ VOID xbackend.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.backend.protected
:
.. _
xbackend.protected()
:
BOOL xbackend.protected()
BOOL xbackend.protected()
-------------------------
-------------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.blob
:
.. _
topvar.blob()
:
new xblob = topvar.blob([BLOB init])
new xblob = topvar.blob([BLOB init])
------------------------------------
------------------------------------
...
@@ -395,7 +395,7 @@ Construct a(n) BLOB topvar with the default value `init`,
...
@@ -395,7 +395,7 @@ Construct a(n) BLOB topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.blob.get
:
.. _
xblob.get()
:
BLOB xblob.get(BLOB fallback)
BLOB xblob.get(BLOB fallback)
-----------------------------
-----------------------------
...
@@ -403,7 +403,7 @@ BLOB xblob.get(BLOB fallback)
...
@@ -403,7 +403,7 @@ BLOB xblob.get(BLOB fallback)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_topvar.blob.set
:
.. _
xblob.set()
:
VOID xblob.set(BLOB)
VOID xblob.set(BLOB)
--------------------
--------------------
...
@@ -412,21 +412,21 @@ Set the value of the topvar.
...
@@ -412,21 +412,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.blob.undefine
:
.. _
xblob.undefine()
:
VOID xblob.undefine()
VOID xblob.undefine()
---------------------
---------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.blob.defined
:
.. _
xblob.defined()
:
BOOL xblob.defined()
BOOL xblob.defined()
--------------------
--------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.blob.protect
:
.. _
xblob.protect()
:
VOID xblob.protect()
VOID xblob.protect()
--------------------
--------------------
...
@@ -434,14 +434,14 @@ VOID xblob.protect()
...
@@ -434,14 +434,14 @@ VOID xblob.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.blob.protected
:
.. _
xblob.protected()
:
BOOL xblob.protected()
BOOL xblob.protected()
----------------------
----------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.body
:
.. _
topvar.body()
:
new xbody = topvar.body([BODY init])
new xbody = topvar.body([BODY init])
------------------------------------
------------------------------------
...
@@ -450,7 +450,7 @@ Construct a(n) BODY topvar with the default value `init`,
...
@@ -450,7 +450,7 @@ Construct a(n) BODY topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.body.get
:
.. _
xbody.get()
:
BODY xbody.get(BODY fallback)
BODY xbody.get(BODY fallback)
-----------------------------
-----------------------------
...
@@ -458,7 +458,7 @@ BODY xbody.get(BODY fallback)
...
@@ -458,7 +458,7 @@ BODY xbody.get(BODY fallback)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_topvar.body.set
:
.. _
xbody.set()
:
VOID xbody.set(BODY)
VOID xbody.set(BODY)
--------------------
--------------------
...
@@ -467,21 +467,21 @@ Set the value of the topvar.
...
@@ -467,21 +467,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.body.undefine
:
.. _
xbody.undefine()
:
VOID xbody.undefine()
VOID xbody.undefine()
---------------------
---------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.body.defined
:
.. _
xbody.defined()
:
BOOL xbody.defined()
BOOL xbody.defined()
--------------------
--------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.body.protect
:
.. _
xbody.protect()
:
VOID xbody.protect()
VOID xbody.protect()
--------------------
--------------------
...
@@ -489,14 +489,14 @@ VOID xbody.protect()
...
@@ -489,14 +489,14 @@ VOID xbody.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.body.protected
:
.. _
xbody.protected()
:
BOOL xbody.protected()
BOOL xbody.protected()
----------------------
----------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.bool
:
.. _
topvar.bool()
:
new xbool = topvar.bool([BOOL init])
new xbool = topvar.bool([BOOL init])
------------------------------------
------------------------------------
...
@@ -505,7 +505,7 @@ Construct a(n) BOOL topvar with the default value `init`,
...
@@ -505,7 +505,7 @@ Construct a(n) BOOL topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.bool.get
:
.. _
xbool.get()
:
BOOL xbool.get(BOOL fallback)
BOOL xbool.get(BOOL fallback)
-----------------------------
-----------------------------
...
@@ -513,7 +513,7 @@ BOOL xbool.get(BOOL fallback)
...
@@ -513,7 +513,7 @@ BOOL xbool.get(BOOL fallback)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_topvar.bool.set
:
.. _
xbool.set()
:
VOID xbool.set(BOOL)
VOID xbool.set(BOOL)
--------------------
--------------------
...
@@ -522,21 +522,21 @@ Set the value of the topvar.
...
@@ -522,21 +522,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.bool.undefine
:
.. _
xbool.undefine()
:
VOID xbool.undefine()
VOID xbool.undefine()
---------------------
---------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.bool.defined
:
.. _
xbool.defined()
:
BOOL xbool.defined()
BOOL xbool.defined()
--------------------
--------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.bool.protect
:
.. _
xbool.protect()
:
VOID xbool.protect()
VOID xbool.protect()
--------------------
--------------------
...
@@ -544,14 +544,14 @@ VOID xbool.protect()
...
@@ -544,14 +544,14 @@ VOID xbool.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.bool.protected
:
.. _
xbool.protected()
:
BOOL xbool.protected()
BOOL xbool.protected()
----------------------
----------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.bytes
:
.. _
topvar.bytes()
:
new xbytes = topvar.bytes([BYTES init])
new xbytes = topvar.bytes([BYTES init])
---------------------------------------
---------------------------------------
...
@@ -560,7 +560,7 @@ Construct a(n) BYTES topvar with the default value `init`,
...
@@ -560,7 +560,7 @@ Construct a(n) BYTES topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.bytes.get
:
.. _
xbytes.get()
:
BYTES xbytes.get(BYTES fallback)
BYTES xbytes.get(BYTES fallback)
--------------------------------
--------------------------------
...
@@ -568,7 +568,7 @@ BYTES xbytes.get(BYTES fallback)
...
@@ -568,7 +568,7 @@ BYTES xbytes.get(BYTES fallback)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_topvar.bytes.set
:
.. _
xbytes.set()
:
VOID xbytes.set(BYTES)
VOID xbytes.set(BYTES)
----------------------
----------------------
...
@@ -577,21 +577,21 @@ Set the value of the topvar.
...
@@ -577,21 +577,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.bytes.undefine
:
.. _
xbytes.undefine()
:
VOID xbytes.undefine()
VOID xbytes.undefine()
----------------------
----------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.bytes.defined
:
.. _
xbytes.defined()
:
BOOL xbytes.defined()
BOOL xbytes.defined()
---------------------
---------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.bytes.protect
:
.. _
xbytes.protect()
:
VOID xbytes.protect()
VOID xbytes.protect()
---------------------
---------------------
...
@@ -599,14 +599,14 @@ VOID xbytes.protect()
...
@@ -599,14 +599,14 @@ VOID xbytes.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.bytes.protected
:
.. _
xbytes.protected()
:
BOOL xbytes.protected()
BOOL xbytes.protected()
-----------------------
-----------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.duration
:
.. _
topvar.duration()
:
new xduration = topvar.duration([DURATION init])
new xduration = topvar.duration([DURATION init])
------------------------------------------------
------------------------------------------------
...
@@ -615,7 +615,7 @@ Construct a(n) DURATION topvar with the default value `init`,
...
@@ -615,7 +615,7 @@ Construct a(n) DURATION topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.duration.get
:
.. _
xduration.get()
:
DURATION xduration.get(DURATION fallback=0)
DURATION xduration.get(DURATION fallback=0)
-------------------------------------------
-------------------------------------------
...
@@ -623,7 +623,7 @@ DURATION xduration.get(DURATION fallback=0)
...
@@ -623,7 +623,7 @@ DURATION xduration.get(DURATION fallback=0)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is 0s.
if it is undefined. The default fallback is 0s.
.. _
vmod_topvar.duration.set
:
.. _
xduration.set()
:
VOID xduration.set(DURATION)
VOID xduration.set(DURATION)
----------------------------
----------------------------
...
@@ -632,21 +632,21 @@ Set the value of the topvar.
...
@@ -632,21 +632,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.duration.undefine
:
.. _
xduration.undefine()
:
VOID xduration.undefine()
VOID xduration.undefine()
-------------------------
-------------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.duration.defined
:
.. _
xduration.defined()
:
BOOL xduration.defined()
BOOL xduration.defined()
------------------------
------------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.duration.protect
:
.. _
xduration.protect()
:
VOID xduration.protect()
VOID xduration.protect()
------------------------
------------------------
...
@@ -654,14 +654,14 @@ VOID xduration.protect()
...
@@ -654,14 +654,14 @@ VOID xduration.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.duration.protected
:
.. _
xduration.protected()
:
BOOL xduration.protected()
BOOL xduration.protected()
--------------------------
--------------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.header
:
.. _
topvar.header()
:
new xheader = topvar.header([HEADER init])
new xheader = topvar.header([HEADER init])
------------------------------------------
------------------------------------------
...
@@ -670,7 +670,7 @@ Construct a(n) HEADER topvar with the default value `init`,
...
@@ -670,7 +670,7 @@ Construct a(n) HEADER topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.header.get
:
.. _
xheader.get()
:
HEADER xheader.get(HEADER fallback)
HEADER xheader.get(HEADER fallback)
-----------------------------------
-----------------------------------
...
@@ -678,7 +678,7 @@ HEADER xheader.get(HEADER fallback)
...
@@ -678,7 +678,7 @@ HEADER xheader.get(HEADER fallback)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_topvar.header.set
:
.. _
xheader.set()
:
VOID xheader.set(HEADER)
VOID xheader.set(HEADER)
------------------------
------------------------
...
@@ -687,21 +687,21 @@ Set the value of the topvar.
...
@@ -687,21 +687,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.header.undefine
:
.. _
xheader.undefine()
:
VOID xheader.undefine()
VOID xheader.undefine()
-----------------------
-----------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.header.defined
:
.. _
xheader.defined()
:
BOOL xheader.defined()
BOOL xheader.defined()
----------------------
----------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.header.protect
:
.. _
xheader.protect()
:
VOID xheader.protect()
VOID xheader.protect()
----------------------
----------------------
...
@@ -709,14 +709,14 @@ VOID xheader.protect()
...
@@ -709,14 +709,14 @@ VOID xheader.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.header.protected
:
.. _
xheader.protected()
:
BOOL xheader.protected()
BOOL xheader.protected()
------------------------
------------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.int
:
.. _
topvar.int()
:
new xint = topvar.int([INT init])
new xint = topvar.int([INT init])
---------------------------------
---------------------------------
...
@@ -725,7 +725,7 @@ Construct a(n) INT topvar with the default value `init`,
...
@@ -725,7 +725,7 @@ Construct a(n) INT topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.int.get
:
.. _
xint.get()
:
INT xint.get(INT fallback=0)
INT xint.get(INT fallback=0)
----------------------------
----------------------------
...
@@ -733,7 +733,7 @@ INT xint.get(INT fallback=0)
...
@@ -733,7 +733,7 @@ INT xint.get(INT fallback=0)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is 0.
if it is undefined. The default fallback is 0.
.. _
vmod_topvar.int.set
:
.. _
xint.set()
:
VOID xint.set(INT)
VOID xint.set(INT)
------------------
------------------
...
@@ -742,21 +742,21 @@ Set the value of the topvar.
...
@@ -742,21 +742,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.int.undefine
:
.. _
xint.undefine()
:
VOID xint.undefine()
VOID xint.undefine()
--------------------
--------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.int.defined
:
.. _
xint.defined()
:
BOOL xint.defined()
BOOL xint.defined()
-------------------
-------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.int.protect
:
.. _
xint.protect()
:
VOID xint.protect()
VOID xint.protect()
-------------------
-------------------
...
@@ -764,14 +764,14 @@ VOID xint.protect()
...
@@ -764,14 +764,14 @@ VOID xint.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.int.protected
:
.. _
xint.protected()
:
BOOL xint.protected()
BOOL xint.protected()
---------------------
---------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.ip
:
.. _
topvar.ip()
:
new xip = topvar.ip([IP init])
new xip = topvar.ip([IP init])
------------------------------
------------------------------
...
@@ -780,7 +780,7 @@ Construct a(n) IP topvar with the default value `init`,
...
@@ -780,7 +780,7 @@ Construct a(n) IP topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.ip.get
:
.. _
xip.get()
:
IP xip.get(IP fallback)
IP xip.get(IP fallback)
-----------------------
-----------------------
...
@@ -788,7 +788,7 @@ IP xip.get(IP fallback)
...
@@ -788,7 +788,7 @@ IP xip.get(IP fallback)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_topvar.ip.set
:
.. _
xip.set()
:
VOID xip.set(IP)
VOID xip.set(IP)
----------------
----------------
...
@@ -797,21 +797,21 @@ Set the value of the topvar.
...
@@ -797,21 +797,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.ip.undefine
:
.. _
xip.undefine()
:
VOID xip.undefine()
VOID xip.undefine()
-------------------
-------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.ip.defined
:
.. _
xip.defined()
:
BOOL xip.defined()
BOOL xip.defined()
------------------
------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.ip.protect
:
.. _
xip.protect()
:
VOID xip.protect()
VOID xip.protect()
------------------
------------------
...
@@ -819,14 +819,14 @@ VOID xip.protect()
...
@@ -819,14 +819,14 @@ VOID xip.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.ip.protected
:
.. _
xip.protected()
:
BOOL xip.protected()
BOOL xip.protected()
--------------------
--------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.probe
:
.. _
topvar.probe()
:
new xprobe = topvar.probe([PROBE init])
new xprobe = topvar.probe([PROBE init])
---------------------------------------
---------------------------------------
...
@@ -835,7 +835,7 @@ Construct a(n) PROBE topvar with the default value `init`,
...
@@ -835,7 +835,7 @@ Construct a(n) PROBE topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.probe.get
:
.. _
xprobe.get()
:
PROBE xprobe.get(PROBE fallback)
PROBE xprobe.get(PROBE fallback)
--------------------------------
--------------------------------
...
@@ -843,7 +843,7 @@ PROBE xprobe.get(PROBE fallback)
...
@@ -843,7 +843,7 @@ PROBE xprobe.get(PROBE fallback)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_topvar.probe.set
:
.. _
xprobe.set()
:
VOID xprobe.set(PROBE)
VOID xprobe.set(PROBE)
----------------------
----------------------
...
@@ -852,21 +852,21 @@ Set the value of the topvar.
...
@@ -852,21 +852,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.probe.undefine
:
.. _
xprobe.undefine()
:
VOID xprobe.undefine()
VOID xprobe.undefine()
----------------------
----------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.probe.defined
:
.. _
xprobe.defined()
:
BOOL xprobe.defined()
BOOL xprobe.defined()
---------------------
---------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.probe.protect
:
.. _
xprobe.protect()
:
VOID xprobe.protect()
VOID xprobe.protect()
---------------------
---------------------
...
@@ -874,14 +874,14 @@ VOID xprobe.protect()
...
@@ -874,14 +874,14 @@ VOID xprobe.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.probe.protected
:
.. _
xprobe.protected()
:
BOOL xprobe.protected()
BOOL xprobe.protected()
-----------------------
-----------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.real
:
.. _
topvar.real()
:
new xreal = topvar.real([REAL init])
new xreal = topvar.real([REAL init])
------------------------------------
------------------------------------
...
@@ -890,7 +890,7 @@ Construct a(n) REAL topvar with the default value `init`,
...
@@ -890,7 +890,7 @@ Construct a(n) REAL topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.real.get
:
.. _
xreal.get()
:
REAL xreal.get(REAL fallback=0.0)
REAL xreal.get(REAL fallback=0.0)
---------------------------------
---------------------------------
...
@@ -898,7 +898,7 @@ REAL xreal.get(REAL fallback=0.0)
...
@@ -898,7 +898,7 @@ REAL xreal.get(REAL fallback=0.0)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is 0.0.
if it is undefined. The default fallback is 0.0.
.. _
vmod_topvar.real.set
:
.. _
xreal.set()
:
VOID xreal.set(REAL)
VOID xreal.set(REAL)
--------------------
--------------------
...
@@ -907,21 +907,21 @@ Set the value of the topvar.
...
@@ -907,21 +907,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.real.undefine
:
.. _
xreal.undefine()
:
VOID xreal.undefine()
VOID xreal.undefine()
---------------------
---------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.real.defined
:
.. _
xreal.defined()
:
BOOL xreal.defined()
BOOL xreal.defined()
--------------------
--------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.real.protect
:
.. _
xreal.protect()
:
VOID xreal.protect()
VOID xreal.protect()
--------------------
--------------------
...
@@ -929,14 +929,14 @@ VOID xreal.protect()
...
@@ -929,14 +929,14 @@ VOID xreal.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.real.protected
:
.. _
xreal.protected()
:
BOOL xreal.protected()
BOOL xreal.protected()
----------------------
----------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.stevedore
:
.. _
topvar.stevedore()
:
new xstevedore = topvar.stevedore([STEVEDORE init])
new xstevedore = topvar.stevedore([STEVEDORE init])
---------------------------------------------------
---------------------------------------------------
...
@@ -945,7 +945,7 @@ Construct a(n) STEVEDORE topvar with the default value `init`,
...
@@ -945,7 +945,7 @@ Construct a(n) STEVEDORE topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.stevedore.get
:
.. _
xstevedore.get()
:
STEVEDORE xstevedore.get(STEVEDORE fallback)
STEVEDORE xstevedore.get(STEVEDORE fallback)
--------------------------------------------
--------------------------------------------
...
@@ -953,7 +953,7 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
...
@@ -953,7 +953,7 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined.
if it is undefined.
.. _
vmod_topvar.stevedore.set
:
.. _
xstevedore.set()
:
VOID xstevedore.set(STEVEDORE)
VOID xstevedore.set(STEVEDORE)
------------------------------
------------------------------
...
@@ -962,21 +962,21 @@ Set the value of the topvar.
...
@@ -962,21 +962,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.stevedore.undefine
:
.. _
xstevedore.undefine()
:
VOID xstevedore.undefine()
VOID xstevedore.undefine()
--------------------------
--------------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.stevedore.defined
:
.. _
xstevedore.defined()
:
BOOL xstevedore.defined()
BOOL xstevedore.defined()
-------------------------
-------------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.stevedore.protect
:
.. _
xstevedore.protect()
:
VOID xstevedore.protect()
VOID xstevedore.protect()
-------------------------
-------------------------
...
@@ -984,14 +984,14 @@ VOID xstevedore.protect()
...
@@ -984,14 +984,14 @@ VOID xstevedore.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.stevedore.protected
:
.. _
xstevedore.protected()
:
BOOL xstevedore.protected()
BOOL xstevedore.protected()
---------------------------
---------------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.string
:
.. _
topvar.string()
:
new xstring = topvar.string([STRING init])
new xstring = topvar.string([STRING init])
------------------------------------------
------------------------------------------
...
@@ -1000,7 +1000,7 @@ Construct a(n) STRING topvar with the default value `init`,
...
@@ -1000,7 +1000,7 @@ Construct a(n) STRING topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.string.get
:
.. _
xstring.get()
:
STRING xstring.get(STRING fallback=0)
STRING xstring.get(STRING fallback=0)
-------------------------------------
-------------------------------------
...
@@ -1008,7 +1008,7 @@ STRING xstring.get(STRING fallback=0)
...
@@ -1008,7 +1008,7 @@ STRING xstring.get(STRING fallback=0)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is the empty string.
if it is undefined. The default fallback is the empty string.
.. _
vmod_topvar.string.set
:
.. _
xstring.set()
:
VOID xstring.set(STRING)
VOID xstring.set(STRING)
------------------------
------------------------
...
@@ -1017,21 +1017,21 @@ Set the value of the topvar.
...
@@ -1017,21 +1017,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.string.undefine
:
.. _
xstring.undefine()
:
VOID xstring.undefine()
VOID xstring.undefine()
-----------------------
-----------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.string.defined
:
.. _
xstring.defined()
:
BOOL xstring.defined()
BOOL xstring.defined()
----------------------
----------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.string.protect
:
.. _
xstring.protect()
:
VOID xstring.protect()
VOID xstring.protect()
----------------------
----------------------
...
@@ -1039,14 +1039,14 @@ VOID xstring.protect()
...
@@ -1039,14 +1039,14 @@ VOID xstring.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.string.protected
:
.. _
xstring.protected()
:
BOOL xstring.protected()
BOOL xstring.protected()
------------------------
------------------------
Return whether the topvar is protected.
Return whether the topvar is protected.
.. _
vmod_topvar.time
:
.. _
topvar.time()
:
new xtime = topvar.time([TIME init])
new xtime = topvar.time([TIME init])
------------------------------------
------------------------------------
...
@@ -1055,7 +1055,7 @@ Construct a(n) TIME topvar with the default value `init`,
...
@@ -1055,7 +1055,7 @@ Construct a(n) TIME topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
if provided. If no `init` value is provided, the variable
will be initially undefined.
will be initially undefined.
.. _
vmod_topvar.time.get
:
.. _
xtime.get()
:
TIME xtime.get(TIME fallback=0)
TIME xtime.get(TIME fallback=0)
-------------------------------
-------------------------------
...
@@ -1063,7 +1063,7 @@ TIME xtime.get(TIME fallback=0)
...
@@ -1063,7 +1063,7 @@ TIME xtime.get(TIME fallback=0)
Return the value of the topvar or the `fallback` argument
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is the epoch (1970/1/1 0:00:00 GMT).
if it is undefined. The default fallback is the epoch (1970/1/1 0:00:00 GMT).
.. _
vmod_topvar.time.set
:
.. _
xtime.set()
:
VOID xtime.set(TIME)
VOID xtime.set(TIME)
--------------------
--------------------
...
@@ -1072,21 +1072,21 @@ Set the value of the topvar.
...
@@ -1072,21 +1072,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
Triggers a vcl failure for protected variables.
.. _
vmod_topvar.time.undefine
:
.. _
xtime.undefine()
:
VOID xtime.undefine()
VOID xtime.undefine()
---------------------
---------------------
Undefine the topvar.
Undefine the topvar.
.. _
vmod_topvar.time.defined
:
.. _
xtime.defined()
:
BOOL xtime.defined()
BOOL xtime.defined()
--------------------
--------------------
Return whether the topvar is defined.
Return whether the topvar is defined.
.. _
vmod_topvar.time.protect
:
.. _
xtime.protect()
:
VOID xtime.protect()
VOID xtime.protect()
--------------------
--------------------
...
@@ -1094,7 +1094,7 @@ VOID xtime.protect()
...
@@ -1094,7 +1094,7 @@ VOID xtime.protect()
Protect the topvar, so any future .set() calls on it
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
trigger a vcl failure.
.. _
vmod_topvar.time.protected
:
.. _
xtime.protected()
:
BOOL xtime.protected()
BOOL xtime.protected()
----------------------
----------------------
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment