luasocket: doc/http.html annotate

annotate doc/http.html @ 4:f0a27ccb1193 tip

Added ignore file

author	Eric Wing <ewing . public \|-at-\| gmail . com>
date	Sat, 30 Aug 2008 08:46:39 -0700
parents	4b915342e2a8
children

rev	line source
0 4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	2 "http://www.w3.org/TR/html4/strict.dtd">
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	3 <html>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	4
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	5 <head>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	6 <meta name="description" content="LuaSocket: HTTP support">
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	7 <meta name="keywords" content="Lua, HTTP, Library, WWW, Browser, Network, Support">
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	8 <title>LuaSocket: HTTP support</title>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	9 <link rel="stylesheet" href="reference.css" type="text/css">
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	10 </head>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	11
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	12 <body>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	13
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	14 <!-- header ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	15
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	16 <div class=header>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	17 <hr>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	18 <center>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	19 <table summary="LuaSocket logo">
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	20 <tr><td align=center><a href="http://www.lua.org">
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	21 <img width=128 height=128 border=0 alt="LuaSocket" src="luasocket.png">
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	22 </a></td></tr>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	23 <tr><td align=center valign=top>Network support for the Lua language
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	24 </td></tr>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	25 </table>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	26 <p class=bar>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	27 <a href="home.html">home</a> ·
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	28 <a href="home.html#download">download</a> ·
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	29 <a href="introduction.html">introduction</a> ·
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	30 <a href="introduction.html">introduction</a> ·
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	31 <a href="reference.html">reference</a>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	32 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	33 </center>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	34 <hr>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	35 </div>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	36
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	37 <!-- http +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	38
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	39 <h2 id=http>HTTP</h2>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	40
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	41 <p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	42 HTTP (Hyper Text Transfer Protocol) is the protocol used to exchange
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	43 information between web-browsers and servers. The <tt>http</tt>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	44 namespace offers full support for the client side of the HTTP
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	45 protocol (i.e.,
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	46 the facilities that would be used by a web-browser implementation). The
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	47 implementation conforms to the HTTP/1.1 standard,
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	48 <a href="http://www.cs.princeton.edu/~diego/rfc/rfc2616.txt">RFC
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	49 2616</a>.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	50 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	51
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	52 <p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	53 The module exports functions that provide HTTP functionality in different
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	54 levels of abstraction. From the simple
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	55 string oriented requests, through generic
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	56 <a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a> based, down to even lower-level if you bother to look through the source code.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	57 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	58
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	59 <p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	60 To obtain the <tt>http</tt> namespace, run:
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	61 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	62
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	63 <pre class=example>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	64 -- loads the HTTP module and any libraries it requires
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	65 local http = require("socket.http")
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	66 </pre>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	67
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	68 <p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	69 URLs must conform to
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	70 <a href="http://www.cs.princeton.edu/~diego/rfc/rfc1738.txt">RFC
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	71 1738</a>,
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	72 that is, an URL is a string in the form:
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	73 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	74
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	75 <blockquote>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	76 <pre>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	77 [http://][<user>[:<password>]@]<host>[:<port>][/<path>]
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	78 </pre>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	79 </blockquote>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	80
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	81 <p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	82 MIME headers are represented as a Lua table in the form:
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	83 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	84
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	85 <blockquote>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	86 <table summary="MIME headers in Lua table">
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	87 <tr><td><tt>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	88 headers = {<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	89   field-1-name = <i>field-1-value</i>,<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	90   field-2-name = <i>field-2-value</i>,<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	91   field-3-name = <i>field-3-value</i>,<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	92   ...<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	93   field-n-name = <i>field-n-value</i><br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	94 }
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	95 </tt></td></tr>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	96 </table>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	97 </blockquote>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	98
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	99 <p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	100 Field names are case insensitive (as specified by the standard) and all
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	101 functions work with lowercase field names.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	102 Field values are left unmodified.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	103 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	104
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	105 <p class=note>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	106 Note: MIME headers are independent of order. Therefore, there is no problem
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	107 in representing them in a Lua table.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	108 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	109
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	110 <p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	111 The following constants can be set to control the default behavior of
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	112 the HTTP module:
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	113 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	114
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	115 <ul>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	116 <li> <tt>PORT</tt>: default port used for connections;
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	117 <li> <tt>PROXY</tt>: default proxy used for connections;
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	118 <li> <tt>TIMEOUT</tt>: sets the timeout for all I/O operations;
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	119 <li> <tt>USERAGENT</tt>: default user agent reported to server.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	120 </ul>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	121
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	122 <!-- http.request ++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	123
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	124 <p class=name id=request>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	125 http.<b>request(</b>url [, body]<b>)</b><br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	126 http.<b>request{</b><br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	127   url = <i>string</i>,<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	128   [sink = <i>LTN12 sink</i>,]<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	129   [method = <i>string</i>,]<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	130   [headers = <i>header-table</i>,]<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	131   [source = <i>LTN12 source</i>],<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	132   [step = <i>LTN12 pump step</i>,]<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	133   [proxy = <i>string</i>,]<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	134   [redirect = <i>boolean</i>,]<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	135   [create = <i>function</i>]<br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	136 <b>}</b>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	137 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	138
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	139 <p class=description>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	140 The request function has two forms. The simple form downloads
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	141 a URL using the <tt>GET</tt> or <tt>POST</tt> method and is based
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	142 on strings. The generic form performs any HTTP method and is
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	143 <a href=http://lua-users.org/wiki/FiltersSourcesAndSinks>LTN12</a> based.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	144 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	145
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	146 <p class=parameters>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	147 If the first argument of the <tt>request</tt> function is a string, it
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	148 should be an <tt>url</tt>. In that case, if a <tt>body</tt>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	149 is provided as a string, the function will perform a <tt>POST</tt> method
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	150 in the <tt>url</tt>. Otherwise, it performs a <tt>GET</tt> in the
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	151 <tt>url</tt>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	152 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	153
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	154 <p class=parameters>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	155 If the first argument is instead a table, the most important fields are
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	156 the <tt>url</tt> and the <em>simple</em>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	157 <a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	158 <tt>sink</tt> that will receive the downloaded content.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	159 Any part of the <tt>url</tt> can be overridden by including
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	160 the appropriate field in the request table.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	161 If authentication information is provided, the function
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	162 uses the Basic Authentication Scheme (see <a href="#authentication">note</a>)
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	163 to retrieve the document. If <tt>sink</tt> is <tt><b>nil</b></tt>, the
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	164 function discards the downloaded data. The optional parameters are the
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	165 following:
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	166 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	167 <ul>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	168 <li><tt>method</tt>: The HTTP request method. Defaults to "GET";
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	169 <li><tt>headers</tt>: Any additional HTTP headers to send with the request;
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	170 <li><tt>source</tt>: <em>simple</em>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	171 <a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	172 source to provide the request body. If there
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	173 is a body, you need to provide an appropriate "<tt>content-length</tt>"
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	174 request header field, or the function will attempt to send the body as
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	175 "<tt>chunked</tt>" (something few servers support). Defaults to the empty source;
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	176 <li><tt>step</tt>:
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	177 <a href="http://lua-users.org/wiki/FiltersSourcesAndSinks">LTN12</a>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	178 pump step function used to move data.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	179 Defaults to the LTN12 <tt>pump.step</tt> function.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	180 <li><tt>proxy</tt>: The URL of a proxy server to use. Defaults to no proxy;
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	181 <li><tt>redirect</tt>: Set to <tt><b>false</b></tt> to prevent the
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	182 function from automatically following 301 or 302 server redirect messages;
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	183 <li><tt>create</tt>: An optional function to be used instead of
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	184 <a href=tcp.html#socket.tcp><tt>socket.tcp</tt></a> when the communications socket is created.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	185 </ul>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	186
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	187 <p class=return>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	188 In case of failure, the function returns <tt><b>nil</b></tt> followed by an
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	189 error message. If successful, the simple form returns the response
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	190 body as a string, followed by the response status code, the response
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	191 headers and the response status line. The generic function returns the same
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	192 information, except the first return value is just the number 1 (the body
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	193 goes to the <tt>sink</tt>).
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	194 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	195
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	196 <p class=return>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	197 Even when the server fails to provide the contents of the requested URL (URL not found, for example),
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	198 it usually returns a message body (a web page informing the
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	199 URL was not found or some other useless page). To make sure the
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	200 operation was successful, check the returned status <tt>code</tt>. For
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	201 a list of the possible values and their meanings, refer to <a
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	202 href="http://www.cs.princeton.edu/~diego/rfc/rfc2616.txt">RFC
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	203 2616</a>.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	204 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	205
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	206 <p class=description>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	207 Here are a few examples with the simple interface:
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	208 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	209
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	210 <pre class=example>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	211 -- load the http module
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	212 local io = require("io")
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	213 local http = require("socket.http")
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	214 local ltn12 = require("ltn12")
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	215
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	216 -- connect to server "www.cs.princeton.edu" and retrieves this manual
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	217 -- file from "~diego/professional/luasocket/http.html" and print it to stdout
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	218 http.request{
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	219 url = "http://www.cs.princeton.edu/~diego/professional/luasocket/http.html",
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	220 sink = ltn12.sink.file(io.stdout)
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	221 }
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	222
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	223 -- connect to server "www.example.com" and tries to retrieve
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	224 -- "/private/index.html". Fails because authentication is needed.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	225 b, c, h = http.request("http://www.example.com/private/index.html")
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	226 -- b returns some useless page telling about the denied access,
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	227 -- h returns authentication information
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	228 -- and c returns with value 401 (Authentication Required)
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	229
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	230 -- tries to connect to server "wrong.host" to retrieve "/"
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	231 -- and fails because the host does not exist.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	232 r, e = http.request("http://wrong.host/")
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	233 -- r is nil, and e returns with value "host not found"
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	234 </pre>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	235
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	236 <p class=description>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	237 And here is an example using the generic interface:
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	238 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	239
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	240 <pre class=example>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	241 -- load the http module
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	242 http = require("socket.http")
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	243
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	244 -- Requests information about a document, without downloading it.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	245 -- Useful, for example, if you want to display a download gauge and need
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	246 -- to know the size of the document in advance
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	247 r, c, h = http.request {
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	248 method = "HEAD",
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	249 url = "http://www.tecgraf.puc-rio.br/~diego"
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	250 }
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	251 -- r is 1, c is 200, and h would return the following headers:
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	252 -- h = {
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	253 -- date = "Tue, 18 Sep 2001 20:42:21 GMT",
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	254 -- server = "Apache/1.3.12 (Unix) (Red Hat/Linux)",
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	255 -- ["last-modified"] = "Wed, 05 Sep 2001 06:11:20 GMT",
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	256 -- ["content-length"] = 15652,
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	257 -- ["connection"] = "close",
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	258 -- ["content-Type"] = "text/html"
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	259 -- }
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	260 </pre>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	261
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	262 <p class=note id=post>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	263 Note: When sending a POST request, simple interface adds a
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	264 "<tt>Content-type: application/x-www-form-urlencoded</tt>"
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	265 header to the request. This is the type used by
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	266 HTML forms. If you need another type, use the generic
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	267 interface.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	268 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	269
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	270 <p class=note id=authentication>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	271 Note: Some URLs are protected by their
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	272 servers from anonymous download. For those URLs, the server must receive
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	273 some sort of authentication along with the request or it will deny
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	274 download and return status "401 Authentication Required".
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	275 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	276
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	277 <p class=note>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	278 The HTTP/1.1 standard defines two authentication methods: the Basic
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	279 Authentication Scheme and the Digest Authentication Scheme, both
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	280 explained in detail in
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	281 <a href="http://www.cs.princeton.edu/~diego/rfc/rfc2068.txt">RFC 2068</a>.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	282 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	283
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	284 <p class=note>The Basic Authentication Scheme sends
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	285 <tt><user></tt> and
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	286 <tt><password></tt> unencrypted to the server and is therefore
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	287 considered unsafe. Unfortunately, by the time of this implementation,
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	288 the wide majority of servers and browsers support the Basic Scheme only.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	289 Therefore, this is the method used by the toolkit whenever
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	290 authentication is required.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	291 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	292
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	293 <pre class=example>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	294 -- load required modules
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	295 http = require("socket.http")
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	296 mime = require("mime")
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	297
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	298 -- Connect to server "www.example.com" and tries to retrieve
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	299 -- "/private/index.html", using the provided name and password to
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	300 -- authenticate the request
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	301 b, c, h = http.request("http://fulano:silva@www.example.com/private/index.html")
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	302
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	303 -- Alternatively, one could fill the appropriate header and authenticate
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	304 -- the request directly.
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	305 r, c = http.request {
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	306 url = "http://www.example.com/private/index.html",
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	307 headers = { authentication = "Basic " .. (mime.b64("fulano:silva")) }
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	308 }
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	309 </pre>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	310
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	311 <!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	312
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	313 <div class=footer>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	314 <hr>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	315 <center>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	316 <p class=bar>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	317 <a href="home.html">home</a> ·
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	318 <a href="home.html#download">download</a> ·
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	319 <a href="installation.html">installation</a> ·
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	320 <a href="introduction.html">introduction</a> ·
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	321 <a href="reference.html">reference</a>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	322 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	323 <p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	324 <small>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	325 Last modified by Diego Nehab on <br>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	326 Thu Apr 20 00:25:26 EDT 2006
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	327 </small>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	328 </p>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	329 </center>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	330 </div>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	331
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	332 </body>
4b915342e2a8 LuaSocket 2.0.2 + CMake build description. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	333 </html>

Mercurial > luasocket

annotate doc/http.html @ 4:f0a27ccb1193 tip