← Back to branch summary

~ubuntu-branches/ubuntu/trusty/varnish/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/sphinx/reference/vmod_std.rst

  • Committer: Package Import Robot
  • Author(s): Stig Sandbeck Mathisen, Stig Sandbeck Mathisen, Tollef Fog Heen
  • Date: 2013-05-05 15:53:14 UTC
  • mfrom: (0.1.16)
  • Revision ID: package-import@ubuntu.com-20130505155314-i99wuol99cfwzrtv
Tags: 3.0.3-1
http://bugs.debian.org/698577
http://bugs.debian.org/698577
[ Stig Sandbeck Mathisen ]
* New upstream release

[ Tollef Fog Heen ]
* Make varnishlog's and varnishncsa's init script exit with the exit
  status of status_of_proc to make them useful.  Fixes upstream trac
  #1226.

[ Stig Sandbeck Mathisen ]
* Do not rewrite /etc/default/varnish on upgrade.
  Thanks to Andreas Beckmann <anbe@debian.org> (Closes: 698577)
* Undo mangling of /etc/default/varnish that happened during lenny->squeeze
  upgrade.
  Thanks to Andreas Beckmann <anbe@debian.org> (Closes: 698577)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/sphinx/reference/vmod_std.rst
31
31
-------
32
32
 
33
33
Prototype
34
 
        toupper(STRING S)
 
34
        toupper(STRING s)
35
35
Return value
36
 
       String
 
36
        String
37
37
Description
38
 
        Converts the STRING S to upper case.
 
38
        Converts the string *s* to upper case.
39
39
Example
40
40
        set beresp.http.x-scream = std.toupper("yes!");
41
41
 
42
42
tolower
43
43
-------
44
44
Prototype
45
 
        tolower(STRING S)
 
45
        tolower(STRING s)
46
46
Return value
47
 
       String
 
47
        String
48
48
Description
49
 
        Converts the STRING to lower case.
 
49
        Converts the string *s* to lower case.
50
50
Example
51
 
        set beresp.http.x-nice = std.tolower("VerY");
 
51
        set beresp.http.x-nice = std.tolower("VerY");
52
52
 
53
 
set_up_tos
 
53
set_ip_tos
54
54
----------
55
55
Prototype
56
 
        set_ip_tos(INT I)
 
56
        set_ip_tos(INT i)
57
57
Return value
58
 
       Void
 
58
        Void
59
59
Description
60
60
        Sets the Type-of-Service flag for the current session. Please
61
61
        note that the TOS flag is not removed by the end of the
71
71
Prototype
72
72
        random(REAL a, REAL b)
73
73
Return value
74
 
       Real
 
74
        Real
75
75
Description
76
76
        Returns a random REAL number between *a* and *b*.
77
77
Example
82
82
Prototype
83
83
        log(STRING string)
84
84
Return value
85
 
       Void
 
85
        Void
86
86
Description
87
 
        Logs string to the shared memory log.
 
87
        Logs *string* to the shared memory log.
88
88
Example
89
89
        std.log("Something fishy is going on with the vhost " + req.host);
90
90
 
93
93
Prototype
94
94
        syslog(INT priority, STRING string)
95
95
Return value
96
 
        Void
 
96
        Void
97
97
Description
98
98
        Logs *string* to syslog marked with *priority*.
99
99
Example
104
104
Prototype
105
105
        fileread(STRING filename)
106
106
Return value
107
 
        String
 
107
        String
108
108
Description
109
109
        Reads a file and returns a string with the content. Please
110
110
        note that it is not recommended to send variables to this
118
118
Prototype
119
119
        duration(STRING s, DURATION fallback)
120
120
Return value
121
 
       Duration
 
121
        Duration
122
122
Description
123
 
        Converts the string s to seconds. s can be quantified with the
124
 
        usual s (seconds), m (minutes), h (hours), d (days) and w
125
 
        (weeks) units. If it fails to parse the string *fallback* 
126
 
        will be used
 
123
        Converts the string *s* to seconds. *s* can be quantified with
 
124
        the usual s (seconds), m (minutes), h (hours), d (days) and w
 
125
        (weeks) units. If *s* fails to parse, *fallback* will be used.
127
126
Example
128
 
        set beresp.ttl = std.duration("1w", 3600);
 
127
        set beresp.ttl = std.duration("1w", 3600s);
129
128
 
130
129
integer
131
130
--------
132
131
Prototype
133
132
        integer(STRING s, INT fallback)
134
133
Return value
135
 
       Int
 
134
        Int
136
135
Description
137
 
        Converts the string s to an integer.  If it fails to parse the
138
 
        string *fallback* will be used
 
136
        Converts the string *s* to an integer.  If *s* fails to parse,
 
137
        *fallback* will be used
139
138
Example
140
 
        if (std.integer(beresp.http.x-foo, 0) > 5) { … }
 
139
        if (std.integer(beresp.http.x-foo, 0) > 5) { ... }
141
140
 
142
141
collect
143
142
-------
144
143
Prototype
145
144
        collect(HEADER header)
146
145
Return value
147
 
       Void
 
146
        Void
148
147
Description
149
148
        Collapses the header, joining the headers into one.
150
149
Example