..
.. NB:  This file is machine generated, DO NOT EDIT!
..
.. Edit vmod.vcc and run make instead
..

.. role:: ref(emphasis)

.. _vmod_variable(3):

=============
vmod_variable
=============

----------------------------
Variable Support for Varnish
----------------------------

:Manual section: 3

SYNOPSIS
========

import variable [from "path"] ;


COLOPHON
========
Due to limitations of the vmodtool.py utility, this document contains
only prototypes of the functions provided by the **vmod-variable** module.
For a detailed documentation, please see vmod-variable(3) manual page.

CONTENTS
========

* VOID clear(PRIV_TASK)
* BOOL defined(PRIV_TASK, STRING)
* STRING get(PRIV_TASK, STRING)
* DURATION get_duration(PRIV_TASK, STRING)
* INT get_int(PRIV_TASK, STRING)
* REAL get_real(PRIV_TASK, STRING)
* STRING get_string(PRIV_TASK, STRING)
* VOID global_clear()
* BOOL global_defined(STRING)
* STRING global_get(STRING)
* VOID global_set(STRING, STRING)
* VOID global_unset(STRING)
* VOID queryset(PRIV_TASK, STRING, STRING)
* VOID regset(PRIV_TASK, STRING, STRING, STRING)
* VOID set(PRIV_TASK, STRING, STRING)
* VOID set_duration(PRIV_TASK, STRING, DURATION)
* VOID set_int(PRIV_TASK, STRING, INT)
* VOID set_real(PRIV_TASK, STRING, REAL)
* VOID set_string(PRIV_TASK, STRING, STRING)
* STRING type_of(PRIV_TASK, STRING)
* VOID unset(PRIV_TASK, STRING)

.. _func_set:

VOID set(PRIV_TASK, STRING, STRING)
-----------------------------------

Prototype
	VOID set(PRIV_TASK, STRING, STRING)

.. _func_get:

STRING get(PRIV_TASK, STRING)
-----------------------------

Prototype
	STRING get(PRIV_TASK, STRING)

.. _func_global_set:

VOID global_set(STRING, STRING)
-------------------------------

Prototype
	VOID global_set(STRING, STRING)

.. _func_global_get:

STRING global_get(STRING)
-------------------------

Prototype
	STRING global_get(STRING)

.. _func_set_int:

VOID set_int(PRIV_TASK, STRING, INT)
------------------------------------

Prototype
	VOID set_int(PRIV_TASK, STRING, INT)

.. _func_get_int:

INT get_int(PRIV_TASK, STRING)
------------------------------

Prototype
	INT get_int(PRIV_TASK, STRING)

.. _func_set_string:

VOID set_string(PRIV_TASK, STRING, STRING)
------------------------------------------

Prototype
	VOID set_string(PRIV_TASK, STRING, STRING)

.. _func_get_string:

STRING get_string(PRIV_TASK, STRING)
------------------------------------

Prototype
	STRING get_string(PRIV_TASK, STRING)

.. _func_set_real:

VOID set_real(PRIV_TASK, STRING, REAL)
--------------------------------------

Prototype
	VOID set_real(PRIV_TASK, STRING, REAL)

.. _func_get_real:

REAL get_real(PRIV_TASK, STRING)
--------------------------------

Prototype
	REAL get_real(PRIV_TASK, STRING)

.. _func_set_duration:

VOID set_duration(PRIV_TASK, STRING, DURATION)
----------------------------------------------

Prototype
	VOID set_duration(PRIV_TASK, STRING, DURATION)

.. _func_get_duration:

DURATION get_duration(PRIV_TASK, STRING)
----------------------------------------

Prototype
	DURATION get_duration(PRIV_TASK, STRING)

.. _func_clear:

VOID clear(PRIV_TASK)
---------------------

Prototype
	VOID clear(PRIV_TASK)

.. _func_global_clear:

VOID global_clear()
-------------------

Prototype
	VOID global_clear()

.. _func_global_defined:

BOOL global_defined(STRING)
---------------------------

Prototype
	BOOL global_defined(STRING)

.. _func_global_unset:

VOID global_unset(STRING)
-------------------------

Prototype
	VOID global_unset(STRING)

.. _func_defined:

BOOL defined(PRIV_TASK, STRING)
-------------------------------

Prototype
	BOOL defined(PRIV_TASK, STRING)

.. _func_type_of:

STRING type_of(PRIV_TASK, STRING)
---------------------------------

Prototype
	STRING type_of(PRIV_TASK, STRING)

.. _func_unset:

VOID unset(PRIV_TASK, STRING)
-----------------------------

Prototype
	VOID unset(PRIV_TASK, STRING)

.. _func_regset:

VOID regset(PRIV_TASK, STRING, STRING, STRING)
----------------------------------------------

Prototype
	VOID regset(PRIV_TASK, STRING, STRING, STRING)

.. _func_queryset:

VOID queryset(PRIV_TASK, STRING, STRING)
----------------------------------------

Prototype
	VOID queryset(PRIV_TASK, STRING, STRING)

COPYRIGHT
=========

::

  This file is part of vmod-variable
  Copyright (C) 2015-2017 Sergey Poznyakoff
  
  Vmod-variable is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 3, or (at your option)
  any later version.
  
  Vmod-variable is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with vmod-variable.  If not, see <http://www.gnu.org/licenses/>.

