Difference between revisions of "HTTP (API)"

From ComputerCraft Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
:{|class="wikitable"
 +
| '''The HTTP API must be enabled in mod_ComputerCraft.cfg before being used. To enable it open .minecraft/config/mod_ComputerCraft.cfg and change enableAPI_http=0 to enableAPI_http=1.'''
 +
|}
 
The HTTP API allows interfacing with websites and downloading from them.
 
The HTTP API allows interfacing with websites and downloading from them.
  
Methods provided by the HTTP API:
+
=Methods=
 
+
{| border="1" cellpadding="2" cellspacing="0"
* http.request( url ) OR http.request { header_table }
+
!style="background:#EEE" width="200px"|Method name
* http.get( url )
+
!style="background:#EEE" width="*"|Description
* http.post( url, data ) OR http.post { header_table }
+
|-
 
+
| [[http.request]]( url )<br />
The HTTP API must be enabled in mod_ComputerCraft.cfg before being used. To enable it open .minecraft/config/mod_ComputerCraft.cfg and change enableAPI_http=0 to enableAPI_http=1.
+
[[http.request]] { header_table }
 +
|
 +
|-
 +
| [[http.get]]( url )
 +
|
 +
|-
 +
| [[http.post]]( url, data )<br />
 +
[[http.post]] { header_table }
 +
|
 +
|}
  
 
A period of time after a http.request() call is made, a "http_success" or "http_failure" event will be raised to os.pullEvent(). Arguments are the URL and a file handle if successful. http.get() blocks until this event is fired.
 
A period of time after a http.request() call is made, a "http_success" or "http_failure" event will be raised to os.pullEvent(). Arguments are the URL and a file handle if successful. http.get() blocks until this event is fired.

Revision as of 14:48, 29 May 2012

The HTTP API must be enabled in mod_ComputerCraft.cfg before being used. To enable it open .minecraft/config/mod_ComputerCraft.cfg and change enableAPI_http=0 to enableAPI_http=1.

The HTTP API allows interfacing with websites and downloading from them.

Methods

Method name Description
http.request( url )

http.request { header_table }

http.get( url )
http.post( url, data )

http.post { header_table }

A period of time after a http.request() call is made, a "http_success" or "http_failure" event will be raised to os.pullEvent(). Arguments are the URL and a file handle if successful. http.get() blocks until this event is fired.

header_table format

(Source: http://w3.impa.br/~diego/software/luasocket/old/luasocket-2.0-alpha/http.html ) Note the {} braces.

http.get{
  url = string,
  headers = header-table,
  user = string,
  password = string,
  stay = bool,
}
http.post{
   url = string,
   headers = header-table,
   body = string,
   user = string,
   password = string,
   stay = bool,
}
http.request{
  method = string,
  url = string,
  headers = header-table,
  body = string,
  user = string,
  password = string,
  stay = string,
}