tcpwrap_check
Introduction
Other Services
PHP Manual

# Varnish

Table of Contents

- Introduction
- Installing/Configuring
  - Requirements
  - Installation
  - Runtime Configuration
  - Resource Types
- Predefined Constants
- Examples
  - Basic VarnishAdmin usage
  - Basic VarnishStat usage
  - Basic VarnishLog usage
- VarnishAdmin — The VarnishAdmin class
  - VarnishAdmin::auth — Authenticate on a varnish instance
  - VarnishAdmin::ban — Ban URLs using a VCL expression
  - VarnishAdmin::banUrl — Ban an URL using a VCL expression
  - VarnishAdmin::clearPanic — Clear varnish instance panic messages
  - VarnishAdmin::connect — Connect to a varnish instance administration interface
  - VarnishAdmin::__construct — VarnishAdmin constructor
  - VarnishAdmin::disconnect — Disconnect from a varnish instance administration interface
  - VarnishAdmin::getPanic — Get the last panic message on a varnish instance
  - VarnishAdmin::getParams — Fetch current varnish instance configuration parameters
  - VarnishAdmin::isRunning — Check if the varnish slave process is currently running
  - VarnishAdmin::setCompat — Set the class compat configuration param
  - VarnishAdmin::setHost — Set the class host configuration param
  - VarnishAdmin::setIdent — Set the class ident configuration param
  - VarnishAdmin::setParam — Set configuration param on the current varnish instance
  - VarnishAdmin::setPort — Set the class port configuration param
  - VarnishAdmin::setSecret — Set the class secret configuration param
  - VarnishAdmin::setTimeout — Set the class timeout configuration param
  - VarnishAdmin::start — Start varnish worker process
  - VarnishAdmin::stop — Stop varnish worker process
- VarnishStat — The VarnishStat class
  - VarnishStat::__construct — VarnishStat constructor
  - VarnishStat::getSnapshot — Get the current varnish instance statistics snapshot
- VarnishLog — The VarnishLog class
  - VarnishLog::__construct — Varnishlog constructor
  - VarnishLog::getLine — Get next log line
  - VarnishLog::getTagName — Get the log tag string representation by its index

# The VarnishAdmin class

## Introduction

## Class synopsis

VarnishAdmin
class VarnishAdmin {
/* Methods */
public bool auth ( void )
public int ban ( string `$vcl_regex` )
public int banUrl ( string `$vcl_regex` )
public int clearPanic ( void )
public bool connect ( void )
public __construct ([ array `$args` ] )
public bool disconnect ( void )
public string getPanic ( void )
public array getParams ( void )
public bool isRunning ( void )
public void setCompat ( int `$compat` )
public void setHost ( string `$host` )
public void setIdent ( string `$ident` )
public int setParam ( string `$name` , string|integer `$value` )
public void setPort ( int `$port` )
public void setSecret ( string `$secret` )
public void setTimeout ( int `$timeout` )
public int start ( void )
public int stop ( void )
}

# The VarnishStat class

## Introduction

## Class synopsis

VarnishStat
class VarnishStat {
/* Methods */
public __construct ([ array `$args` ] )
public array getSnapshot ( void )
}

# The VarnishLog class

## Introduction

## Class synopsis

