.\" Man page generated from reStructuredText.
.
.TH VMOD_VAR 3 "" "" ""
.SH NAME
vmod_var \- Variable support for Varnish VCL
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" 
.
.\" NB:  This file is machine generated, DO NOT EDIT!
.
.\" 
.
.\" Edit vmod.vcc and run make instead
.
.\" 
.
.SH SYNOPSIS
.sp
import var [from "path"] ;
.sp
This VMOD implements basic variable support in VCL.
.sp
It supports strings, integers and real numbers. There are methods to get and
set each data type.
.sp
Global variables have a lifespan that extends across requests and
VCLs, for as long as the vmod is loaded.
.sp
The remaining functions have PRIV_TASK lifespan and are local to a single
request or backend request.
.SH CONTENTS
.INDENT 0.0
.IP \(bu 2
\fIfunc_clear\fP
.IP \(bu 2
\fIfunc_get\fP
.IP \(bu 2
\fIfunc_get_duration\fP
.IP \(bu 2
\fIfunc_get_int\fP
.IP \(bu 2
\fIfunc_get_ip\fP
.IP \(bu 2
\fIfunc_get_real\fP
.IP \(bu 2
\fIfunc_get_string\fP
.IP \(bu 2
\fIfunc_global_get\fP
.IP \(bu 2
\fIfunc_global_set\fP
.IP \(bu 2
\fIfunc_set\fP
.IP \(bu 2
\fIfunc_set_duration\fP
.IP \(bu 2
\fIfunc_set_int\fP
.IP \(bu 2
\fIfunc_set_ip\fP
.IP \(bu 2
\fIfunc_set_real\fP
.IP \(bu 2
\fIfunc_set_string\fP
.UNINDENT
.SS set
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
VOID set(PRIV_TASK, STRING key, STRING value)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set \fIkey\fP to \fIvalue\fP\&.
.SS get
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
STRING get(PRIV_TASK, STRING)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Get \fIkey\fP with data type STRING. If stored \fIkey\fP is not a STRING an empty string is returned.
.SS global_set
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
VOID global_set(STRING, STRING)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS global_get
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
STRING global_get(STRING)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS set_int
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
VOID set_int(PRIV_TASK, STRING key, INT value)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set \fIkey\fP to \fIvalue\fP\&.
.SS get_int
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
INT get_int(PRIV_TASK, STRING key)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Get \fIkey\fP with data type INT. If stored \fIkey\fP is not an INT zero will be returned.
.SS set_string
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
VOID set_string(PRIV_TASK, STRING key, STRING value)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Identical to set().
.SS get_string
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
STRING get_string(PRIV_TASK, STRING key)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Identical to get().
.SS set_real
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
VOID set_real(PRIV_TASK, STRING key, REAL value)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set \fIkey\fP to \fIvalue\fP\&.
.SS get_real
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
REAL get_real(PRIV_TASK, STRING key)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Get \fIkey\fP with data type REAL. If stored \fIkey\fP is not a REAL zero will be returned.
.SS set_duration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
VOID set_duration(PRIV_TASK, STRING key, DURATION value)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set \fIkey\fP to \fIvalue\fP\&.
.SS get_duration
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
DURATION get_duration(PRIV_TASK, STRING key)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Get \fIkey\fP with data type DURATION. If stored \fIkey\fP is not a DURATION zero will be returned.
.SS set_ip
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
VOID set_ip(PRIV_TASK, STRING key, IP value)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set \fIkey\fP to \fIvalue\fP\&.
.SS get_ip
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
IP get_ip(PRIV_TASK, STRING key)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Get \fIkey\fP with data type IP. If stored \fIkey\fP is not an IP null will be returned.
.SS clear
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
VOID clear(PRIV_TASK)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Clear all non\-global variables.
.\" Generated by docutils manpage writer.
.