[7.4] c6afd311f Reflect API rename in docs
Dridi Boukelmoune
dridi.boukelmoune at gmail.com
Tue Sep 19 04:56:04 UTC 2023
commit c6afd311f05eb6ff270c36459d50bae0586d1ebb
Author: Nils Goroll <nils.goroll at uplex.de>
Date: Mon Sep 18 17:14:45 2023 +0200
Reflect API rename in docs
Ref 5df6f8d46cb08ae435f866b8e6c1bb333cebdee3
diff --git a/doc/sphinx/reference/vmod.rst b/doc/sphinx/reference/vmod.rst
index 135983ff2..b8a524ce6 100644
--- a/doc/sphinx/reference/vmod.rst
+++ b/doc/sphinx/reference/vmod.rst
@@ -741,15 +741,15 @@ not be left half-initialized should a failure occur.
If your VMOD is running an asynchronous background job you can hold a reference
to the VCL to prevent it from going cold too soon and get the same guarantees
as backends with ongoing requests for instance. For that, you must acquire the
-reference by calling ``VRT_ref_vcl`` when you receive a ``VCL_EVENT_WARM`` and
-later calling ``VRT_rel_vcl`` once the background job is over. Receiving a
+reference by calling ``VRT_VCL_Prevent_Discard`` when you receive a ``VCL_EVENT_WARM`` and
+later calling ``VRT_VCL_Allow_Discard`` once the background job is over. Receiving a
``VCL_EVENT_COLD`` is your cue to terminate any background job bound to a VCL.
You can find an example of VCL references in vmod-debug::
- priv_vcl->vclref = VRT_ref_vcl(ctx, "vmod-debug");
+ priv_vcl->vclref = VRT_VCL_Prevent_Discard(ctx, "vmod-debug");
...
- VRT_rel_vcl(&ctx, &priv_vcl->vclref);
+ VRT_VCL_Allow_Discard(&ctx, &priv_vcl->vclref);
In this simplified version, you can see that you need at least a VCL-bound data
structure like a ``PRIV_VCL`` or a VMOD object to keep track of the reference
More information about the varnish-commit
mailing list