Http.request - Revision history

MKlegoman357: Cleaned up the example, added a warning

2014-06-06T08:51:31Z

Cleaned up the example, added a warning

Shazz at 19:54, 20 April 2014

2014-04-20T19:54:06Z

Ds84182 at 19:55, 4 January 2014

2014-01-04T19:55:30Z

Ds84182 at 19:53, 4 January 2014

2014-01-04T19:53:50Z

Hawk777: Document asynchrony

2013-05-05T23:10:50Z

Document asynchrony

Hawk777: Document parameters, clarify description, remove return value (it DOES NOT return a value!), and remove excessive line breaks in example

2013-05-05T23:09:51Z

Document parameters, clarify description, remove return value (it DOES NOT return a value!), and remove excessive line breaks in example

AfterLifeLochie: Updated API reference

2012-11-30T13:57:21Z

Updated API reference

AfterLifeLochie: Moved to CAT:LuaCoreFunctions

2012-11-28T18:49:43Z

Moved to CAT:LuaCoreFunctions

82.95.113.83: Changed the example, because otherwise it'll stop on any event, which will cause a keypress or redstone update to stop it.

2012-10-24T10:20:17Z

Changed the example, because otherwise it'll stop on any event, which will cause a keypress or redstone update to stop it.

Thesbros: Add local variables

2012-09-17T03:32:26Z

Add local variables

@@ Line 2: / Line 2: @@
 {{Function
 |name=http.request
 |args={{type|string}} url [, {{type|string}} postData [, {{type|table}} headers]]
 |api=HTTP
 |addon=ComputerCraft
-|desc=Sends a HTTP request to a website, asynchronously. Returns immediately, with an [[Http success (event)|http_success]] or [[Http failure (event)|http_failure]] event being delivered later to indicate the outcome. Issues a POST request if ''postData'' is provided, or a GET request if it is [[nil]] (or omitted).
+|desc=Sends a HTTP request to a website, asynchronously. Returns immediately, with an [[Http success (event)|http_success]] or [[Http failure (event)|http_failure]] event being delivered later to indicate the outcome. Issues a POST request if ''postData'' is provided, or a GET request if it is [[nil]] (or omitted). <var>headers</var> '''must''' come as a third argument, if you need to make a GET request using custom headers just pass [[nil]] as the second argument.
 |examples=
 {{Example
-|desc=Prints "If you see this message, HTTP works!" if successful.
+|desc=Prints the contents of ''example.com''.
-|code=http.request("http://pastebin.com/raw.php?i=itK2bx9K")
+|code='''http.request("http://example.com")'''
-  local requesting = true
-  while requesting do
+ local requesting = true
-    local event, url, sourceText = os.pullEvent()
-    if event == "http_success" then
+ while requesting do
-      local respondedText = sourceText.readAll()
+   local event, url, sourceText = [[os.pullEvent]]()
-      print(respondedText)
-      requesting = false
+   if event == "http_success" then
-    elseif event == "http_failure" then
+     local respondedText = sourceText.readAll()
-      print("Server didn't respond.")
-      requesting = false
+     sourceText.close()
-    end
+     print(respondedText)
-  end
 }}
 }}
 [[Category:Lua_Core_Functions]]

@@ Line 2: / Line 2: @@
 {{Function
 |name=http.request
-|args={{type|string}} url<nowiki>[</nowiki>, {{type|string}} postData]
+|args={{type|string}} url [, {{type|string}} postData [, {{type|table}} headers]]
 |api=HTTP
 |addon=ComputerCraft

@@ Line 8: / Line 8: @@
 |examples=
 {{Example
-|desc=Prints the code of a loading bar program if successful.
+|desc=Prints "If you see this message, HTTP works!" if successful.
 |code=http.request("http://pastebin.com/raw.php?i=itK2bx9K")
    local requesting = true

@@ Line 9: / Line 9: @@
 {{Example
 |desc=Prints the code of a loading bar program if successful.
-|code=http.request("http://pastebin.com/raw.php?i=Tk19jv43")
+|code=http.request("http://pastebin.com/raw.php?i=itK2bx9K")
    local requesting = true
    while requesting do

@@ Line 5: / Line 5: @@
 |api=HTTP
 |addon=ComputerCraft
-|desc=Sends a HTTP request to a website. Returns immediately, with an [[Http success (event)|http_success]] or [[Http failure (event)|http_failure]] event being delivered later to indicate the outcome. Issues a POST request if ''postData'' is provided, or a GET request if it is [[nil]] (or omitted).
+|desc=Sends a HTTP request to a website, asynchronously. Returns immediately, with an [[Http success (event)|http_success]] or [[Http failure (event)|http_failure]] event being delivered later to indicate the outcome. Issues a POST request if ''postData'' is provided, or a GET request if it is [[nil]] (or omitted).
 |examples=
 {{Example

@@ Line 3: / Line 3: @@
 |name=http.request
 |returns=event "http_success" on success.
-|api=http
+|api=HTTP
 |addon=ComputerCraft
 |desc=Sends a HTTP request to the website. Returns event "http_success" on success.

← Older revision		Revision as of 18:49, 28 November 2012
Line 24:		Line 24:
	}}		}}
	}}		}}
		+
		+	[[Category:Lua_Core_Functions]]

@@ Line 17: / Line 17: @@
        print(respondedText)<br />
        requesting = false<br />
-     else<br />
+     elseif event == "http_failure" then<br />
        print("Server didn't respond.")<br />
        requesting = false<br />

@@ Line 10: / Line 10: @@
 |desc=Prints the code of a loading bar program if successful.
 |code=http.request("http://pastebin.com/raw.php?i=Tk19jv43")<br />
-   requesting = true<br />
+   local requesting = true<br />
    while requesting do<br />
      local event, url, sourceText = os.pullEvent()<br />
      if event == "http_success" then<br />
-       respondedText = sourceText.readAll()<br />
+       local respondedText = sourceText.readAll()<br />
        print(respondedText)<br />
        requesting = false<br />