Function cgiGet() - Revision history

Bbakala: /* Parameters */

2020-08-13T19:09:15Z

‎Parameters

Bbakala: /* Usage */

2019-09-02T15:50:37Z

‎Usage

Phrych at 11:54, 11 July 2019

2019-07-11T11:54:28Z

Phrych: /* Usage */

2018-02-01T10:24:26Z

‎Usage

Jturon at 17:23, 5 May 2017

2017-05-05T17:23:49Z

Jturon at 21:13, 19 April 2017

2017-04-19T21:13:28Z

Jturon at 21:03, 19 April 2017

2017-04-19T21:03:48Z

Jturon at 18:46, 18 April 2017

2017-04-18T18:46:23Z

Jturon at 12:13, 18 April 2017

2017-04-18T12:13:26Z

Jturon: /* Usage */

2017-04-18T12:13:06Z

‎Usage

@@ Line 5: / Line 5: @@
 === Parameters ===
-  <i>table</i> config{<code>url</code>, <code>callback</code>, <code style="color: #777">timeout</code>, <code style="color: #777">bufferSize</code>}
+  <i>table</i> config{<code>url</code>, <code>callback</code>, <code style="color: #777">timeout</code>, <code style="color: #777">bufferSize</code>, <code style="color: #777">sslVerifyPeer=false</code>}
 * <i>string</i> <code>url</code> address to call
 * <i>function{response}</i> <code>callback</code> this function is called when response arrives
 * optional <i>number</i> <code>timeout</code> maximum seconds to wait for response (default 30)
 * optional <i>number</i> <code>bufferSize</code> bytes of memory to allocate for response (min. 4k, max 1M)
 === Callback Parameters ===

@@ Line 37: / Line 37: @@
   -- send HTTP request and handle response
-  cgiGet{url="http://httpbin.org/ip", timeout=2, callback=logOurIp}
+  cgiGet{url="http://httpbin.org/ip", callback=logOurIp, timeout=2}
 === Requirements ===

@@ Line 2: / Line 2: @@
 Execute HTTP GET call to given url and read the response. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called. To perform simple HTTP GET call without response handling, use simpler [[Devices.system.CustomCGI()|devices.system.CustomCGI()]]
-  <i>nil</i> <b>devices.system.cgiGet</b>(<i>table</i> <code>config</code>)
+  <i>nil</i> <b>cgiGet</b>(<i>table</i> <code>config</code>)
 === Parameters ===
@@ Line 28: / Line 28: @@
 === Usage ===
-  -- callback function to read the response
+  function logOurIp(o)
- local function getResponse(response)
+    if o.result == 0 then
-    if response.result > 0 then
+      log(string.format("our ip is %s", string.match(o.buffer,"(%d+.%d+.%d+.%d+)")))
     else
-     logf("current credit is %d", tonumber(response.buffer))
+      log(string.format("cgi to get our ip failed with error %d: %s", o.result, o.errorInfo))
     end
   end
-  -- sends HTTP request and handles the response
+  -- send HTTP request and handle response
-  devices.system.CgiGet{url="http://example.com/getcredit?id=42", callback=getResponse}
+  cgiGet{url="http://httpbin.org/ip", timeout=2, callback=logOurIp}
 === Requirements ===

@@ Line 29: / Line 29: @@
 === Usage ===
   -- callback function to read the response
-  local function getResponse{response}
+  local function getResponse(response)
     if response.result > 0 then
       logf("response failed with error code %d.", response.result)
@@ Line 38: / Line 38: @@
   -- sends HTTP request and handles the response
-  devices.system.CgiGet{url="http://example.com/getcredit?id=42",getResponse}
+  devices.system.CgiGet{url="http://example.com/getcredit?id=42", callback=getResponse}
 === Requirements ===

@@ Line 2: / Line 2: @@
 Execute HTTP GET call to given url and read the response. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called. To perform simple HTTP GET call without response handling, use simpler [[Devices.system.CustomCGI()|devices.system.CustomCGI()]]
-  <i>nil</i> <b>devices.system.cgiGet</b>{<code>config</code>}
+  <i>nil</i> <b>devices.system.cgiGet</b>(<i>table</i> <code>config</code>)
 === Parameters ===

@@ Line 2: / Line 2: @@
 Execute HTTP GET call to given url and read the response. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called. To perform simple HTTP GET call without response handling, use simpler [[Devices.system.CustomCGI()|devices.system.CustomCGI()]]
-  <i>nil</i> devices.system.cgiGet{<u>config</u>}
+  <i>nil</i> <b>devices.system.cgiGet</b>{<code>config</code>}
 === Parameters ===
-  <i>table</i> <u>config</u>
+  <i>table</i> <tt>config</tt>
-* <i>string</i> <u>url</u> address to call
+* <i>string</i> <code>url</code> address to call
-* <i>function{response}</i> <u>callback</u> this function is called when response arrives
+* <i>function{response}</i> <code>callback</code> this function is called when response arrives
-* optional <i>number</i> <u>timeout</u> maximum seconds to wait for response (default 30)
+* optional <i>number</i> <code>timeout</code> maximum seconds to wait for response (default 30)
-* optional <i>number</i> <u>bufferSize</u> bytes of memory to allocate for response (min. 4k, max 1M)
+* optional <i>number</i> <code>bufferSize</code> bytes of memory to allocate for response (min. 4k, max 1M)
 === Callback Parameters ===
-  <i>table</i> <u>response</u>
+  <i>table</i> <tt>response</tt>
-* <i>number</i> <u>result</u> error code of the response (see below)
+* <i>number</i> <code>result</code> error code of the response (see below)
-* <i>string</i> <u>errInfo</u> error description (if result>0)
+* <i>string</i> <code>errInfo</code> error description (if result>0)
-* <i>number</i> <u>received</u> response length
+* <i>number</i> <code>received</code> response length
-* <i>string</i> <u>buffer</u> response body
+* <i>string</i> <code>buffer</code> response body
 === Error Code of the response ===

← Older revision		Revision as of 12:13, 18 April 2017
Line 1:		Line 1:
−	{{DISPLAYTITLE:function ~~devices.system.~~cgiGet()}}	+	{{DISPLAYTITLE:function cgiGet()}}
	Execute HTTP GET call to given url and read the response. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called. To perform simple HTTP GET call without response handling, use simpler [[Devices.system.CustomCGI()\|devices.system.CustomCGI()]]		Execute HTTP GET call to given url and read the response. The call is asynchronous: the code execution proceeds immediately and when the response arrives, callback function is called. To perform simple HTTP GET call without response handling, use simpler [[Devices.system.CustomCGI()\|devices.system.CustomCGI()]]