VarnishLog
class VarnishLog {
/* Constants */
const integer VarnishLog::TAG_Debug = 0 ;
const integer VarnishLog::TAG_Error = 1 ;
const integer VarnishLog::TAG_CLI = 2 ;
const integer VarnishLog::TAG_StatSess = 3 ;
const integer VarnishLog::TAG_ReqEnd = 4 ;
const integer VarnishLog::TAG_SessionOpen = 5 ;
const integer VarnishLog::TAG_SessionClose = 6 ;
const integer VarnishLog::TAG_BackendOpen = 7 ;
const integer VarnishLog::TAG_BackendXID = 8 ;
const integer VarnishLog::TAG_BackendReuse = 9 ;
const integer VarnishLog::TAG_BackendClose = 10 ;
const integer VarnishLog::TAG_HttpGarbage = 11 ;
const integer VarnishLog::TAG_Backend = 12 ;
const integer VarnishLog::TAG_Length = 13 ;
const integer VarnishLog::TAG_FetchError = 14 ;
const integer VarnishLog::TAG_RxRequest = 15 ;
const integer VarnishLog::TAG_RxResponse = 16 ;
const integer VarnishLog::TAG_RxStatus = 17 ;
const integer VarnishLog::TAG_RxURL = 18 ;
const integer VarnishLog::TAG_RxProtocol = 19 ;
const integer VarnishLog::TAG_RxHeader = 20 ;
const integer VarnishLog::TAG_TxRequest = 21 ;
const integer VarnishLog::TAG_TxResponse = 22 ;
const integer VarnishLog::TAG_TxStatus = 23 ;
const integer VarnishLog::TAG_TxURL = 24 ;
const integer VarnishLog::TAG_TxProtocol = 25 ;
const integer VarnishLog::TAG_TxHeader = 26 ;
const integer VarnishLog::TAG_ObjRequest = 27 ;
const integer VarnishLog::TAG_ObjResponse = 28 ;
const integer VarnishLog::TAG_ObjStatus = 29 ;
const integer VarnishLog::TAG_ObjURL = 30 ;
const integer VarnishLog::TAG_ObjProtocol = 31 ;
const integer VarnishLog::TAG_ObjHeader = 32 ;
const integer VarnishLog::TAG_LostHeader = 33 ;
const integer VarnishLog::TAG_TTL = 34 ;
const integer VarnishLog::TAG_Fetch_Body = 35 ;
const integer VarnishLog::TAG_VCL_acl = 36 ;
const integer VarnishLog::TAG_VCL_call = 37 ;
const integer VarnishLog::TAG_VCL_trace = 38 ;
const integer VarnishLog::TAG_VCL_return = 39 ;
const integer VarnishLog::TAG_VCL_error = 40 ;
const integer VarnishLog::TAG_ReqStart = 41 ;
const integer VarnishLog::TAG_Hit = 42 ;
const integer VarnishLog::TAG_HitPass = 43 ;
const integer VarnishLog::TAG_ExpBan = 44 ;
const integer VarnishLog::TAG_ExpKill = 45 ;
const integer VarnishLog::TAG_WorkThread = 46 ;
const integer VarnishLog::TAG_ESI_xmlerror = 47 ;
const integer VarnishLog::TAG_Hash = 48 ;
const integer VarnishLog::TAG_Backend_health = 49 ;
const integer VarnishLog::TAG_VCL_Log = 50 ;
const integer VarnishLog::TAG_Gzip = 51 ;
/* Methods */
public __construct ([ array `$args` ] )
public array getLine ( void )
public static string getTagName ( int `$index` )
}

## Predefined Constants

`VarnishLog::TAG_Debug`

`VarnishLog::TAG_Error`

`VarnishLog::TAG_CLI`

`VarnishLog::TAG_StatSess`

`VarnishLog::TAG_ReqEnd`

`VarnishLog::TAG_SessionOpen`

`VarnishLog::TAG_SessionClose`

`VarnishLog::TAG_BackendOpen`

`VarnishLog::TAG_BackendXID`

`VarnishLog::TAG_BackendReuse`

`VarnishLog::TAG_BackendClose`

`VarnishLog::TAG_HttpGarbage`

`VarnishLog::TAG_Backend`

`VarnishLog::TAG_Length`

`VarnishLog::TAG_FetchError`

`VarnishLog::TAG_RxRequest`

`VarnishLog::TAG_RxResponse`

`VarnishLog::TAG_RxStatus`

`VarnishLog::TAG_RxURL`

`VarnishLog::TAG_RxProtocol`

`VarnishLog::TAG_RxHeader`

`VarnishLog::TAG_TxRequest`

`VarnishLog::TAG_TxResponse`

`VarnishLog::TAG_TxStatus`

`VarnishLog::TAG_TxURL`

`VarnishLog::TAG_TxProtocol`

`VarnishLog::TAG_TxHeader`

`VarnishLog::TAG_ObjRequest`

`VarnishLog::TAG_ObjResponse`

`VarnishLog::TAG_ObjStatus`

`VarnishLog::TAG_ObjURL`

`VarnishLog::TAG_ObjProtocol`

`VarnishLog::TAG_ObjHeader`

`VarnishLog::TAG_LostHeader`

`VarnishLog::TAG_TTL`

`VarnishLog::TAG_Fetch_Body`

`VarnishLog::TAG_VCL_acl`

`VarnishLog::TAG_VCL_call`

`VarnishLog::TAG_VCL_trace`

`VarnishLog::TAG_VCL_return`

`VarnishLog::TAG_VCL_error`

`VarnishLog::TAG_ReqStart`

`VarnishLog::TAG_Hit`

`VarnishLog::TAG_HitPass`

`VarnishLog::TAG_ExpBan`

`VarnishLog::TAG_ExpKill`

`VarnishLog::TAG_WorkThread`

`VarnishLog::TAG_ESI_xmlerror`

`VarnishLog::TAG_Hash`

`VarnishLog::TAG_Backend_health`

`VarnishLog::TAG_VCL_Log`

`VarnishLog::TAG_Gzip`