Differences

This shows you the differences between two versions of the page.

--- api:internet [2014/07/07 10:51]
vexatos created
+++ api:internet [2019/11/29 23:06] (current)
jab [Internet API]
@@ Line 3: / Line 3: @@
 This library wraps functionality of Internet cards. Also see the [[component:internet|Internet Component]] for more low level functionality (such as querying availability of HTTP and TCP functionality).
-- `internet.request(url: string[, data: string or table]): function`
+- `internet.request(url: string[, data: string or table[, headers: table[, method: string]]]): function`
-  Sends an HTTP request to the specified URL, with the specified POST data, if any. If no data is specified, a GET request will be made. The POST data can be in one of two formats: if it's a string, it will be sent as-is. If it's a table, it will be converted to a string by assuming that each key is the name of a POST variable, and it's associated value is the value for that variable. So, for example:
+  Sends an HTTP request to the specified URL, with the specified POST data, if any. If no data is specified, a GET request will be made. The POST data can be in one of two formats: if it's a string, it will be sent as-is. If it's a table, it will be converted to a string by assuming that each key is the name of a POST variable, and it's associated value is the value for that variable. **method** can be explicitly specified to values such as GET, POST, or PUT. Some examples:
   `internet.request(url, {some = "variable", another = 1})`
   Will send `some=variable&another=1`.
-  The returned function is an iterator over the lines of the result, use it like so:
+  The returned function is an iterator over chunks of the result, use it like so:
-  `for line in internet.request(...) do stuff() end`
+  `for chunk in internet.request(...) do stuff() end`
-  **Important**: you should not call `os.sleep`, `event.pull` or any other functions that directly or indirectly consume signals while iterating the result lines, since the lines of the response are one signal each (to avoid running out of memory for large results).
+  Note that **this method ALSO support HTTPS**. So simply use
+  `internet.request("https://example.com")` to send a request through HTTPS.
+  Example specifying PUT:
+  `internet.request("https://example.com", "put data", {}, "PUT")`.
 - `internet.socket(address:string[, port:number]):table`
   Opens a TCP socket using an internet component's `connect` method and wraps it in a table that provides the same methods as a file opened using `filesystem.open`: `read`, `write` and `close` (and `seek`, which will always fail). It is recommended to use `internet.open` instead, which will wrap the opened socket in a [[api:buffer|buffer]], the same way `io.open` wraps files.
+  The read method on the returned socket is *non-blocking*. Read will instantly return, but may return an empty string if there is nothing to read. Write *may* block until all data has been successfully written. It'll *usually* return immediately, though.
 - `internet.open(address:string[, port:number]):table`
-  Opens a buffered socket stream to the specified address. The stream can be read from and written from, using `s:read` and `s:write` - in general it can be treated much like files opened using `io.open`. It may often be desirable to set the buffer's read timeout using `s:setTimeout(seconds)`, to avoid it blocking indefinitely. Example usage:
+  Opens a buffered socket stream to the specified address. The stream can be read from and written from, using `s:read` and `s:write` - in general it can be treated much like files opened using `io.open`. It may often be desirable to set the buffer's read timeout using `s:setTimeout(seconds)`, to avoid it blocking indefinitely.
+  The read method on the returned buffer is *blocking*. Read will wait until some data is available to be read and return that.
+  Example usage:
 ```lua
+local internet = require("internet")
+local handle = internet.open("example.com", 1337)
+local data = handle:read(10)
+handle:write("1234")
+handle:close()
+```
+If you need the HTTP response code, message, and headers, they are retrieved from the internal object, which is stored in the metatable of the returned object.
+```lua
+-- https://github.com/kikito/inspect.lua/blob/master/inspect.lua
+local inspect = require("inspect")
 local internet = require("internet")
-local handle = internet.open("example.com", 1337)
-local data = handle:read(10)
+local handle = internet.request("https://www.google.com")
-handle:write("1234")
+local result = ""
-handle:close()
+for chunk in handle do result = result..chunk end
+-- Print the body of the HTTP response
+-- print(result)
+-- Grab the metatable for the handle. This contains the
+-- internal HTTPRequest object.
+local mt = getmetatable(handle)
+-- The response method grabs the information for
+-- the HTTP response code, the response message, and the
+-- response headers.
+local code, message, headers = mt.__index.response()
+print("code = "..tostring(code))
+print("message = "..tostring(message))
+print(inspect(headers))
 ```
 This is an example of a basic IRC bot that echos back what you say to it, using the sockets in the internet api.
@@ Line 65: / Line 97: @@
 ```
-For a more advanced example, check out the IRC Client program available in the latest release of OpenComputers: [irc.lua](https://github.com/MightyPirates/OpenComputers/blob/master/src/main/resources/assets/opencomputers/loot/OpenIRC/irc.lua)
+For a more advanced example, check out the IRC Client program available in the latest release of OpenComputers: [irc.lua](https://github.com/MightyPirates/OpenComputers/blob/master-MC1.7.10/src/main/resources/assets/opencomputers/loot/irc/usr/bin/irc.lua)
 Contents
 -----------
 {{page>api:contents&noheader&noeditbutton&nouser&nofooter}}