Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
V
varnish-cache
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Commits
Open sidebar
varnishcache
varnish-cache
Commits
aa2d8f52
Commit
aa2d8f52
authored
Sep 12, 2018
by
Nils Goroll
Committed by
Dridi Boukelmoune
Oct 16, 2018
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
document vmod $ABI
Text mostly taken from
ecdebdc7
parent
ee7d2d43
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
12 additions
and
1 deletion
+12
-1
vmod.rst
doc/sphinx/reference/vmod.rst
+12
-1
No files found.
doc/sphinx/reference/vmod.rst
View file @
aa2d8f52
...
...
@@ -51,6 +51,7 @@ data structures that do all the hard work.
The std VMODs vmod.vcc file looks somewhat like this::
$Module std 3
$ABI strict
$Event event_function
$Function STRING toupper(STRING_LIST)
$Function STRING tolower(STRING_LIST)
...
...
@@ -59,7 +60,17 @@ The std VMODs vmod.vcc file looks somewhat like this::
The first line gives the name of the module and the manual section where
the documentation will reside.
The second line specifies an optional "Event" function, which will be
The ``$ABI`` line is optional (possible values ``strict`` (default)
and ``vrt``) and allows to specify that a vmod is integrating with the
blessed ``vrt`` interface provided by ``varnishd`` or go deeper in the
stack. As a general rule of thumb you are considered "on your own" if
your VMOD uses more than the VRT (Varnish RunTime), in which case it
needs to be built for the exact Varnish version.
``$ABI vrt`` means that a module complies to the VRT and only needs to
be rebuilt when breaking changes are introduced to the VRT API.
The third line specifies an optional "Event" function, which will be
called whenever a VCL program which imports this VMOD is loaded or
transitions to any of the warm, active, cold or discarded states.
More on this below.
...
...
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