..
.. 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 set(PRIV_TASK, STRING, STRING)
* STRING get(PRIV_TASK, STRING)
* VOID global_set(STRING, STRING)
* STRING global_get(STRING)
* VOID set_int(PRIV_TASK, STRING, INT)
* INT get_int(PRIV_TASK, STRING)
* VOID set_string(PRIV_TASK, STRING, STRING)
* STRING get_string(PRIV_TASK, STRING)
* VOID set_real(PRIV_TASK, STRING, REAL)
* REAL get_real(PRIV_TASK, STRING)
* VOID set_duration(PRIV_TASK, STRING, DURATION)
* DURATION get_duration(PRIV_TASK, STRING)
* VOID clear(PRIV_TASK)
* VOID global_clear()
* BOOL global_defined(STRING)
* VOID global_unset(STRING)
* BOOL defined(PRIV_TASK, STRING)
* STRING type_of(PRIV_TASK, STRING)
* VOID unset(PRIV_TASK, STRING)
* VOID regset(PRIV_TASK, STRING, STRING, STRING)
* VOID queryset(PRIV_TASK, STRING, STRING)

.. _func_set:

set
---

::

	VOID set(PRIV_TASK, STRING, STRING)

.. _func_get:

get
---

::

	STRING get(PRIV_TASK, STRING)

.. _func_global_set:

global_set
----------

::

	VOID global_set(STRING, STRING)

.. _func_global_get:

global_get
----------

::

	STRING global_get(STRING)

.. _func_set_int:

set_int
-------

::

	VOID set_int(PRIV_TASK, STRING, INT)

.. _func_get_int:

get_int
-------

::

	INT get_int(PRIV_TASK, STRING)

.. _func_set_string:

set_string
----------

::

	VOID set_string(PRIV_TASK, STRING, STRING)

.. _func_get_string:

get_string
----------

::

	STRING get_string(PRIV_TASK, STRING)

.. _func_set_real:

set_real
--------

::

	VOID set_real(PRIV_TASK, STRING, REAL)

.. _func_get_real:

get_real
--------

::

	REAL get_real(PRIV_TASK, STRING)

.. _func_set_duration:

set_duration
------------

::

	VOID set_duration(PRIV_TASK, STRING, DURATION)

.. _func_get_duration:

get_duration
------------

::

	DURATION get_duration(PRIV_TASK, STRING)

.. _func_clear:

clear
-----

::

	VOID clear(PRIV_TASK)

.. _func_global_clear:

global_clear
------------

::

	VOID global_clear()

.. _func_global_defined:

global_defined
--------------

::

	BOOL global_defined(STRING)

.. _func_global_unset:

global_unset
------------

::

	VOID global_unset(STRING)

.. _func_defined:

defined
-------

::

	BOOL defined(PRIV_TASK, STRING)

.. _func_type_of:

type_of
-------

::

	STRING type_of(PRIV_TASK, STRING)

.. _func_unset:

unset
-----

::

	VOID unset(PRIV_TASK, STRING)

.. _func_regset:

regset
------

::

	VOID regset(PRIV_TASK, STRING, STRING, STRING)

.. _func_queryset:

queryset
--------

::

	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/>.

