documentation/api/modules/luci.http.protocol.date.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   5     <title>Reference</title>
   6     <link rel="stylesheet" href="../luadoc.css" type="text/css" />
   7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  14         <div id="product_logo"></div>
  15         <div id="product_name"><big><b></b></big></div>
  16         <div id="product_description"></div>
  17 </div> <!-- id="product" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  47         </li>
  48
  49         <li><strong>luci.http.protocol.date</strong></li>
  50
  51         <li>
  52                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
  53         </li>
  54
  55         <li>
  56                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  57         </li>
  58
  59         <li>
  60                 <a href="../modules/luci.ip.html">luci.ip</a>
  61         </li>
  62
  63         <li>
  64                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  65         </li>
  66
  67         <li>
  68                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  69         </li>
  70
  71         <li>
  72                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  73         </li>
  74
  75         <li>
  76                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
  77         </li>
  78
  79         <li>
  80                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
  81         </li>
  82
  83         <li>
  84                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
  85         </li>
  86
  87         <li>
  88                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
  89         </li>
  90
  91         <li>
  92                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
  93         </li>
  94
  95         <li>
  96                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
  97         </li>
  98
  99         <li>
 100                 <a href="../modules/nixio.html">nixio</a>
 101         </li>
 102
 103         <li>
 104                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/nixio.File.html">nixio.File</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/nixio.README.html">nixio.README</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 149         </li>
 150
 151 </ul>
 152
 153
 154
 155 <!-- File list -->
 156
 157
 158
 159
 160
 161
 162
 163 </div><!-- id="navigation" -->
 164
 165 <div id="content">
 166
 167 <h1>Class <code>luci.http.protocol.date</code></h1>
 168
 169 <p></p>
 170
 171
 172
 173
 174
 175
 176
 177 <h2>Functions</h2>
 178 <table class="function_list">
 179
 180         <tr>
 181         <td class="name" nowrap><a href="#compare">compare</a>&nbsp;(d1, d2)</td>
 182         <td class="summary">
 183
 184 Compare two dates which can either be unix epoch times or HTTP date strings.</td>
 185         </tr>
 186
 187         <tr>
 188         <td class="name" nowrap><a href="#to_http">to_http</a>&nbsp;(time)</td>
 189         <td class="summary">
 190
 191 Convert the given unix epoch time to valid HTTP date string.</td>
 192         </tr>
 193
 194         <tr>
 195         <td class="name" nowrap><a href="#to_unix">to_unix</a>&nbsp;(data)</td>
 196         <td class="summary">
 197
 198 Parse given HTTP date string and convert it to unix epoch time.</td>
 199         </tr>
 200
 201         <tr>
 202         <td class="name" nowrap><a href="#tz_offset">tz_offset</a>&nbsp;(tz)</td>
 203         <td class="summary">
 204
 205 Return the time offset in seconds between the UTC and given time zone.</td>
 206         </tr>
 207
 208 </table>
 209
 210
 211
 212
 213
 214
 215 <br/>
 216 <br/>
 217
 218
 219 <h2><a name="functions"></a>Functions</h2>
 220 <dl class="function">
 221
 222
 223
 224 <dt><a name="compare"></a><strong>compare</strong>&nbsp;(d1, d2)</dt>
 225 <dd>
 226
 227
 228 Compare two dates which can either be unix epoch times or HTTP date strings.
 229
 230
 231
 232 <h3>Parameters</h3>
 233 <ul>
 234
 235         <li>
 236           d1: The first date or epoch time to compare
 237         </li>
 238
 239         <li>
 240           d2: The first date or epoch time to compare
 241         </li>
 242
 243 </ul>
 244
 245
 246
 247
 248
 249
 250 <h3>Return values:</h3>
 251 <ol>
 252
 253         <li>-1  -  if d1 is lower then d2
 254
 255         <li>0   -  if both dates are equal
 256
 257         <li>1   -  if d1 is higher then d2
 258
 259 </ol>
 260
 261
 262
 263 </dd>
 264
 265
 266
 267
 268 <dt><a name="to_http"></a><strong>to_http</strong>&nbsp;(time)</dt>
 269 <dd>
 270
 271
 272 Convert the given unix epoch time to valid HTTP date string.
 273
 274
 275
 276 <h3>Parameters</h3>
 277 <ul>
 278
 279         <li>
 280           time: Unix epoch time
 281         </li>
 282
 283 </ul>
 284
 285
 286
 287
 288
 289
 290 <h3>Return value:</h3>
 291 String containing the formatted date
 292
 293
 294
 295 </dd>
 296
 297
 298
 299
 300 <dt><a name="to_unix"></a><strong>to_unix</strong>&nbsp;(data)</dt>
 301 <dd>
 302
 303
 304 Parse given HTTP date string and convert it to unix epoch time.
 305
 306
 307
 308 <h3>Parameters</h3>
 309 <ul>
 310
 311         <li>
 312           data: String containing the date
 313         </li>
 314
 315 </ul>
 316
 317
 318
 319
 320
 321
 322 <h3>Return value:</h3>
 323 Unix epoch time
 324
 325
 326
 327 </dd>
 328
 329
 330
 331
 332 <dt><a name="tz_offset"></a><strong>tz_offset</strong>&nbsp;(tz)</dt>
 333 <dd>
 334
 335
 336 Return the time offset in seconds between the UTC and given time zone.
 337
 338
 339
 340 <h3>Parameters</h3>
 341 <ul>
 342
 343         <li>
 344           tz: Symbolic or numeric timezone specifier
 345         </li>
 346
 347 </ul>
 348
 349
 350
 351
 352
 353
 354 <h3>Return value:</h3>
 355 Time offset to UTC in seconds
 356
 357
 358
 359 </dd>
 360
 361
 362 </dl>
 363
 364
 365
 366
 367
 368 </div> <!-- id="content" -->
 369
 370 </div> <!-- id="main" -->
 371
 372 <div id="about">
 373         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
 374 </div> <!-- id="about" -->
 375
 376 </div> <!-- id="container" -->
 377 </body>
 378 </html>