Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
VMOD_VAR(3)		   Library Functions Manual		   VMOD_VAR(3)

NAME
       vmod_var	- Variable support for Varnish VCL

SYNOPSIS
	  import var [as name] [from "path"]

	  VOID set(STRING key, STRING value)

	  STRING get(STRING)

	  VOID global_set(STRING, STRING)

	  STRING global_get(STRING)

	  VOID set_int(STRING key, INT value)

	  INT get_int(STRING key)

	  VOID set_string(STRING key, STRING value)

	  STRING get_string(STRING key)

	  VOID set_real(STRING key, REAL value)

	  REAL get_real(STRING key)

	  VOID set_duration(STRING key,	DURATION value)

	  DURATION get_duration(STRING key)

	  VOID set_ip(STRING key, IP value)

	  IP get_ip(STRING key)

	  VOID set_backend(STRING key, BACKEND value)

	  BACKEND get_backend(STRING key)

	  VOID clear()

       This VMOD implements basic variable support in VCL.

       It  supports  strings,  integers, real numbers, durations, IP addresses
       and backends. There are methods to get and set each data	type.

       Global variables	have a lifespan	that extends across requests and VCLs,
       for as long as the  vmod	 is  loaded.  Global  variables	 only  support
       strings.

       The remaining functions have PRIV_TASK lifespan and are local to	a sin-
       gle request or backend request.

       Example:

	  vcl 4.0;
	  import var;

	  backend default { .host = "192.0.2.11"; .port	= "8080"; }

	  sub vcl_recv {
	      #	Set and	get some values.
	      var.set("foo", "bar");
	      set req.http.x-foo = var.get("foo");

	      var.set_int("ten", 10);
	      var.set_int("five", 5);
	      set req.http.twenty = var.get_int("ten") + var.get_int("five") + 5;

	      #	VCL will use the first token to	decide final data type.	Headers	are strings.
	      #	set req.http.X-lifetime	= var.get_int("ten") + " seconds"; #  Won't work.
	      set req.http.X-lifetime =	"" + var.get_int("ten")	+ " seconds";  # Works!

	      var.set_duration("timedelta", 1m);  # 60s
	      set req.http.d1 =	var.get_duration("timedelta");

	      var.set_ip("endpoint", client.ip);
	      set req.http.x-client = var.get_ip("endpoint");

	      #	Unset all non-global variables.
	      var.clear();

	      #	Demonstrate use	of global variables as state flags.
	      if (req.url ~ "/close$") {
		  var.global_set("open", "no");
	      }
	      else if (req.url ~ "/open$") {
		  var.global_set("open", "yes");
	      }

	      if (var.global_get("open") != "yes") {
		  return (synth(200, "We are currently closed, sorry!"));
	      }
	  }

   VOID	set(STRING key,	STRING value)
       Set key to value.

   STRING get(STRING)
       Get  key	 with  data  type STRING. If stored key	is not a STRING	a NULL
       string is returned.

   VOID	global_set(STRING, STRING)
   STRING global_get(STRING)
   VOID	set_int(STRING key, INT	value)
       Set key to value.

   INT get_int(STRING key)
       Get key with data type INT. If stored key is not	an INT	zero  will  be
       returned.

   VOID	set_string(STRING key, STRING value)
       Identical to set().

   STRING get_string(STRING key)
       Identical to get().

   VOID	set_real(STRING	key, REAL value)
       Set key to value.

   REAL	get_real(STRING	key)
       Get  key	 with data type	REAL. If stored	key is not a REAL zero will be
       returned.

   VOID	set_duration(STRING key, DURATION value)
       Set key to value.

   DURATION get_duration(STRING	key)
       Get key with data type DURATION.	If stored key is not a	DURATION  zero
       will be returned.

   VOID	set_ip(STRING key, IP value)
       Set key to value.

   IP get_ip(STRING key)
       Get  key	with data type IP. If stored key is not	an IP null will	be re-
       turned.

   VOID	set_backend(STRING key,	BACKEND	value)
       Set key to value.

   BACKEND get_backend(STRING key)
       Get key with data type BACKEND. If stored key is	not  a	BACKEND,  null
       will be returned.

   VOID	clear()
       Clear all non-global variables.

								   VMOD_VAR(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=vmod_var&sektion=3&manpath=FreeBSD+Ports+15.0.quarterly>

home | help