This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
component:internet [2015/06/16 19:20] gamax92 Update documentation |
component:internet [2015/06/16 20:37] gamax92 Add documentation about TCP object and HTTP object |
||
---|---|---|---|
Line 3: | Line 3: | ||
This component is provided by the [[item:internet_card|Internet Card]] | This component is provided by the [[item:internet_card|Internet Card]] | ||
- | Component name: `internet`. | + | Component name: `internet`. |
Callbacks: | Callbacks: | ||
Line 13: | Line 13: | ||
Opens a new TCP connection. Returns the handle of the connection. | Opens a new TCP connection. Returns the handle of the connection. | ||
- `request(url:string[, postData:string]):userdata` | - `request(url:string[, postData:string]):userdata` | ||
- | Starts an HTTP request. If this returns true, further results will be pushed using `http_response` signals. | + | Sends a new HTTP request. Returns the handle of the connection. |
+ | |||
+ | ==== TCP Socket Object ==== | ||
+ | |||
+ | - `read([n:number]):string` | ||
+ | Tries to read data from the socket stream. Returns the read byte array. | ||
+ | - `close()` | ||
+ | Closes an open socket stream. | ||
+ | - `write(data:string):number` | ||
+ | Tries to write data to the socket stream. Returns the number of bytes written. | ||
+ | - `finishConnect():boolean` | ||
+ | Ensures a socket is connected. Errors if the connection failed. | ||
+ | |||
+ | ==== HTTP Request Object ==== | ||
+ | |||
+ | - `read([n:number]):string` | ||
+ | Tries to read data from the response. Returns the read byte array. | ||
+ | - `response():number, string, table` | ||
+ | Get response code, message and headers. | ||
+ | - `close()` | ||
+ | Closes an open socket stream. | ||
+ | - `finishConnect():boolean` | ||
+ | Ensures a response is available. Errors if the connection failed. | ||
---- | ---- | ||
{{page>component:contents&noheader&noeditbutton&nouser&nofooter}} | {{page>component:contents&noheader&noeditbutton&nouser&nofooter}} |