From d80dd2291ff01d264dfa802b769fa19756f07821 Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Tue, 5 Nov 2019 09:31:27 +0100 Subject: documentation: update Lua API docs Signed-off-by: Jo-Philipp Wich (cherry picked from commit 2ae6e3c6b3c3b65cd955bb10fb9065beebc5ffd2) --- .../modules/luci.http.protocol.conditionals.html | 556 --------------------- 1 file changed, 556 deletions(-) delete mode 100644 documentation/api/modules/luci.http.protocol.conditionals.html (limited to 'documentation/api/modules/luci.http.protocol.conditionals.html') diff --git a/documentation/api/modules/luci.http.protocol.conditionals.html b/documentation/api/modules/luci.http.protocol.conditionals.html deleted file mode 100644 index 9728815402..0000000000 --- a/documentation/api/modules/luci.http.protocol.conditionals.html +++ /dev/null @@ -1,556 +0,0 @@ - - - - Reference - - - - - -
- -
- -
-
-
- -
- - - -
- -

Class luci.http.protocol.conditionals

- -

- - - - - - - -

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
if_match (req, stat) - -14.24 / If-Match - -Test whether the given message object contains an "If-Match" header and -compare it against the given stat object.
if_modified_since (req, stat) - -14.25 / If-Modified-Since - -Test whether the given message object contains an "If-Modified-Since" header -and compare it against the given stat object.
if_none_match (req, stat) - -14.26 / If-None-Match - -Test whether the given message object contains an "If-None-Match" header and -compare it against the given stat object.
if_range (req, stat) - -14.27 / If-Range - -The If-Range header is currently not implemented due to the lack of general -byte range stuff in luci.http.protocol .
if_unmodified_since (req, stat) - -14.28 / If-Unmodified-Since - -Test whether the given message object contains an "If-Unmodified-Since" -header and compare it against the given stat object.
mk_etag (stat) - -Implement 14.19 / ETag.
- - - - - - -
-
- - -

Functions

-
- - - -
if_match (req, stat)
-
- - -14.24 / If-Match - -Test whether the given message object contains an "If-Match" header and -compare it against the given stat object. - - -

Parameters

-
    - -
  • - req: HTTP request message object -
    • - -
  • - stat: A file.stat object -
    • - -
- - - - - - -

Return values:

-
    - -
  1. Boolean indicating whether the precondition is ok - -
  2. Alternative status code if the precondition failed - -
- - - -
- - - - -
if_modified_since (req, stat)
-
- - -14.25 / If-Modified-Since - -Test whether the given message object contains an "If-Modified-Since" header -and compare it against the given stat object. - - -

Parameters

-
    - -
  • - req: HTTP request message object -
    • - -
  • - stat: A file.stat object -
    • - -
- - - - - - -

Return values:

-
    - -
  1. Boolean indicating whether the precondition is ok - -
  2. Alternative status code if the precondition failed - -
  3. Table containing extra HTTP headers if the precondition failed - -
- - - -
- - - - -
if_none_match (req, stat)
-
- - -14.26 / If-None-Match - -Test whether the given message object contains an "If-None-Match" header and -compare it against the given stat object. - - -

Parameters

-
    - -
  • - req: HTTP request message object -
    • - -
  • - stat: A file.stat object -
    • - -
- - - - - - -

Return values:

-
    - -
  1. Boolean indicating whether the precondition is ok - -
  2. Alternative status code if the precondition failed - -
  3. Table containing extra HTTP headers if the precondition failed - -
- - - -
- - - - -
if_range (req, stat)
-
- - -14.27 / If-Range - -The If-Range header is currently not implemented due to the lack of general -byte range stuff in luci.http.protocol . This function will always return -false, 412 to indicate a failed precondition. - - -

Parameters

-
    - -
  • - req: HTTP request message object -
    • - -
  • - stat: A file.stat object -
    • - -
- - - - - - -

Return values:

-
    - -
  1. Boolean indicating whether the precondition is ok - -
  2. Alternative status code if the precondition failed - -
- - - -
- - - - -
if_unmodified_since (req, stat)
-
- - -14.28 / If-Unmodified-Since - -Test whether the given message object contains an "If-Unmodified-Since" -header and compare it against the given stat object. - - -

Parameters

-
    - -
  • - req: HTTP request message object -
    • - -
  • - stat: A file.stat object -
    • - -
- - - - - - -

Return values:

-
    - -
  1. Boolean indicating whether the precondition is ok - -
  2. Alternative status code if the precondition failed - -
- - - -
- - - - -
mk_etag (stat)
-
- - -Implement 14.19 / ETag. - - - -

Parameters

-
    - -
  • - stat: A file.stat structure -
    • - -
- - - - - - -

Return value:

-String containing the generated tag suitable for ETag headers - - - -
- - -
- - - - - -
- -
- -
-

Valid XHTML 1.0!

-
- -
- - -- cgit v1.2.3