Skip to content

V
varnish-objvar
Commit 1597ee14 authored by Nils Goroll's avatar Nils Goroll
Browse files
Options

auto-updated docs

parent 89d3c1b0
Hide whitespace changes
Inline Side-by-side
Showing with 660 additions and 660 deletions
src/vmod_constant.rst
View file @ 1597ee14
......@@ -20,95 +20,95 @@ SYNOPSIS
import constant [from "path"]
:ref:`obj_acl`
:ref:`vmod_constant.acl`
:ref:`func_acl.get`
:ref:`vmod_constant.acl.get`
:ref:`func_acl.defined`
:ref:`vmod_constant.acl.defined`
:ref:`obj_backend`
:ref:`vmod_constant.backend`
:ref:`func_backend.get`
:ref:`vmod_constant.backend.get`
:ref:`func_backend.defined`
:ref:`vmod_constant.backend.defined`
:ref:`obj_blob`
:ref:`vmod_constant.blob`
:ref:`func_blob.get`
:ref:`vmod_constant.blob.get`
:ref:`func_blob.defined`
:ref:`vmod_constant.blob.defined`
:ref:`obj_body`
:ref:`vmod_constant.body`
:ref:`func_body.get`
:ref:`vmod_constant.body.get`
:ref:`func_body.defined`
:ref:`vmod_constant.body.defined`
:ref:`obj_bool`
:ref:`vmod_constant.bool`
:ref:`func_bool.get`
:ref:`vmod_constant.bool.get`
:ref:`func_bool.defined`
:ref:`vmod_constant.bool.defined`
:ref:`obj_bytes`
:ref:`vmod_constant.bytes`
:ref:`func_bytes.get`
:ref:`vmod_constant.bytes.get`
:ref:`func_bytes.defined`
:ref:`vmod_constant.bytes.defined`
:ref:`obj_duration`
:ref:`vmod_constant.duration`
:ref:`func_duration.get`
:ref:`vmod_constant.duration.get`
:ref:`func_duration.defined`
:ref:`vmod_constant.duration.defined`
:ref:`obj_header`
:ref:`vmod_constant.header`
:ref:`func_header.get`
:ref:`vmod_constant.header.get`
:ref:`func_header.defined`
:ref:`vmod_constant.header.defined`
:ref:`obj_int`
:ref:`vmod_constant.int`
:ref:`func_int.get`
:ref:`vmod_constant.int.get`
:ref:`func_int.defined`
:ref:`vmod_constant.int.defined`
:ref:`obj_ip`
:ref:`vmod_constant.ip`
:ref:`func_ip.get`
:ref:`vmod_constant.ip.get`
:ref:`func_ip.defined`
:ref:`vmod_constant.ip.defined`
:ref:`obj_probe`
:ref:`vmod_constant.probe`
:ref:`func_probe.get`
:ref:`vmod_constant.probe.get`
:ref:`func_probe.defined`
:ref:`vmod_constant.probe.defined`
:ref:`obj_real`
:ref:`vmod_constant.real`
:ref:`func_real.get`
:ref:`vmod_constant.real.get`
:ref:`func_real.defined`
:ref:`vmod_constant.real.defined`
:ref:`obj_stevedore`
:ref:`vmod_constant.stevedore`
:ref:`func_stevedore.get`
:ref:`vmod_constant.stevedore.get`
:ref:`func_stevedore.defined`
:ref:`vmod_constant.stevedore.defined`
:ref:`obj_string`
:ref:`vmod_constant.string`
:ref:`func_string.get`
:ref:`vmod_constant.string.get`
:ref:`func_string.defined`
:ref:`vmod_constant.string.defined`
:ref:`obj_time`
:ref:`vmod_constant.time`
:ref:`func_time.get`
:ref:`vmod_constant.time.get`
:ref:`func_time.defined`
:ref:`vmod_constant.time.defined`
DESCRIPTION
......@@ -149,7 +149,7 @@ for the respective type names and the ``.get()`` fallback.
.. just a newline
.. _obj_acl:
.. _vmod_constant.acl:
new xacl = constant.acl([ACL init])
-----------------------------------
......@@ -158,7 +158,7 @@ Construct a(n) ACL constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_acl.get:
.. _vmod_constant.acl.get:
ACL xacl.get(ACL fallback)
--------------------------
......@@ -166,14 +166,14 @@ ACL xacl.get(ACL fallback)
Return the value of the constant or the `fallback` argument
if it is undefined.
.. _func_acl.defined:
.. _vmod_constant.acl.defined:
BOOL xacl.defined()
-------------------
Return whether the constant is defined.
.. _obj_backend:
.. _vmod_constant.backend:
new xbackend = constant.backend([BACKEND init])
-----------------------------------------------
......@@ -182,7 +182,7 @@ Construct a(n) BACKEND constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_backend.get:
.. _vmod_constant.backend.get:
BACKEND xbackend.get(BACKEND fallback=0)
----------------------------------------
......@@ -190,14 +190,14 @@ BACKEND xbackend.get(BACKEND fallback=0)
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is no backend.
.. _func_backend.defined:
.. _vmod_constant.backend.defined:
BOOL xbackend.defined()
-----------------------
Return whether the constant is defined.
.. _obj_blob:
.. _vmod_constant.blob:
new xblob = constant.blob([BLOB init])
--------------------------------------
......@@ -206,7 +206,7 @@ Construct a(n) BLOB constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_blob.get:
.. _vmod_constant.blob.get:
BLOB xblob.get(BLOB fallback)
-----------------------------
......@@ -214,14 +214,14 @@ BLOB xblob.get(BLOB fallback)
Return the value of the constant or the `fallback` argument
if it is undefined.
.. _func_blob.defined:
.. _vmod_constant.blob.defined:
BOOL xblob.defined()
--------------------
Return whether the constant is defined.
.. _obj_body:
.. _vmod_constant.body:
new xbody = constant.body([BODY init])
--------------------------------------
......@@ -230,7 +230,7 @@ Construct a(n) BODY constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_body.get:
.. _vmod_constant.body.get:
BODY xbody.get(BODY fallback)
-----------------------------
......@@ -238,14 +238,14 @@ BODY xbody.get(BODY fallback)
Return the value of the constant or the `fallback` argument
if it is undefined.
.. _func_body.defined:
.. _vmod_constant.body.defined:
BOOL xbody.defined()
--------------------
Return whether the constant is defined.
.. _obj_bool:
.. _vmod_constant.bool:
new xbool = constant.bool([BOOL init])
--------------------------------------
......@@ -254,7 +254,7 @@ Construct a(n) BOOL constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_bool.get:
.. _vmod_constant.bool.get:
BOOL xbool.get(BOOL fallback)
-----------------------------
......@@ -262,14 +262,14 @@ BOOL xbool.get(BOOL fallback)
Return the value of the constant or the `fallback` argument
if it is undefined.
.. _func_bool.defined:
.. _vmod_constant.bool.defined:
BOOL xbool.defined()
--------------------
Return whether the constant is defined.
.. _obj_bytes:
.. _vmod_constant.bytes:
new xbytes = constant.bytes([BYTES init])
-----------------------------------------
......@@ -278,7 +278,7 @@ Construct a(n) BYTES constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_bytes.get:
.. _vmod_constant.bytes.get:
BYTES xbytes.get(BYTES fallback)
--------------------------------
......@@ -286,14 +286,14 @@ BYTES xbytes.get(BYTES fallback)
Return the value of the constant or the `fallback` argument
if it is undefined.
.. _func_bytes.defined:
.. _vmod_constant.bytes.defined:
BOOL xbytes.defined()
---------------------
Return whether the constant is defined.
.. _obj_duration:
.. _vmod_constant.duration:
new xduration = constant.duration([DURATION init])
--------------------------------------------------
......@@ -302,7 +302,7 @@ Construct a(n) DURATION constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_duration.get:
.. _vmod_constant.duration.get:
DURATION xduration.get(DURATION fallback=0)
-------------------------------------------
......@@ -310,14 +310,14 @@ DURATION xduration.get(DURATION fallback=0)
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is 0s.
.. _func_duration.defined:
.. _vmod_constant.duration.defined:
BOOL xduration.defined()
------------------------
Return whether the constant is defined.
.. _obj_header:
.. _vmod_constant.header:
new xheader = constant.header([HEADER init])
--------------------------------------------
......@@ -326,7 +326,7 @@ Construct a(n) HEADER constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_header.get:
.. _vmod_constant.header.get:
HEADER xheader.get(HEADER fallback)
-----------------------------------
......@@ -334,14 +334,14 @@ HEADER xheader.get(HEADER fallback)
Return the value of the constant or the `fallback` argument
if it is undefined.
.. _func_header.defined:
.. _vmod_constant.header.defined:
BOOL xheader.defined()
----------------------
Return whether the constant is defined.
.. _obj_int:
.. _vmod_constant.int:
new xint = constant.int([INT init])
-----------------------------------
......@@ -350,7 +350,7 @@ Construct a(n) INT constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_int.get:
.. _vmod_constant.int.get:
INT xint.get(INT fallback=0)
----------------------------
......@@ -358,14 +358,14 @@ INT xint.get(INT fallback=0)
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is 0.
.. _func_int.defined:
.. _vmod_constant.int.defined:
BOOL xint.defined()
-------------------
Return whether the constant is defined.
.. _obj_ip:
.. _vmod_constant.ip:
new xip = constant.ip([IP init])
--------------------------------
......@@ -374,7 +374,7 @@ Construct a(n) IP constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_ip.get:
.. _vmod_constant.ip.get:
IP xip.get(IP fallback)
-----------------------
......@@ -382,14 +382,14 @@ IP xip.get(IP fallback)
Return the value of the constant or the `fallback` argument
if it is undefined.
.. _func_ip.defined:
.. _vmod_constant.ip.defined:
BOOL xip.defined()
------------------
Return whether the constant is defined.
.. _obj_probe:
.. _vmod_constant.probe:
new xprobe = constant.probe([PROBE init])
-----------------------------------------
......@@ -398,7 +398,7 @@ Construct a(n) PROBE constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_probe.get:
.. _vmod_constant.probe.get:
PROBE xprobe.get(PROBE fallback)
--------------------------------
......@@ -406,14 +406,14 @@ PROBE xprobe.get(PROBE fallback)
Return the value of the constant or the `fallback` argument
if it is undefined.
.. _func_probe.defined:
.. _vmod_constant.probe.defined:
BOOL xprobe.defined()
---------------------
Return whether the constant is defined.
.. _obj_real:
.. _vmod_constant.real:
new xreal = constant.real([REAL init])
--------------------------------------
......@@ -422,7 +422,7 @@ Construct a(n) REAL constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_real.get:
.. _vmod_constant.real.get:
REAL xreal.get(REAL fallback=0.0)
---------------------------------
......@@ -430,14 +430,14 @@ REAL xreal.get(REAL fallback=0.0)
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is 0.0.
.. _func_real.defined:
.. _vmod_constant.real.defined:
BOOL xreal.defined()
--------------------
Return whether the constant is defined.
.. _obj_stevedore:
.. _vmod_constant.stevedore:
new xstevedore = constant.stevedore([STEVEDORE init])
-----------------------------------------------------
......@@ -446,7 +446,7 @@ Construct a(n) STEVEDORE constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_stevedore.get:
.. _vmod_constant.stevedore.get:
STEVEDORE xstevedore.get(STEVEDORE fallback)
--------------------------------------------
......@@ -454,14 +454,14 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
Return the value of the constant or the `fallback` argument
if it is undefined.
.. _func_stevedore.defined:
.. _vmod_constant.stevedore.defined:
BOOL xstevedore.defined()
-------------------------
Return whether the constant is defined.
.. _obj_string:
.. _vmod_constant.string:
new xstring = constant.string([STRING init])
--------------------------------------------
......@@ -470,7 +470,7 @@ Construct a(n) STRING constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_string.get:
.. _vmod_constant.string.get:
STRING xstring.get(STRING fallback=0)
-------------------------------------
......@@ -478,14 +478,14 @@ STRING xstring.get(STRING fallback=0)
Return the value of the constant or the `fallback` argument
if it is undefined. The default fallback is the empty string.
.. _func_string.defined:
.. _vmod_constant.string.defined:
BOOL xstring.defined()
----------------------
Return whether the constant is defined.
.. _obj_time:
.. _vmod_constant.time:
new xtime = constant.time([TIME init])
--------------------------------------
......@@ -494,7 +494,7 @@ Construct a(n) TIME constant with the value `init`,
if provided. If no `init` value is provided, the constant
will be undefined.
.. _func_time.get:
.. _vmod_constant.time.get:
TIME xtime.get(TIME fallback=0)
-------------------------------
......@@ -502,7 +502,7 @@ TIME xtime.get(TIME fallback=0)
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).
.. _func_time.defined:
.. _vmod_constant.time.defined:
BOOL xtime.defined()
--------------------
......
src/vmod_globalvar.rst
View file @ 1597ee14
......@@ -20,155 +20,155 @@ SYNOPSIS
import globalvar [from "path"]
:ref:`obj_acl`
:ref:`vmod_globalvar.acl`
:ref:`func_acl.get`
:ref:`vmod_globalvar.acl.get`
:ref:`func_acl.set`
:ref:`vmod_globalvar.acl.set`
:ref:`func_acl.undefine`
:ref:`vmod_globalvar.acl.undefine`
:ref:`func_acl.defined`
:ref:`vmod_globalvar.acl.defined`
:ref:`obj_backend`
:ref:`vmod_globalvar.backend`
:ref:`func_backend.get`
:ref:`vmod_globalvar.backend.get`
:ref:`func_backend.set`
:ref:`vmod_globalvar.backend.set`
:ref:`func_backend.undefine`
:ref:`vmod_globalvar.backend.undefine`
:ref:`func_backend.defined`
:ref:`vmod_globalvar.backend.defined`
:ref:`obj_blob`
:ref:`vmod_globalvar.blob`
:ref:`func_blob.get`
:ref:`vmod_globalvar.blob.get`
:ref:`func_blob.set`
:ref:`vmod_globalvar.blob.set`
:ref:`func_blob.undefine`
:ref:`vmod_globalvar.blob.undefine`
:ref:`func_blob.defined`
:ref:`vmod_globalvar.blob.defined`
:ref:`obj_body`
:ref:`vmod_globalvar.body`
:ref:`func_body.get`
:ref:`vmod_globalvar.body.get`
:ref:`func_body.set`
:ref:`vmod_globalvar.body.set`
:ref:`func_body.undefine`
:ref:`vmod_globalvar.body.undefine`
:ref:`func_body.defined`
:ref:`vmod_globalvar.body.defined`
:ref:`obj_bool`
:ref:`vmod_globalvar.bool`
:ref:`func_bool.get`
:ref:`vmod_globalvar.bool.get`
:ref:`func_bool.set`
:ref:`vmod_globalvar.bool.set`
:ref:`func_bool.undefine`
:ref:`vmod_globalvar.bool.undefine`
:ref:`func_bool.defined`
:ref:`vmod_globalvar.bool.defined`
:ref:`obj_bytes`
:ref:`vmod_globalvar.bytes`
:ref:`func_bytes.get`
:ref:`vmod_globalvar.bytes.get`
:ref:`func_bytes.set`
:ref:`vmod_globalvar.bytes.set`
:ref:`func_bytes.undefine`
:ref:`vmod_globalvar.bytes.undefine`
:ref:`func_bytes.defined`
:ref:`vmod_globalvar.bytes.defined`
:ref:`obj_duration`
:ref:`vmod_globalvar.duration`
:ref:`func_duration.get`
:ref:`vmod_globalvar.duration.get`
:ref:`func_duration.set`
:ref:`vmod_globalvar.duration.set`
:ref:`func_duration.undefine`
:ref:`vmod_globalvar.duration.undefine`
:ref:`func_duration.defined`
:ref:`vmod_globalvar.duration.defined`
:ref:`obj_header`
:ref:`vmod_globalvar.header`
:ref:`func_header.get`
:ref:`vmod_globalvar.header.get`
:ref:`func_header.set`
:ref:`vmod_globalvar.header.set`
:ref:`func_header.undefine`
:ref:`vmod_globalvar.header.undefine`
:ref:`func_header.defined`
:ref:`vmod_globalvar.header.defined`
:ref:`obj_int`
:ref:`vmod_globalvar.int`
:ref:`func_int.get`
:ref:`vmod_globalvar.int.get`
:ref:`func_int.set`
:ref:`vmod_globalvar.int.set`
:ref:`func_int.undefine`
:ref:`vmod_globalvar.int.undefine`
:ref:`func_int.defined`
:ref:`vmod_globalvar.int.defined`
:ref:`obj_ip`
:ref:`vmod_globalvar.ip`
:ref:`func_ip.get`
:ref:`vmod_globalvar.ip.get`
:ref:`func_ip.set`
:ref:`vmod_globalvar.ip.set`
:ref:`func_ip.undefine`
:ref:`vmod_globalvar.ip.undefine`
:ref:`func_ip.defined`
:ref:`vmod_globalvar.ip.defined`
:ref:`obj_probe`
:ref:`vmod_globalvar.probe`
:ref:`func_probe.get`
:ref:`vmod_globalvar.probe.get`
:ref:`func_probe.set`
:ref:`vmod_globalvar.probe.set`
:ref:`func_probe.undefine`
:ref:`vmod_globalvar.probe.undefine`
:ref:`func_probe.defined`
:ref:`vmod_globalvar.probe.defined`
:ref:`obj_real`
:ref:`vmod_globalvar.real`
:ref:`func_real.get`
:ref:`vmod_globalvar.real.get`
:ref:`func_real.set`
:ref:`vmod_globalvar.real.set`
:ref:`func_real.undefine`
:ref:`vmod_globalvar.real.undefine`
:ref:`func_real.defined`
:ref:`vmod_globalvar.real.defined`
:ref:`obj_stevedore`
:ref:`vmod_globalvar.stevedore`
:ref:`func_stevedore.get`
:ref:`vmod_globalvar.stevedore.get`
:ref:`func_stevedore.set`
:ref:`vmod_globalvar.stevedore.set`
:ref:`func_stevedore.undefine`
:ref:`vmod_globalvar.stevedore.undefine`
:ref:`func_stevedore.defined`
:ref:`vmod_globalvar.stevedore.defined`
:ref:`obj_string`
:ref:`vmod_globalvar.string`
:ref:`func_string.get`
:ref:`vmod_globalvar.string.get`
:ref:`func_string.set`
:ref:`vmod_globalvar.string.set`
:ref:`func_string.undefine`
:ref:`vmod_globalvar.string.undefine`
:ref:`func_string.defined`
:ref:`vmod_globalvar.string.defined`
:ref:`obj_time`
:ref:`vmod_globalvar.time`
:ref:`func_time.get`
:ref:`vmod_globalvar.time.get`
:ref:`func_time.set`
:ref:`vmod_globalvar.time.set`
:ref:`func_time.undefine`
:ref:`vmod_globalvar.time.undefine`
:ref:`func_time.defined`
:ref:`vmod_globalvar.time.defined`
DESCRIPTION
......@@ -217,7 +217,7 @@ for the respective type names and the ``.get()`` fallback.
.. just a newline
.. _obj_acl:
.. _vmod_globalvar.acl:
new xacl = globalvar.acl([ACL init])
------------------------------------
......@@ -226,7 +226,7 @@ Construct a(n) ACL globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_acl.get:
.. _vmod_globalvar.acl.get:
ACL xacl.get(ACL fallback)
--------------------------
......@@ -234,28 +234,28 @@ ACL xacl.get(ACL fallback)
Return the value of the globalvar or the `fallback` argument
if it is undefined.
.. _func_acl.set:
.. _vmod_globalvar.acl.set:
VOID xacl.set(ACL)
------------------
Set the value of the globalvar.
.. _func_acl.undefine:
.. _vmod_globalvar.acl.undefine:
VOID xacl.undefine()
--------------------
Undefine the globalvar.
.. _func_acl.defined:
.. _vmod_globalvar.acl.defined:
BOOL xacl.defined()
-------------------
Return whether the globalvar is defined.
.. _obj_backend:
.. _vmod_globalvar.backend:
new xbackend = globalvar.backend([BACKEND init])
------------------------------------------------
......@@ -264,7 +264,7 @@ Construct a(n) BACKEND globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_backend.get:
.. _vmod_globalvar.backend.get:
BACKEND xbackend.get(BACKEND fallback=0)
----------------------------------------
......@@ -272,28 +272,28 @@ BACKEND xbackend.get(BACKEND fallback=0)
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is no backend.
.. _func_backend.set:
.. _vmod_globalvar.backend.set:
VOID xbackend.set(BACKEND)
--------------------------
Set the value of the globalvar.
.. _func_backend.undefine:
.. _vmod_globalvar.backend.undefine:
VOID xbackend.undefine()
------------------------
Undefine the globalvar.
.. _func_backend.defined:
.. _vmod_globalvar.backend.defined:
BOOL xbackend.defined()
-----------------------
Return whether the globalvar is defined.
.. _obj_blob:
.. _vmod_globalvar.blob:
new xblob = globalvar.blob([BLOB init])
---------------------------------------
......@@ -302,7 +302,7 @@ Construct a(n) BLOB globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_blob.get:
.. _vmod_globalvar.blob.get:
BLOB xblob.get(BLOB fallback)
-----------------------------
......@@ -310,28 +310,28 @@ BLOB xblob.get(BLOB fallback)
Return the value of the globalvar or the `fallback` argument
if it is undefined.
.. _func_blob.set:
.. _vmod_globalvar.blob.set:
VOID xblob.set(BLOB)
--------------------
Set the value of the globalvar.
.. _func_blob.undefine:
.. _vmod_globalvar.blob.undefine:
VOID xblob.undefine()
---------------------
Undefine the globalvar.
.. _func_blob.defined:
.. _vmod_globalvar.blob.defined:
BOOL xblob.defined()
--------------------
Return whether the globalvar is defined.
.. _obj_body:
.. _vmod_globalvar.body:
new xbody = globalvar.body([BODY init])
---------------------------------------
......@@ -340,7 +340,7 @@ Construct a(n) BODY globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_body.get:
.. _vmod_globalvar.body.get:
BODY xbody.get(BODY fallback)
-----------------------------
......@@ -348,28 +348,28 @@ BODY xbody.get(BODY fallback)
Return the value of the globalvar or the `fallback` argument
if it is undefined.
.. _func_body.set:
.. _vmod_globalvar.body.set:
VOID xbody.set(BODY)
--------------------
Set the value of the globalvar.
.. _func_body.undefine:
.. _vmod_globalvar.body.undefine:
VOID xbody.undefine()
---------------------
Undefine the globalvar.
.. _func_body.defined:
.. _vmod_globalvar.body.defined:
BOOL xbody.defined()
--------------------
Return whether the globalvar is defined.
.. _obj_bool:
.. _vmod_globalvar.bool:
new xbool = globalvar.bool([BOOL init])
---------------------------------------
......@@ -378,7 +378,7 @@ Construct a(n) BOOL globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_bool.get:
.. _vmod_globalvar.bool.get:
BOOL xbool.get(BOOL fallback)
-----------------------------
......@@ -386,28 +386,28 @@ BOOL xbool.get(BOOL fallback)
Return the value of the globalvar or the `fallback` argument
if it is undefined.
.. _func_bool.set:
.. _vmod_globalvar.bool.set:
VOID xbool.set(BOOL)
--------------------
Set the value of the globalvar.
.. _func_bool.undefine:
.. _vmod_globalvar.bool.undefine:
VOID xbool.undefine()
---------------------
Undefine the globalvar.
.. _func_bool.defined:
.. _vmod_globalvar.bool.defined:
BOOL xbool.defined()
--------------------
Return whether the globalvar is defined.
.. _obj_bytes:
.. _vmod_globalvar.bytes:
new xbytes = globalvar.bytes([BYTES init])
------------------------------------------
......@@ -416,7 +416,7 @@ Construct a(n) BYTES globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_bytes.get:
.. _vmod_globalvar.bytes.get:
BYTES xbytes.get(BYTES fallback)
--------------------------------
......@@ -424,28 +424,28 @@ BYTES xbytes.get(BYTES fallback)
Return the value of the globalvar or the `fallback` argument
if it is undefined.
.. _func_bytes.set:
.. _vmod_globalvar.bytes.set:
VOID xbytes.set(BYTES)
----------------------
Set the value of the globalvar.
.. _func_bytes.undefine:
.. _vmod_globalvar.bytes.undefine:
VOID xbytes.undefine()
----------------------
Undefine the globalvar.
.. _func_bytes.defined:
.. _vmod_globalvar.bytes.defined:
BOOL xbytes.defined()
---------------------
Return whether the globalvar is defined.
.. _obj_duration:
.. _vmod_globalvar.duration:
new xduration = globalvar.duration([DURATION init])
---------------------------------------------------
......@@ -454,7 +454,7 @@ Construct a(n) DURATION globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_duration.get:
.. _vmod_globalvar.duration.get:
DURATION xduration.get(DURATION fallback=0)
-------------------------------------------
......@@ -462,28 +462,28 @@ DURATION xduration.get(DURATION fallback=0)
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is 0s.
.. _func_duration.set:
.. _vmod_globalvar.duration.set:
VOID xduration.set(DURATION)
----------------------------
Set the value of the globalvar.
.. _func_duration.undefine:
.. _vmod_globalvar.duration.undefine:
VOID xduration.undefine()
-------------------------
Undefine the globalvar.
.. _func_duration.defined:
.. _vmod_globalvar.duration.defined:
BOOL xduration.defined()
------------------------
Return whether the globalvar is defined.
.. _obj_header:
.. _vmod_globalvar.header:
new xheader = globalvar.header([HEADER init])
---------------------------------------------
......@@ -492,7 +492,7 @@ Construct a(n) HEADER globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_header.get:
.. _vmod_globalvar.header.get:
HEADER xheader.get(HEADER fallback)
-----------------------------------
......@@ -500,28 +500,28 @@ HEADER xheader.get(HEADER fallback)
Return the value of the globalvar or the `fallback` argument
if it is undefined.
.. _func_header.set:
.. _vmod_globalvar.header.set:
VOID xheader.set(HEADER)
------------------------
Set the value of the globalvar.
.. _func_header.undefine:
.. _vmod_globalvar.header.undefine:
VOID xheader.undefine()
-----------------------
Undefine the globalvar.
.. _func_header.defined:
.. _vmod_globalvar.header.defined:
BOOL xheader.defined()
----------------------
Return whether the globalvar is defined.
.. _obj_int:
.. _vmod_globalvar.int:
new xint = globalvar.int([INT init])
------------------------------------
......@@ -530,7 +530,7 @@ Construct a(n) INT globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_int.get:
.. _vmod_globalvar.int.get:
INT xint.get(INT fallback=0)
----------------------------
......@@ -538,28 +538,28 @@ INT xint.get(INT fallback=0)
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is 0.
.. _func_int.set:
.. _vmod_globalvar.int.set:
VOID xint.set(INT)
------------------
Set the value of the globalvar.
.. _func_int.undefine:
.. _vmod_globalvar.int.undefine:
VOID xint.undefine()
--------------------
Undefine the globalvar.
.. _func_int.defined:
.. _vmod_globalvar.int.defined:
BOOL xint.defined()
-------------------
Return whether the globalvar is defined.
.. _obj_ip:
.. _vmod_globalvar.ip:
new xip = globalvar.ip([IP init])
---------------------------------
......@@ -568,7 +568,7 @@ Construct a(n) IP globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_ip.get:
.. _vmod_globalvar.ip.get:
IP xip.get(IP fallback)
-----------------------
......@@ -576,28 +576,28 @@ IP xip.get(IP fallback)
Return the value of the globalvar or the `fallback` argument
if it is undefined.
.. _func_ip.set:
.. _vmod_globalvar.ip.set:
VOID xip.set(IP)
----------------
Set the value of the globalvar.
.. _func_ip.undefine:
.. _vmod_globalvar.ip.undefine:
VOID xip.undefine()
-------------------
Undefine the globalvar.
.. _func_ip.defined:
.. _vmod_globalvar.ip.defined:
BOOL xip.defined()
------------------
Return whether the globalvar is defined.
.. _obj_probe:
.. _vmod_globalvar.probe:
new xprobe = globalvar.probe([PROBE init])
------------------------------------------
......@@ -606,7 +606,7 @@ Construct a(n) PROBE globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_probe.get:
.. _vmod_globalvar.probe.get:
PROBE xprobe.get(PROBE fallback)
--------------------------------
......@@ -614,28 +614,28 @@ PROBE xprobe.get(PROBE fallback)
Return the value of the globalvar or the `fallback` argument
if it is undefined.
.. _func_probe.set:
.. _vmod_globalvar.probe.set:
VOID xprobe.set(PROBE)
----------------------
Set the value of the globalvar.
.. _func_probe.undefine:
.. _vmod_globalvar.probe.undefine:
VOID xprobe.undefine()
----------------------
Undefine the globalvar.
.. _func_probe.defined:
.. _vmod_globalvar.probe.defined:
BOOL xprobe.defined()
---------------------
Return whether the globalvar is defined.
.. _obj_real:
.. _vmod_globalvar.real:
new xreal = globalvar.real([REAL init])
---------------------------------------
......@@ -644,7 +644,7 @@ Construct a(n) REAL globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_real.get:
.. _vmod_globalvar.real.get:
REAL xreal.get(REAL fallback=0.0)
---------------------------------
......@@ -652,28 +652,28 @@ REAL xreal.get(REAL fallback=0.0)
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is 0.0.
.. _func_real.set:
.. _vmod_globalvar.real.set:
VOID xreal.set(REAL)
--------------------
Set the value of the globalvar.
.. _func_real.undefine:
.. _vmod_globalvar.real.undefine:
VOID xreal.undefine()
---------------------
Undefine the globalvar.
.. _func_real.defined:
.. _vmod_globalvar.real.defined:
BOOL xreal.defined()
--------------------
Return whether the globalvar is defined.
.. _obj_stevedore:
.. _vmod_globalvar.stevedore:
new xstevedore = globalvar.stevedore([STEVEDORE init])
------------------------------------------------------
......@@ -682,7 +682,7 @@ Construct a(n) STEVEDORE globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_stevedore.get:
.. _vmod_globalvar.stevedore.get:
STEVEDORE xstevedore.get(STEVEDORE fallback)
--------------------------------------------
......@@ -690,28 +690,28 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
Return the value of the globalvar or the `fallback` argument
if it is undefined.
.. _func_stevedore.set:
.. _vmod_globalvar.stevedore.set:
VOID xstevedore.set(STEVEDORE)
------------------------------
Set the value of the globalvar.
.. _func_stevedore.undefine:
.. _vmod_globalvar.stevedore.undefine:
VOID xstevedore.undefine()
--------------------------
Undefine the globalvar.
.. _func_stevedore.defined:
.. _vmod_globalvar.stevedore.defined:
BOOL xstevedore.defined()
-------------------------
Return whether the globalvar is defined.
.. _obj_string:
.. _vmod_globalvar.string:
new xstring = globalvar.string([STRING init])
---------------------------------------------
......@@ -720,7 +720,7 @@ Construct a(n) STRING globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_string.get:
.. _vmod_globalvar.string.get:
STRING xstring.get(STRING fallback=0)
-------------------------------------
......@@ -728,28 +728,28 @@ STRING xstring.get(STRING fallback=0)
Return the value of the globalvar or the `fallback` argument
if it is undefined. The default fallback is the empty string.
.. _func_string.set:
.. _vmod_globalvar.string.set:
VOID xstring.set(STRING)
------------------------
Set the value of the globalvar.
.. _func_string.undefine:
.. _vmod_globalvar.string.undefine:
VOID xstring.undefine()
-----------------------
Undefine the globalvar.
.. _func_string.defined:
.. _vmod_globalvar.string.defined:
BOOL xstring.defined()
----------------------
Return whether the globalvar is defined.
.. _obj_time:
.. _vmod_globalvar.time:
new xtime = globalvar.time([TIME init])
---------------------------------------
......@@ -758,7 +758,7 @@ Construct a(n) TIME globalvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_time.get:
.. _vmod_globalvar.time.get:
TIME xtime.get(TIME fallback=0)
-------------------------------
......@@ -766,21 +766,21 @@ TIME xtime.get(TIME fallback=0)
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).
.. _func_time.set:
.. _vmod_globalvar.time.set:
VOID xtime.set(TIME)
--------------------
Set the value of the globalvar.
.. _func_time.undefine:
.. _vmod_globalvar.time.undefine:
VOID xtime.undefine()
---------------------
Undefine the globalvar.
.. _func_time.defined:
.. _vmod_globalvar.time.defined:
BOOL xtime.defined()
--------------------
......
src/vmod_taskvar.rst
View file @ 1597ee14
......@@ -20,215 +20,215 @@ SYNOPSIS
import taskvar [from "path"]
:ref:`obj_acl`
:ref:`vmod_taskvar.acl`
:ref:`func_acl.get`
:ref:`vmod_taskvar.acl.get`
:ref:`func_acl.set`
:ref:`vmod_taskvar.acl.set`
:ref:`func_acl.undefine`
:ref:`vmod_taskvar.acl.undefine`
:ref:`func_acl.defined`
:ref:`vmod_taskvar.acl.defined`
:ref:`func_acl.protect`
:ref:`vmod_taskvar.acl.protect`
:ref:`func_acl.protected`
:ref:`vmod_taskvar.acl.protected`
:ref:`obj_backend`
:ref:`vmod_taskvar.backend`
:ref:`func_backend.get`
:ref:`vmod_taskvar.backend.get`
:ref:`func_backend.set`
:ref:`vmod_taskvar.backend.set`
:ref:`func_backend.undefine`
:ref:`vmod_taskvar.backend.undefine`
:ref:`func_backend.defined`
:ref:`vmod_taskvar.backend.defined`
:ref:`func_backend.protect`
:ref:`vmod_taskvar.backend.protect`
:ref:`func_backend.protected`
:ref:`vmod_taskvar.backend.protected`
:ref:`obj_blob`
:ref:`vmod_taskvar.blob`
:ref:`func_blob.get`
:ref:`vmod_taskvar.blob.get`
:ref:`func_blob.set`
:ref:`vmod_taskvar.blob.set`
:ref:`func_blob.undefine`
:ref:`vmod_taskvar.blob.undefine`
:ref:`func_blob.defined`
:ref:`vmod_taskvar.blob.defined`
:ref:`func_blob.protect`
:ref:`vmod_taskvar.blob.protect`
:ref:`func_blob.protected`
:ref:`vmod_taskvar.blob.protected`
:ref:`obj_body`
:ref:`vmod_taskvar.body`
:ref:`func_body.get`
:ref:`vmod_taskvar.body.get`
:ref:`func_body.set`
:ref:`vmod_taskvar.body.set`
:ref:`func_body.undefine`
:ref:`vmod_taskvar.body.undefine`
:ref:`func_body.defined`
:ref:`vmod_taskvar.body.defined`
:ref:`func_body.protect`
:ref:`vmod_taskvar.body.protect`
:ref:`func_body.protected`
:ref:`vmod_taskvar.body.protected`
:ref:`obj_bool`
:ref:`vmod_taskvar.bool`
:ref:`func_bool.get`
:ref:`vmod_taskvar.bool.get`
:ref:`func_bool.set`
:ref:`vmod_taskvar.bool.set`
:ref:`func_bool.undefine`
:ref:`vmod_taskvar.bool.undefine`
:ref:`func_bool.defined`
:ref:`vmod_taskvar.bool.defined`
:ref:`func_bool.protect`
:ref:`vmod_taskvar.bool.protect`
:ref:`func_bool.protected`
:ref:`vmod_taskvar.bool.protected`
:ref:`obj_bytes`
:ref:`vmod_taskvar.bytes`
:ref:`func_bytes.get`
:ref:`vmod_taskvar.bytes.get`
:ref:`func_bytes.set`
:ref:`vmod_taskvar.bytes.set`
:ref:`func_bytes.undefine`
:ref:`vmod_taskvar.bytes.undefine`
:ref:`func_bytes.defined`
:ref:`vmod_taskvar.bytes.defined`
:ref:`func_bytes.protect`
:ref:`vmod_taskvar.bytes.protect`
:ref:`func_bytes.protected`
:ref:`vmod_taskvar.bytes.protected`
:ref:`obj_duration`
:ref:`vmod_taskvar.duration`
:ref:`func_duration.get`
:ref:`vmod_taskvar.duration.get`
:ref:`func_duration.set`
:ref:`vmod_taskvar.duration.set`
:ref:`func_duration.undefine`
:ref:`vmod_taskvar.duration.undefine`
:ref:`func_duration.defined`
:ref:`vmod_taskvar.duration.defined`
:ref:`func_duration.protect`
:ref:`vmod_taskvar.duration.protect`
:ref:`func_duration.protected`
:ref:`vmod_taskvar.duration.protected`
:ref:`obj_header`
:ref:`vmod_taskvar.header`
:ref:`func_header.get`
:ref:`vmod_taskvar.header.get`
:ref:`func_header.set`
:ref:`vmod_taskvar.header.set`
:ref:`func_header.undefine`
:ref:`vmod_taskvar.header.undefine`
:ref:`func_header.defined`
:ref:`vmod_taskvar.header.defined`
:ref:`func_header.protect`
:ref:`vmod_taskvar.header.protect`
:ref:`func_header.protected`
:ref:`vmod_taskvar.header.protected`
:ref:`obj_int`
:ref:`vmod_taskvar.int`
:ref:`func_int.get`
:ref:`vmod_taskvar.int.get`
:ref:`func_int.set`
:ref:`vmod_taskvar.int.set`
:ref:`func_int.undefine`
:ref:`vmod_taskvar.int.undefine`
:ref:`func_int.defined`
:ref:`vmod_taskvar.int.defined`
:ref:`func_int.protect`
:ref:`vmod_taskvar.int.protect`
:ref:`func_int.protected`
:ref:`vmod_taskvar.int.protected`
:ref:`obj_ip`
:ref:`vmod_taskvar.ip`
:ref:`func_ip.get`
:ref:`vmod_taskvar.ip.get`
:ref:`func_ip.set`
:ref:`vmod_taskvar.ip.set`
:ref:`func_ip.undefine`
:ref:`vmod_taskvar.ip.undefine`
:ref:`func_ip.defined`
:ref:`vmod_taskvar.ip.defined`
:ref:`func_ip.protect`
:ref:`vmod_taskvar.ip.protect`
:ref:`func_ip.protected`
:ref:`vmod_taskvar.ip.protected`
:ref:`obj_probe`
:ref:`vmod_taskvar.probe`
:ref:`func_probe.get`
:ref:`vmod_taskvar.probe.get`
:ref:`func_probe.set`
:ref:`vmod_taskvar.probe.set`
:ref:`func_probe.undefine`
:ref:`vmod_taskvar.probe.undefine`
:ref:`func_probe.defined`
:ref:`vmod_taskvar.probe.defined`
:ref:`func_probe.protect`
:ref:`vmod_taskvar.probe.protect`
:ref:`func_probe.protected`
:ref:`vmod_taskvar.probe.protected`
:ref:`obj_real`
:ref:`vmod_taskvar.real`
:ref:`func_real.get`
:ref:`vmod_taskvar.real.get`
:ref:`func_real.set`
:ref:`vmod_taskvar.real.set`
:ref:`func_real.undefine`
:ref:`vmod_taskvar.real.undefine`
:ref:`func_real.defined`
:ref:`vmod_taskvar.real.defined`
:ref:`func_real.protect`
:ref:`vmod_taskvar.real.protect`
:ref:`func_real.protected`
:ref:`vmod_taskvar.real.protected`
:ref:`obj_stevedore`
:ref:`vmod_taskvar.stevedore`
:ref:`func_stevedore.get`
:ref:`vmod_taskvar.stevedore.get`
:ref:`func_stevedore.set`
:ref:`vmod_taskvar.stevedore.set`
:ref:`func_stevedore.undefine`
:ref:`vmod_taskvar.stevedore.undefine`
:ref:`func_stevedore.defined`
:ref:`vmod_taskvar.stevedore.defined`
:ref:`func_stevedore.protect`
:ref:`vmod_taskvar.stevedore.protect`
:ref:`func_stevedore.protected`
:ref:`vmod_taskvar.stevedore.protected`
:ref:`obj_string`
:ref:`vmod_taskvar.string`
:ref:`func_string.get`
:ref:`vmod_taskvar.string.get`
:ref:`func_string.set`
:ref:`vmod_taskvar.string.set`
:ref:`func_string.undefine`
:ref:`vmod_taskvar.string.undefine`
:ref:`func_string.defined`
:ref:`vmod_taskvar.string.defined`
:ref:`func_string.protect`
:ref:`vmod_taskvar.string.protect`
:ref:`func_string.protected`
:ref:`vmod_taskvar.string.protected`
:ref:`obj_time`
:ref:`vmod_taskvar.time`
:ref:`func_time.get`
:ref:`vmod_taskvar.time.get`
:ref:`func_time.set`
:ref:`vmod_taskvar.time.set`
:ref:`func_time.undefine`
:ref:`vmod_taskvar.time.undefine`
:ref:`func_time.defined`
:ref:`vmod_taskvar.time.defined`
:ref:`func_time.protect`
:ref:`vmod_taskvar.time.protect`
:ref:`func_time.protected`
:ref:`vmod_taskvar.time.protected`
DESCRIPTION
......@@ -294,7 +294,7 @@ for the respective type names and the ``.get()`` fallback.
.. just a newline
.. _obj_acl:
.. _vmod_taskvar.acl:
new xacl = taskvar.acl([ACL init])
----------------------------------
......@@ -303,7 +303,7 @@ Construct a(n) ACL taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_acl.get:
.. _vmod_taskvar.acl.get:
ACL xacl.get(ACL fallback)
--------------------------
......@@ -311,7 +311,7 @@ ACL xacl.get(ACL fallback)
Return the value of the taskvar or the `fallback` argument
if it is undefined.
.. _func_acl.set:
.. _vmod_taskvar.acl.set:
VOID xacl.set(ACL)
------------------
......@@ -320,21 +320,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_acl.undefine:
.. _vmod_taskvar.acl.undefine:
VOID xacl.undefine()
--------------------
Undefine the taskvar.
.. _func_acl.defined:
.. _vmod_taskvar.acl.defined:
BOOL xacl.defined()
-------------------
Return whether the taskvar is defined.
.. _func_acl.protect:
.. _vmod_taskvar.acl.protect:
VOID xacl.protect()
-------------------
......@@ -342,14 +342,14 @@ VOID xacl.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_acl.protected:
.. _vmod_taskvar.acl.protected:
BOOL xacl.protected()
---------------------
Return whether the taskvar is protected.
.. _obj_backend:
.. _vmod_taskvar.backend:
new xbackend = taskvar.backend([BACKEND init])
----------------------------------------------
......@@ -358,7 +358,7 @@ Construct a(n) BACKEND taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_backend.get:
.. _vmod_taskvar.backend.get:
BACKEND xbackend.get(BACKEND fallback=0)
----------------------------------------
......@@ -366,7 +366,7 @@ BACKEND xbackend.get(BACKEND fallback=0)
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is no backend.
.. _func_backend.set:
.. _vmod_taskvar.backend.set:
VOID xbackend.set(BACKEND)
--------------------------
......@@ -375,21 +375,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_backend.undefine:
.. _vmod_taskvar.backend.undefine:
VOID xbackend.undefine()
------------------------
Undefine the taskvar.
.. _func_backend.defined:
.. _vmod_taskvar.backend.defined:
BOOL xbackend.defined()
-----------------------
Return whether the taskvar is defined.
.. _func_backend.protect:
.. _vmod_taskvar.backend.protect:
VOID xbackend.protect()
-----------------------
......@@ -397,14 +397,14 @@ VOID xbackend.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_backend.protected:
.. _vmod_taskvar.backend.protected:
BOOL xbackend.protected()
-------------------------
Return whether the taskvar is protected.
.. _obj_blob:
.. _vmod_taskvar.blob:
new xblob = taskvar.blob([BLOB init])
-------------------------------------
......@@ -413,7 +413,7 @@ Construct a(n) BLOB taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_blob.get:
.. _vmod_taskvar.blob.get:
BLOB xblob.get(BLOB fallback)
-----------------------------
......@@ -421,7 +421,7 @@ BLOB xblob.get(BLOB fallback)
Return the value of the taskvar or the `fallback` argument
if it is undefined.
.. _func_blob.set:
.. _vmod_taskvar.blob.set:
VOID xblob.set(BLOB)
--------------------
......@@ -430,21 +430,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_blob.undefine:
.. _vmod_taskvar.blob.undefine:
VOID xblob.undefine()
---------------------
Undefine the taskvar.
.. _func_blob.defined:
.. _vmod_taskvar.blob.defined:
BOOL xblob.defined()
--------------------
Return whether the taskvar is defined.
.. _func_blob.protect:
.. _vmod_taskvar.blob.protect:
VOID xblob.protect()
--------------------
......@@ -452,14 +452,14 @@ VOID xblob.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_blob.protected:
.. _vmod_taskvar.blob.protected:
BOOL xblob.protected()
----------------------
Return whether the taskvar is protected.
.. _obj_body:
.. _vmod_taskvar.body:
new xbody = taskvar.body([BODY init])
-------------------------------------
......@@ -468,7 +468,7 @@ Construct a(n) BODY taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_body.get:
.. _vmod_taskvar.body.get:
BODY xbody.get(BODY fallback)
-----------------------------
......@@ -476,7 +476,7 @@ BODY xbody.get(BODY fallback)
Return the value of the taskvar or the `fallback` argument
if it is undefined.
.. _func_body.set:
.. _vmod_taskvar.body.set:
VOID xbody.set(BODY)
--------------------
......@@ -485,21 +485,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_body.undefine:
.. _vmod_taskvar.body.undefine:
VOID xbody.undefine()
---------------------
Undefine the taskvar.
.. _func_body.defined:
.. _vmod_taskvar.body.defined:
BOOL xbody.defined()
--------------------
Return whether the taskvar is defined.
.. _func_body.protect:
.. _vmod_taskvar.body.protect:
VOID xbody.protect()
--------------------
......@@ -507,14 +507,14 @@ VOID xbody.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_body.protected:
.. _vmod_taskvar.body.protected:
BOOL xbody.protected()
----------------------
Return whether the taskvar is protected.
.. _obj_bool:
.. _vmod_taskvar.bool:
new xbool = taskvar.bool([BOOL init])
-------------------------------------
......@@ -523,7 +523,7 @@ Construct a(n) BOOL taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_bool.get:
.. _vmod_taskvar.bool.get:
BOOL xbool.get(BOOL fallback)
-----------------------------
......@@ -531,7 +531,7 @@ BOOL xbool.get(BOOL fallback)
Return the value of the taskvar or the `fallback` argument
if it is undefined.
.. _func_bool.set:
.. _vmod_taskvar.bool.set:
VOID xbool.set(BOOL)
--------------------
......@@ -540,21 +540,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_bool.undefine:
.. _vmod_taskvar.bool.undefine:
VOID xbool.undefine()
---------------------
Undefine the taskvar.
.. _func_bool.defined:
.. _vmod_taskvar.bool.defined:
BOOL xbool.defined()
--------------------
Return whether the taskvar is defined.
.. _func_bool.protect:
.. _vmod_taskvar.bool.protect:
VOID xbool.protect()
--------------------
......@@ -562,14 +562,14 @@ VOID xbool.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_bool.protected:
.. _vmod_taskvar.bool.protected:
BOOL xbool.protected()
----------------------
Return whether the taskvar is protected.
.. _obj_bytes:
.. _vmod_taskvar.bytes:
new xbytes = taskvar.bytes([BYTES init])
----------------------------------------
......@@ -578,7 +578,7 @@ Construct a(n) BYTES taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_bytes.get:
.. _vmod_taskvar.bytes.get:
BYTES xbytes.get(BYTES fallback)
--------------------------------
......@@ -586,7 +586,7 @@ BYTES xbytes.get(BYTES fallback)
Return the value of the taskvar or the `fallback` argument
if it is undefined.
.. _func_bytes.set:
.. _vmod_taskvar.bytes.set:
VOID xbytes.set(BYTES)
----------------------
......@@ -595,21 +595,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_bytes.undefine:
.. _vmod_taskvar.bytes.undefine:
VOID xbytes.undefine()
----------------------
Undefine the taskvar.
.. _func_bytes.defined:
.. _vmod_taskvar.bytes.defined:
BOOL xbytes.defined()
---------------------
Return whether the taskvar is defined.
.. _func_bytes.protect:
.. _vmod_taskvar.bytes.protect:
VOID xbytes.protect()
---------------------
......@@ -617,14 +617,14 @@ VOID xbytes.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_bytes.protected:
.. _vmod_taskvar.bytes.protected:
BOOL xbytes.protected()
-----------------------
Return whether the taskvar is protected.
.. _obj_duration:
.. _vmod_taskvar.duration:
new xduration = taskvar.duration([DURATION init])
-------------------------------------------------
......@@ -633,7 +633,7 @@ Construct a(n) DURATION taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_duration.get:
.. _vmod_taskvar.duration.get:
DURATION xduration.get(DURATION fallback=0)
-------------------------------------------
......@@ -641,7 +641,7 @@ DURATION xduration.get(DURATION fallback=0)
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is 0s.
.. _func_duration.set:
.. _vmod_taskvar.duration.set:
VOID xduration.set(DURATION)
----------------------------
......@@ -650,21 +650,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_duration.undefine:
.. _vmod_taskvar.duration.undefine:
VOID xduration.undefine()
-------------------------
Undefine the taskvar.
.. _func_duration.defined:
.. _vmod_taskvar.duration.defined:
BOOL xduration.defined()
------------------------
Return whether the taskvar is defined.
.. _func_duration.protect:
.. _vmod_taskvar.duration.protect:
VOID xduration.protect()
------------------------
......@@ -672,14 +672,14 @@ VOID xduration.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_duration.protected:
.. _vmod_taskvar.duration.protected:
BOOL xduration.protected()
--------------------------
Return whether the taskvar is protected.
.. _obj_header:
.. _vmod_taskvar.header:
new xheader = taskvar.header([HEADER init])
-------------------------------------------
......@@ -688,7 +688,7 @@ Construct a(n) HEADER taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_header.get:
.. _vmod_taskvar.header.get:
HEADER xheader.get(HEADER fallback)
-----------------------------------
......@@ -696,7 +696,7 @@ HEADER xheader.get(HEADER fallback)
Return the value of the taskvar or the `fallback` argument
if it is undefined.
.. _func_header.set:
.. _vmod_taskvar.header.set:
VOID xheader.set(HEADER)
------------------------
......@@ -705,21 +705,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_header.undefine:
.. _vmod_taskvar.header.undefine:
VOID xheader.undefine()
-----------------------
Undefine the taskvar.
.. _func_header.defined:
.. _vmod_taskvar.header.defined:
BOOL xheader.defined()
----------------------
Return whether the taskvar is defined.
.. _func_header.protect:
.. _vmod_taskvar.header.protect:
VOID xheader.protect()
----------------------
......@@ -727,14 +727,14 @@ VOID xheader.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_header.protected:
.. _vmod_taskvar.header.protected:
BOOL xheader.protected()
------------------------
Return whether the taskvar is protected.
.. _obj_int:
.. _vmod_taskvar.int:
new xint = taskvar.int([INT init])
----------------------------------
......@@ -743,7 +743,7 @@ Construct a(n) INT taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_int.get:
.. _vmod_taskvar.int.get:
INT xint.get(INT fallback=0)
----------------------------
......@@ -751,7 +751,7 @@ INT xint.get(INT fallback=0)
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is 0.
.. _func_int.set:
.. _vmod_taskvar.int.set:
VOID xint.set(INT)
------------------
......@@ -760,21 +760,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_int.undefine:
.. _vmod_taskvar.int.undefine:
VOID xint.undefine()
--------------------
Undefine the taskvar.
.. _func_int.defined:
.. _vmod_taskvar.int.defined:
BOOL xint.defined()
-------------------
Return whether the taskvar is defined.
.. _func_int.protect:
.. _vmod_taskvar.int.protect:
VOID xint.protect()
-------------------
......@@ -782,14 +782,14 @@ VOID xint.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_int.protected:
.. _vmod_taskvar.int.protected:
BOOL xint.protected()
---------------------
Return whether the taskvar is protected.
.. _obj_ip:
.. _vmod_taskvar.ip:
new xip = taskvar.ip([IP init])
-------------------------------
......@@ -798,7 +798,7 @@ Construct a(n) IP taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_ip.get:
.. _vmod_taskvar.ip.get:
IP xip.get(IP fallback)
-----------------------
......@@ -806,7 +806,7 @@ IP xip.get(IP fallback)
Return the value of the taskvar or the `fallback` argument
if it is undefined.
.. _func_ip.set:
.. _vmod_taskvar.ip.set:
VOID xip.set(IP)
----------------
......@@ -815,21 +815,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_ip.undefine:
.. _vmod_taskvar.ip.undefine:
VOID xip.undefine()
-------------------
Undefine the taskvar.
.. _func_ip.defined:
.. _vmod_taskvar.ip.defined:
BOOL xip.defined()
------------------
Return whether the taskvar is defined.
.. _func_ip.protect:
.. _vmod_taskvar.ip.protect:
VOID xip.protect()
------------------
......@@ -837,14 +837,14 @@ VOID xip.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_ip.protected:
.. _vmod_taskvar.ip.protected:
BOOL xip.protected()
--------------------
Return whether the taskvar is protected.
.. _obj_probe:
.. _vmod_taskvar.probe:
new xprobe = taskvar.probe([PROBE init])
----------------------------------------
......@@ -853,7 +853,7 @@ Construct a(n) PROBE taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_probe.get:
.. _vmod_taskvar.probe.get:
PROBE xprobe.get(PROBE fallback)
--------------------------------
......@@ -861,7 +861,7 @@ PROBE xprobe.get(PROBE fallback)
Return the value of the taskvar or the `fallback` argument
if it is undefined.
.. _func_probe.set:
.. _vmod_taskvar.probe.set:
VOID xprobe.set(PROBE)
----------------------
......@@ -870,21 +870,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_probe.undefine:
.. _vmod_taskvar.probe.undefine:
VOID xprobe.undefine()
----------------------
Undefine the taskvar.
.. _func_probe.defined:
.. _vmod_taskvar.probe.defined:
BOOL xprobe.defined()
---------------------
Return whether the taskvar is defined.
.. _func_probe.protect:
.. _vmod_taskvar.probe.protect:
VOID xprobe.protect()
---------------------
......@@ -892,14 +892,14 @@ VOID xprobe.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_probe.protected:
.. _vmod_taskvar.probe.protected:
BOOL xprobe.protected()
-----------------------
Return whether the taskvar is protected.
.. _obj_real:
.. _vmod_taskvar.real:
new xreal = taskvar.real([REAL init])
-------------------------------------
......@@ -908,7 +908,7 @@ Construct a(n) REAL taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_real.get:
.. _vmod_taskvar.real.get:
REAL xreal.get(REAL fallback=0.0)
---------------------------------
......@@ -916,7 +916,7 @@ REAL xreal.get(REAL fallback=0.0)
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is 0.0.
.. _func_real.set:
.. _vmod_taskvar.real.set:
VOID xreal.set(REAL)
--------------------
......@@ -925,21 +925,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_real.undefine:
.. _vmod_taskvar.real.undefine:
VOID xreal.undefine()
---------------------
Undefine the taskvar.
.. _func_real.defined:
.. _vmod_taskvar.real.defined:
BOOL xreal.defined()
--------------------
Return whether the taskvar is defined.
.. _func_real.protect:
.. _vmod_taskvar.real.protect:
VOID xreal.protect()
--------------------
......@@ -947,14 +947,14 @@ VOID xreal.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_real.protected:
.. _vmod_taskvar.real.protected:
BOOL xreal.protected()
----------------------
Return whether the taskvar is protected.
.. _obj_stevedore:
.. _vmod_taskvar.stevedore:
new xstevedore = taskvar.stevedore([STEVEDORE init])
----------------------------------------------------
......@@ -963,7 +963,7 @@ Construct a(n) STEVEDORE taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_stevedore.get:
.. _vmod_taskvar.stevedore.get:
STEVEDORE xstevedore.get(STEVEDORE fallback)
--------------------------------------------
......@@ -971,7 +971,7 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
Return the value of the taskvar or the `fallback` argument
if it is undefined.
.. _func_stevedore.set:
.. _vmod_taskvar.stevedore.set:
VOID xstevedore.set(STEVEDORE)
------------------------------
......@@ -980,21 +980,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_stevedore.undefine:
.. _vmod_taskvar.stevedore.undefine:
VOID xstevedore.undefine()
--------------------------
Undefine the taskvar.
.. _func_stevedore.defined:
.. _vmod_taskvar.stevedore.defined:
BOOL xstevedore.defined()
-------------------------
Return whether the taskvar is defined.
.. _func_stevedore.protect:
.. _vmod_taskvar.stevedore.protect:
VOID xstevedore.protect()
-------------------------
......@@ -1002,14 +1002,14 @@ VOID xstevedore.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_stevedore.protected:
.. _vmod_taskvar.stevedore.protected:
BOOL xstevedore.protected()
---------------------------
Return whether the taskvar is protected.
.. _obj_string:
.. _vmod_taskvar.string:
new xstring = taskvar.string([STRING init])
-------------------------------------------
......@@ -1018,7 +1018,7 @@ Construct a(n) STRING taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_string.get:
.. _vmod_taskvar.string.get:
STRING xstring.get(STRING fallback=0)
-------------------------------------
......@@ -1026,7 +1026,7 @@ STRING xstring.get(STRING fallback=0)
Return the value of the taskvar or the `fallback` argument
if it is undefined. The default fallback is the empty string.
.. _func_string.set:
.. _vmod_taskvar.string.set:
VOID xstring.set(STRING)
------------------------
......@@ -1035,21 +1035,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_string.undefine:
.. _vmod_taskvar.string.undefine:
VOID xstring.undefine()
-----------------------
Undefine the taskvar.
.. _func_string.defined:
.. _vmod_taskvar.string.defined:
BOOL xstring.defined()
----------------------
Return whether the taskvar is defined.
.. _func_string.protect:
.. _vmod_taskvar.string.protect:
VOID xstring.protect()
----------------------
......@@ -1057,14 +1057,14 @@ VOID xstring.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_string.protected:
.. _vmod_taskvar.string.protected:
BOOL xstring.protected()
------------------------
Return whether the taskvar is protected.
.. _obj_time:
.. _vmod_taskvar.time:
new xtime = taskvar.time([TIME init])
-------------------------------------
......@@ -1073,7 +1073,7 @@ Construct a(n) TIME taskvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_time.get:
.. _vmod_taskvar.time.get:
TIME xtime.get(TIME fallback=0)
-------------------------------
......@@ -1081,7 +1081,7 @@ TIME xtime.get(TIME fallback=0)
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).
.. _func_time.set:
.. _vmod_taskvar.time.set:
VOID xtime.set(TIME)
--------------------
......@@ -1090,21 +1090,21 @@ Set the value of the taskvar.
Triggers a vcl failure for protected variables.
.. _func_time.undefine:
.. _vmod_taskvar.time.undefine:
VOID xtime.undefine()
---------------------
Undefine the taskvar.
.. _func_time.defined:
.. _vmod_taskvar.time.defined:
BOOL xtime.defined()
--------------------
Return whether the taskvar is defined.
.. _func_time.protect:
.. _vmod_taskvar.time.protect:
VOID xtime.protect()
--------------------
......@@ -1112,7 +1112,7 @@ VOID xtime.protect()
Protect the taskvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_time.protected:
.. _vmod_taskvar.time.protected:
BOOL xtime.protected()
----------------------
......
src/vmod_topvar.rst
View file @ 1597ee14
......@@ -20,215 +20,215 @@ SYNOPSIS
import topvar [from "path"]
:ref:`obj_acl`
:ref:`vmod_topvar.acl`
:ref:`func_acl.get`
:ref:`vmod_topvar.acl.get`
:ref:`func_acl.set`
:ref:`vmod_topvar.acl.set`
:ref:`func_acl.undefine`
:ref:`vmod_topvar.acl.undefine`
:ref:`func_acl.defined`
:ref:`vmod_topvar.acl.defined`
:ref:`func_acl.protect`
:ref:`vmod_topvar.acl.protect`
:ref:`func_acl.protected`
:ref:`vmod_topvar.acl.protected`
:ref:`obj_backend`
:ref:`vmod_topvar.backend`
:ref:`func_backend.get`
:ref:`vmod_topvar.backend.get`
:ref:`func_backend.set`
:ref:`vmod_topvar.backend.set`
:ref:`func_backend.undefine`
:ref:`vmod_topvar.backend.undefine`
:ref:`func_backend.defined`
:ref:`vmod_topvar.backend.defined`
:ref:`func_backend.protect`
:ref:`vmod_topvar.backend.protect`
:ref:`func_backend.protected`
:ref:`vmod_topvar.backend.protected`
:ref:`obj_blob`
:ref:`vmod_topvar.blob`
:ref:`func_blob.get`
:ref:`vmod_topvar.blob.get`
:ref:`func_blob.set`
:ref:`vmod_topvar.blob.set`
:ref:`func_blob.undefine`
:ref:`vmod_topvar.blob.undefine`
:ref:`func_blob.defined`
:ref:`vmod_topvar.blob.defined`
:ref:`func_blob.protect`
:ref:`vmod_topvar.blob.protect`
:ref:`func_blob.protected`
:ref:`vmod_topvar.blob.protected`
:ref:`obj_body`
:ref:`vmod_topvar.body`
:ref:`func_body.get`
:ref:`vmod_topvar.body.get`
:ref:`func_body.set`
:ref:`vmod_topvar.body.set`
:ref:`func_body.undefine`
:ref:`vmod_topvar.body.undefine`
:ref:`func_body.defined`
:ref:`vmod_topvar.body.defined`
:ref:`func_body.protect`
:ref:`vmod_topvar.body.protect`
:ref:`func_body.protected`
:ref:`vmod_topvar.body.protected`
:ref:`obj_bool`
:ref:`vmod_topvar.bool`
:ref:`func_bool.get`
:ref:`vmod_topvar.bool.get`
:ref:`func_bool.set`
:ref:`vmod_topvar.bool.set`
:ref:`func_bool.undefine`
:ref:`vmod_topvar.bool.undefine`
:ref:`func_bool.defined`
:ref:`vmod_topvar.bool.defined`
:ref:`func_bool.protect`
:ref:`vmod_topvar.bool.protect`
:ref:`func_bool.protected`
:ref:`vmod_topvar.bool.protected`
:ref:`obj_bytes`
:ref:`vmod_topvar.bytes`
:ref:`func_bytes.get`
:ref:`vmod_topvar.bytes.get`
:ref:`func_bytes.set`
:ref:`vmod_topvar.bytes.set`
:ref:`func_bytes.undefine`
:ref:`vmod_topvar.bytes.undefine`
:ref:`func_bytes.defined`
:ref:`vmod_topvar.bytes.defined`
:ref:`func_bytes.protect`
:ref:`vmod_topvar.bytes.protect`
:ref:`func_bytes.protected`
:ref:`vmod_topvar.bytes.protected`
:ref:`obj_duration`
:ref:`vmod_topvar.duration`
:ref:`func_duration.get`
:ref:`vmod_topvar.duration.get`
:ref:`func_duration.set`
:ref:`vmod_topvar.duration.set`
:ref:`func_duration.undefine`
:ref:`vmod_topvar.duration.undefine`
:ref:`func_duration.defined`
:ref:`vmod_topvar.duration.defined`
:ref:`func_duration.protect`
:ref:`vmod_topvar.duration.protect`
:ref:`func_duration.protected`
:ref:`vmod_topvar.duration.protected`
:ref:`obj_header`
:ref:`vmod_topvar.header`
:ref:`func_header.get`
:ref:`vmod_topvar.header.get`
:ref:`func_header.set`
:ref:`vmod_topvar.header.set`
:ref:`func_header.undefine`
:ref:`vmod_topvar.header.undefine`
:ref:`func_header.defined`
:ref:`vmod_topvar.header.defined`
:ref:`func_header.protect`
:ref:`vmod_topvar.header.protect`
:ref:`func_header.protected`
:ref:`vmod_topvar.header.protected`
:ref:`obj_int`
:ref:`vmod_topvar.int`
:ref:`func_int.get`
:ref:`vmod_topvar.int.get`
:ref:`func_int.set`
:ref:`vmod_topvar.int.set`
:ref:`func_int.undefine`
:ref:`vmod_topvar.int.undefine`
:ref:`func_int.defined`
:ref:`vmod_topvar.int.defined`
:ref:`func_int.protect`
:ref:`vmod_topvar.int.protect`
:ref:`func_int.protected`
:ref:`vmod_topvar.int.protected`
:ref:`obj_ip`
:ref:`vmod_topvar.ip`
:ref:`func_ip.get`
:ref:`vmod_topvar.ip.get`
:ref:`func_ip.set`
:ref:`vmod_topvar.ip.set`
:ref:`func_ip.undefine`
:ref:`vmod_topvar.ip.undefine`
:ref:`func_ip.defined`
:ref:`vmod_topvar.ip.defined`
:ref:`func_ip.protect`
:ref:`vmod_topvar.ip.protect`
:ref:`func_ip.protected`
:ref:`vmod_topvar.ip.protected`
:ref:`obj_probe`
:ref:`vmod_topvar.probe`
:ref:`func_probe.get`
:ref:`vmod_topvar.probe.get`
:ref:`func_probe.set`
:ref:`vmod_topvar.probe.set`
:ref:`func_probe.undefine`
:ref:`vmod_topvar.probe.undefine`
:ref:`func_probe.defined`
:ref:`vmod_topvar.probe.defined`
:ref:`func_probe.protect`
:ref:`vmod_topvar.probe.protect`
:ref:`func_probe.protected`
:ref:`vmod_topvar.probe.protected`
:ref:`obj_real`
:ref:`vmod_topvar.real`
:ref:`func_real.get`
:ref:`vmod_topvar.real.get`
:ref:`func_real.set`
:ref:`vmod_topvar.real.set`
:ref:`func_real.undefine`
:ref:`vmod_topvar.real.undefine`
:ref:`func_real.defined`
:ref:`vmod_topvar.real.defined`
:ref:`func_real.protect`
:ref:`vmod_topvar.real.protect`
:ref:`func_real.protected`
:ref:`vmod_topvar.real.protected`
:ref:`obj_stevedore`
:ref:`vmod_topvar.stevedore`
:ref:`func_stevedore.get`
:ref:`vmod_topvar.stevedore.get`
:ref:`func_stevedore.set`
:ref:`vmod_topvar.stevedore.set`
:ref:`func_stevedore.undefine`
:ref:`vmod_topvar.stevedore.undefine`
:ref:`func_stevedore.defined`
:ref:`vmod_topvar.stevedore.defined`
:ref:`func_stevedore.protect`
:ref:`vmod_topvar.stevedore.protect`
:ref:`func_stevedore.protected`
:ref:`vmod_topvar.stevedore.protected`
:ref:`obj_string`
:ref:`vmod_topvar.string`
:ref:`func_string.get`
:ref:`vmod_topvar.string.get`
:ref:`func_string.set`
:ref:`vmod_topvar.string.set`
:ref:`func_string.undefine`
:ref:`vmod_topvar.string.undefine`
:ref:`func_string.defined`
:ref:`vmod_topvar.string.defined`
:ref:`func_string.protect`
:ref:`vmod_topvar.string.protect`
:ref:`func_string.protected`
:ref:`vmod_topvar.string.protected`
:ref:`obj_time`
:ref:`vmod_topvar.time`
:ref:`func_time.get`
:ref:`vmod_topvar.time.get`
:ref:`func_time.set`
:ref:`vmod_topvar.time.set`
:ref:`func_time.undefine`
:ref:`vmod_topvar.time.undefine`
:ref:`func_time.defined`
:ref:`vmod_topvar.time.defined`
:ref:`func_time.protect`
:ref:`vmod_topvar.time.protect`
:ref:`func_time.protected`
:ref:`vmod_topvar.time.protected`
DESCRIPTION
......@@ -277,7 +277,7 @@ for the respective type names and the ``.get()`` fallback.
.. just a newline
.. _obj_acl:
.. _vmod_topvar.acl:
new xacl = topvar.acl([ACL init])
---------------------------------
......@@ -286,7 +286,7 @@ Construct a(n) ACL topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_acl.get:
.. _vmod_topvar.acl.get:
ACL xacl.get(ACL fallback)
--------------------------
......@@ -294,7 +294,7 @@ ACL xacl.get(ACL fallback)
Return the value of the topvar or the `fallback` argument
if it is undefined.
.. _func_acl.set:
.. _vmod_topvar.acl.set:
VOID xacl.set(ACL)
------------------
......@@ -303,21 +303,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_acl.undefine:
.. _vmod_topvar.acl.undefine:
VOID xacl.undefine()
--------------------
Undefine the topvar.
.. _func_acl.defined:
.. _vmod_topvar.acl.defined:
BOOL xacl.defined()
-------------------
Return whether the topvar is defined.
.. _func_acl.protect:
.. _vmod_topvar.acl.protect:
VOID xacl.protect()
-------------------
......@@ -325,14 +325,14 @@ VOID xacl.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_acl.protected:
.. _vmod_topvar.acl.protected:
BOOL xacl.protected()
---------------------
Return whether the topvar is protected.
.. _obj_backend:
.. _vmod_topvar.backend:
new xbackend = topvar.backend([BACKEND init])
---------------------------------------------
......@@ -341,7 +341,7 @@ Construct a(n) BACKEND topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_backend.get:
.. _vmod_topvar.backend.get:
BACKEND xbackend.get(BACKEND fallback=0)
----------------------------------------
......@@ -349,7 +349,7 @@ BACKEND xbackend.get(BACKEND fallback=0)
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is no backend.
.. _func_backend.set:
.. _vmod_topvar.backend.set:
VOID xbackend.set(BACKEND)
--------------------------
......@@ -358,21 +358,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_backend.undefine:
.. _vmod_topvar.backend.undefine:
VOID xbackend.undefine()
------------------------
Undefine the topvar.
.. _func_backend.defined:
.. _vmod_topvar.backend.defined:
BOOL xbackend.defined()
-----------------------
Return whether the topvar is defined.
.. _func_backend.protect:
.. _vmod_topvar.backend.protect:
VOID xbackend.protect()
-----------------------
......@@ -380,14 +380,14 @@ VOID xbackend.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_backend.protected:
.. _vmod_topvar.backend.protected:
BOOL xbackend.protected()
-------------------------
Return whether the topvar is protected.
.. _obj_blob:
.. _vmod_topvar.blob:
new xblob = topvar.blob([BLOB init])
------------------------------------
......@@ -396,7 +396,7 @@ Construct a(n) BLOB topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_blob.get:
.. _vmod_topvar.blob.get:
BLOB xblob.get(BLOB fallback)
-----------------------------
......@@ -404,7 +404,7 @@ BLOB xblob.get(BLOB fallback)
Return the value of the topvar or the `fallback` argument
if it is undefined.
.. _func_blob.set:
.. _vmod_topvar.blob.set:
VOID xblob.set(BLOB)
--------------------
......@@ -413,21 +413,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_blob.undefine:
.. _vmod_topvar.blob.undefine:
VOID xblob.undefine()
---------------------
Undefine the topvar.
.. _func_blob.defined:
.. _vmod_topvar.blob.defined:
BOOL xblob.defined()
--------------------
Return whether the topvar is defined.
.. _func_blob.protect:
.. _vmod_topvar.blob.protect:
VOID xblob.protect()
--------------------
......@@ -435,14 +435,14 @@ VOID xblob.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_blob.protected:
.. _vmod_topvar.blob.protected:
BOOL xblob.protected()
----------------------
Return whether the topvar is protected.
.. _obj_body:
.. _vmod_topvar.body:
new xbody = topvar.body([BODY init])
------------------------------------
......@@ -451,7 +451,7 @@ Construct a(n) BODY topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_body.get:
.. _vmod_topvar.body.get:
BODY xbody.get(BODY fallback)
-----------------------------
......@@ -459,7 +459,7 @@ BODY xbody.get(BODY fallback)
Return the value of the topvar or the `fallback` argument
if it is undefined.
.. _func_body.set:
.. _vmod_topvar.body.set:
VOID xbody.set(BODY)
--------------------
......@@ -468,21 +468,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_body.undefine:
.. _vmod_topvar.body.undefine:
VOID xbody.undefine()
---------------------
Undefine the topvar.
.. _func_body.defined:
.. _vmod_topvar.body.defined:
BOOL xbody.defined()
--------------------
Return whether the topvar is defined.
.. _func_body.protect:
.. _vmod_topvar.body.protect:
VOID xbody.protect()
--------------------
......@@ -490,14 +490,14 @@ VOID xbody.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_body.protected:
.. _vmod_topvar.body.protected:
BOOL xbody.protected()
----------------------
Return whether the topvar is protected.
.. _obj_bool:
.. _vmod_topvar.bool:
new xbool = topvar.bool([BOOL init])
------------------------------------
......@@ -506,7 +506,7 @@ Construct a(n) BOOL topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_bool.get:
.. _vmod_topvar.bool.get:
BOOL xbool.get(BOOL fallback)
-----------------------------
......@@ -514,7 +514,7 @@ BOOL xbool.get(BOOL fallback)
Return the value of the topvar or the `fallback` argument
if it is undefined.
.. _func_bool.set:
.. _vmod_topvar.bool.set:
VOID xbool.set(BOOL)
--------------------
......@@ -523,21 +523,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_bool.undefine:
.. _vmod_topvar.bool.undefine:
VOID xbool.undefine()
---------------------
Undefine the topvar.
.. _func_bool.defined:
.. _vmod_topvar.bool.defined:
BOOL xbool.defined()
--------------------
Return whether the topvar is defined.
.. _func_bool.protect:
.. _vmod_topvar.bool.protect:
VOID xbool.protect()
--------------------
......@@ -545,14 +545,14 @@ VOID xbool.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_bool.protected:
.. _vmod_topvar.bool.protected:
BOOL xbool.protected()
----------------------
Return whether the topvar is protected.
.. _obj_bytes:
.. _vmod_topvar.bytes:
new xbytes = topvar.bytes([BYTES init])
---------------------------------------
......@@ -561,7 +561,7 @@ Construct a(n) BYTES topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_bytes.get:
.. _vmod_topvar.bytes.get:
BYTES xbytes.get(BYTES fallback)
--------------------------------
......@@ -569,7 +569,7 @@ BYTES xbytes.get(BYTES fallback)
Return the value of the topvar or the `fallback` argument
if it is undefined.
.. _func_bytes.set:
.. _vmod_topvar.bytes.set:
VOID xbytes.set(BYTES)
----------------------
......@@ -578,21 +578,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_bytes.undefine:
.. _vmod_topvar.bytes.undefine:
VOID xbytes.undefine()
----------------------
Undefine the topvar.
.. _func_bytes.defined:
.. _vmod_topvar.bytes.defined:
BOOL xbytes.defined()
---------------------
Return whether the topvar is defined.
.. _func_bytes.protect:
.. _vmod_topvar.bytes.protect:
VOID xbytes.protect()
---------------------
......@@ -600,14 +600,14 @@ VOID xbytes.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_bytes.protected:
.. _vmod_topvar.bytes.protected:
BOOL xbytes.protected()
-----------------------
Return whether the topvar is protected.
.. _obj_duration:
.. _vmod_topvar.duration:
new xduration = topvar.duration([DURATION init])
------------------------------------------------
......@@ -616,7 +616,7 @@ Construct a(n) DURATION topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_duration.get:
.. _vmod_topvar.duration.get:
DURATION xduration.get(DURATION fallback=0)
-------------------------------------------
......@@ -624,7 +624,7 @@ DURATION xduration.get(DURATION fallback=0)
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is 0s.
.. _func_duration.set:
.. _vmod_topvar.duration.set:
VOID xduration.set(DURATION)
----------------------------
......@@ -633,21 +633,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_duration.undefine:
.. _vmod_topvar.duration.undefine:
VOID xduration.undefine()
-------------------------
Undefine the topvar.
.. _func_duration.defined:
.. _vmod_topvar.duration.defined:
BOOL xduration.defined()
------------------------
Return whether the topvar is defined.
.. _func_duration.protect:
.. _vmod_topvar.duration.protect:
VOID xduration.protect()
------------------------
......@@ -655,14 +655,14 @@ VOID xduration.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_duration.protected:
.. _vmod_topvar.duration.protected:
BOOL xduration.protected()
--------------------------
Return whether the topvar is protected.
.. _obj_header:
.. _vmod_topvar.header:
new xheader = topvar.header([HEADER init])
------------------------------------------
......@@ -671,7 +671,7 @@ Construct a(n) HEADER topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_header.get:
.. _vmod_topvar.header.get:
HEADER xheader.get(HEADER fallback)
-----------------------------------
......@@ -679,7 +679,7 @@ HEADER xheader.get(HEADER fallback)
Return the value of the topvar or the `fallback` argument
if it is undefined.
.. _func_header.set:
.. _vmod_topvar.header.set:
VOID xheader.set(HEADER)
------------------------
......@@ -688,21 +688,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_header.undefine:
.. _vmod_topvar.header.undefine:
VOID xheader.undefine()
-----------------------
Undefine the topvar.
.. _func_header.defined:
.. _vmod_topvar.header.defined:
BOOL xheader.defined()
----------------------
Return whether the topvar is defined.
.. _func_header.protect:
.. _vmod_topvar.header.protect:
VOID xheader.protect()
----------------------
......@@ -710,14 +710,14 @@ VOID xheader.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_header.protected:
.. _vmod_topvar.header.protected:
BOOL xheader.protected()
------------------------
Return whether the topvar is protected.
.. _obj_int:
.. _vmod_topvar.int:
new xint = topvar.int([INT init])
---------------------------------
......@@ -726,7 +726,7 @@ Construct a(n) INT topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_int.get:
.. _vmod_topvar.int.get:
INT xint.get(INT fallback=0)
----------------------------
......@@ -734,7 +734,7 @@ INT xint.get(INT fallback=0)
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is 0.
.. _func_int.set:
.. _vmod_topvar.int.set:
VOID xint.set(INT)
------------------
......@@ -743,21 +743,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_int.undefine:
.. _vmod_topvar.int.undefine:
VOID xint.undefine()
--------------------
Undefine the topvar.
.. _func_int.defined:
.. _vmod_topvar.int.defined:
BOOL xint.defined()
-------------------
Return whether the topvar is defined.
.. _func_int.protect:
.. _vmod_topvar.int.protect:
VOID xint.protect()
-------------------
......@@ -765,14 +765,14 @@ VOID xint.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_int.protected:
.. _vmod_topvar.int.protected:
BOOL xint.protected()
---------------------
Return whether the topvar is protected.
.. _obj_ip:
.. _vmod_topvar.ip:
new xip = topvar.ip([IP init])
------------------------------
......@@ -781,7 +781,7 @@ Construct a(n) IP topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_ip.get:
.. _vmod_topvar.ip.get:
IP xip.get(IP fallback)
-----------------------
......@@ -789,7 +789,7 @@ IP xip.get(IP fallback)
Return the value of the topvar or the `fallback` argument
if it is undefined.
.. _func_ip.set:
.. _vmod_topvar.ip.set:
VOID xip.set(IP)
----------------
......@@ -798,21 +798,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_ip.undefine:
.. _vmod_topvar.ip.undefine:
VOID xip.undefine()
-------------------
Undefine the topvar.
.. _func_ip.defined:
.. _vmod_topvar.ip.defined:
BOOL xip.defined()
------------------
Return whether the topvar is defined.
.. _func_ip.protect:
.. _vmod_topvar.ip.protect:
VOID xip.protect()
------------------
......@@ -820,14 +820,14 @@ VOID xip.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_ip.protected:
.. _vmod_topvar.ip.protected:
BOOL xip.protected()
--------------------
Return whether the topvar is protected.
.. _obj_probe:
.. _vmod_topvar.probe:
new xprobe = topvar.probe([PROBE init])
---------------------------------------
......@@ -836,7 +836,7 @@ Construct a(n) PROBE topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_probe.get:
.. _vmod_topvar.probe.get:
PROBE xprobe.get(PROBE fallback)
--------------------------------
......@@ -844,7 +844,7 @@ PROBE xprobe.get(PROBE fallback)
Return the value of the topvar or the `fallback` argument
if it is undefined.
.. _func_probe.set:
.. _vmod_topvar.probe.set:
VOID xprobe.set(PROBE)
----------------------
......@@ -853,21 +853,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_probe.undefine:
.. _vmod_topvar.probe.undefine:
VOID xprobe.undefine()
----------------------
Undefine the topvar.
.. _func_probe.defined:
.. _vmod_topvar.probe.defined:
BOOL xprobe.defined()
---------------------
Return whether the topvar is defined.
.. _func_probe.protect:
.. _vmod_topvar.probe.protect:
VOID xprobe.protect()
---------------------
......@@ -875,14 +875,14 @@ VOID xprobe.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_probe.protected:
.. _vmod_topvar.probe.protected:
BOOL xprobe.protected()
-----------------------
Return whether the topvar is protected.
.. _obj_real:
.. _vmod_topvar.real:
new xreal = topvar.real([REAL init])
------------------------------------
......@@ -891,7 +891,7 @@ Construct a(n) REAL topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_real.get:
.. _vmod_topvar.real.get:
REAL xreal.get(REAL fallback=0.0)
---------------------------------
......@@ -899,7 +899,7 @@ REAL xreal.get(REAL fallback=0.0)
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is 0.0.
.. _func_real.set:
.. _vmod_topvar.real.set:
VOID xreal.set(REAL)
--------------------
......@@ -908,21 +908,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_real.undefine:
.. _vmod_topvar.real.undefine:
VOID xreal.undefine()
---------------------
Undefine the topvar.
.. _func_real.defined:
.. _vmod_topvar.real.defined:
BOOL xreal.defined()
--------------------
Return whether the topvar is defined.
.. _func_real.protect:
.. _vmod_topvar.real.protect:
VOID xreal.protect()
--------------------
......@@ -930,14 +930,14 @@ VOID xreal.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_real.protected:
.. _vmod_topvar.real.protected:
BOOL xreal.protected()
----------------------
Return whether the topvar is protected.
.. _obj_stevedore:
.. _vmod_topvar.stevedore:
new xstevedore = topvar.stevedore([STEVEDORE init])
---------------------------------------------------
......@@ -946,7 +946,7 @@ Construct a(n) STEVEDORE topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_stevedore.get:
.. _vmod_topvar.stevedore.get:
STEVEDORE xstevedore.get(STEVEDORE fallback)
--------------------------------------------
......@@ -954,7 +954,7 @@ STEVEDORE xstevedore.get(STEVEDORE fallback)
Return the value of the topvar or the `fallback` argument
if it is undefined.
.. _func_stevedore.set:
.. _vmod_topvar.stevedore.set:
VOID xstevedore.set(STEVEDORE)
------------------------------
......@@ -963,21 +963,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_stevedore.undefine:
.. _vmod_topvar.stevedore.undefine:
VOID xstevedore.undefine()
--------------------------
Undefine the topvar.
.. _func_stevedore.defined:
.. _vmod_topvar.stevedore.defined:
BOOL xstevedore.defined()
-------------------------
Return whether the topvar is defined.
.. _func_stevedore.protect:
.. _vmod_topvar.stevedore.protect:
VOID xstevedore.protect()
-------------------------
......@@ -985,14 +985,14 @@ VOID xstevedore.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_stevedore.protected:
.. _vmod_topvar.stevedore.protected:
BOOL xstevedore.protected()
---------------------------
Return whether the topvar is protected.
.. _obj_string:
.. _vmod_topvar.string:
new xstring = topvar.string([STRING init])
------------------------------------------
......@@ -1001,7 +1001,7 @@ Construct a(n) STRING topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_string.get:
.. _vmod_topvar.string.get:
STRING xstring.get(STRING fallback=0)
-------------------------------------
......@@ -1009,7 +1009,7 @@ STRING xstring.get(STRING fallback=0)
Return the value of the topvar or the `fallback` argument
if it is undefined. The default fallback is the empty string.
.. _func_string.set:
.. _vmod_topvar.string.set:
VOID xstring.set(STRING)
------------------------
......@@ -1018,21 +1018,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_string.undefine:
.. _vmod_topvar.string.undefine:
VOID xstring.undefine()
-----------------------
Undefine the topvar.
.. _func_string.defined:
.. _vmod_topvar.string.defined:
BOOL xstring.defined()
----------------------
Return whether the topvar is defined.
.. _func_string.protect:
.. _vmod_topvar.string.protect:
VOID xstring.protect()
----------------------
......@@ -1040,14 +1040,14 @@ VOID xstring.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_string.protected:
.. _vmod_topvar.string.protected:
BOOL xstring.protected()
------------------------
Return whether the topvar is protected.
.. _obj_time:
.. _vmod_topvar.time:
new xtime = topvar.time([TIME init])
------------------------------------
......@@ -1056,7 +1056,7 @@ Construct a(n) TIME topvar with the default value `init`,
if provided. If no `init` value is provided, the variable
will be initially undefined.
.. _func_time.get:
.. _vmod_topvar.time.get:
TIME xtime.get(TIME fallback=0)
-------------------------------
......@@ -1064,7 +1064,7 @@ TIME xtime.get(TIME fallback=0)
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).
.. _func_time.set:
.. _vmod_topvar.time.set:
VOID xtime.set(TIME)
--------------------
......@@ -1073,21 +1073,21 @@ Set the value of the topvar.
Triggers a vcl failure for protected variables.
.. _func_time.undefine:
.. _vmod_topvar.time.undefine:
VOID xtime.undefine()
---------------------
Undefine the topvar.
.. _func_time.defined:
.. _vmod_topvar.time.defined:
BOOL xtime.defined()
--------------------
Return whether the topvar is defined.
.. _func_time.protect:
.. _vmod_topvar.time.protect:
VOID xtime.protect()
--------------------
......@@ -1095,7 +1095,7 @@ VOID xtime.protect()
Protect the topvar, so any future .set() calls on it
trigger a vcl failure.
.. _func_time.protected:
.. _vmod_topvar.time.protected:
BOOL xtime.protected()
----------------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment