Network Functions

Overview

Network module functions handle HTTP requests
The network module uses the http prefix, e.g. http.downloadFile()

http.request Universal Request Function

Universal HTTP request
@param param map parameter with the following fields:
url: string, request URL
timeout: integer milliseconds, timeout duration
method: string — POST, GET, or PUT
proxy: proxy address as a map with host and port, e.g. {"host":"11","port":111}
followRedirects: whether to follow redirects — true or false
requestBody: request body; use a JSON string for JSON payloads
userAgent: string, HTTP User-Agent
ignoreContentType: whether to ignore content type — true or false
ignoreHttpErrors: whether to ignore HTTP errors — true or false
maxBodySize: integer, maximum HTTP body size
referrer: string, request referrer
header: HTTP request headers as a map, e.g. {"UA":"test"}
cookie: HTTP request cookies as a map, e.g. {"a":1}
data: HTTP POST data as a map, e.g. {"a":1}
file: files to upload as a collection, e.g.
[{"key":"a1","fileName":"a.txt","filePath":"D:/"},{"key":"a1","fileName":"a.jpg","filePath":"D:/","contentType":"image/jpg"}]

contentType is optional
- responseCharset: string, force response content charset

@return Response object or null

1
function main() {
2
 http_request();
3
}
4

5
function http_request() {
6
 //url:string
7
 //timeout:int ms
8
 //method: post ,get
9
 //proxy: {"host":"11","port":111}
10
 //followRedirects:true false
11
 //requestBody: string
12
 //userAgent:string
13
 //ignoreContentType:true false
14
 //ignoreHttpErrors:true false
15
 //maxBodySize : int
16
 //referrer:string
17
 //header:{"UA":"test"}
18
 //cookie:{"a":1}
19
 //data:{"a":1}
20
 //file:[{}]
21
 //responseCharset: string
22
 let md = utils.dataMd5("12345");
23
 let md2 = utils.fileMd5("D:/sb.png");
24
 let url = "http://192.168.0.5:8081/api/request";
25
 let proxy = {"host": "192.168.0.5", "port": "100"};
26
 let userAgent = "xxx";
27
 let followRedirects = false;
28
 let requestBody = JSON.stringify({"A": 111});
29
 let ignoreContentType = true;
30
 let ignoreHttpErrors = true;
31
 let referrer = "xxx";
32
 let header = {
33
 "Content-Type": " application/json; charset=UTF-8",
34
 "User-Agent": "from test",
35
 "ddd": md,
36
 "dd2": md2,
37
 "imei": device.getDeviceId()
38
 };
39
 let cookie = {
40
 "cookie1": "tst1",
41
 "cookie2": "tst2"
42
 };
43
 let data = {
44
 "a1": "aaa",
45
 "pwd2": md,
46
 "md2": md2
47
 };
48
 let file = [
49
 {
50
 "key": "file",
51
 "fileName": "f.png",
52
 "filePath": "D:/sb.png"
53
 },
54
 {
55
 "key": "file",
56
 "fileName": "f2.png",
57
 "filePath": "D:/sde.png",
58
 "contentType": "image/png"
59
 }
60
 ];
61
 let params = {
62
 "url": url,
63
 "method": "POST",
64
 "userAgent": userAgent,
65
 "referrer": "baidu.com",
66
 "cookie": cookie,
67
 "data": data,
68
 "file": file
69
 };
70
 let x = http.request(params);
71
 if (x) {
72
 logd("header=> " + JSON.stringify(x.header));
73
 logd("cookie=> " + JSON.stringify(x.cookie));
74
 logd("statusCode=> " + x.statusCode);
75
 logd("statusMessage=> " + x.statusMessage);
76
 logd("charset=> " + x.charset);
77
 logd("contentType=> " + x.contentType);
78
 logd("body=> " + x.body);
79
 } else {
80
 loge("No result");
81
 }
82
}
83

84
main();

http.requestEx Universal Request Function (Extended)

Universal HTTP request
@param param map parameter with the following fields:
url: string, request URL
timeout: integer milliseconds, timeout duration
method: string — POST, GET, or PUT
proxy: proxy address as a map with host and port, e.g. {"host":"11","port":111}
followRedirects: whether to follow redirects — true or false
requestBody: request body; use a JSON string for JSON payloads
userAgent: string, HTTP User-Agent
ignoreContentType: whether to ignore content type — true or false
ignoreHttpErrors: whether to ignore HTTP errors — true or false
maxBodySize: integer, maximum HTTP body size
referrer: string, request referrer
header: HTTP request headers as a map, e.g. {"UA":"test"}
cookie: HTTP request cookies as a map, e.g. {"a":1}
data: HTTP POST data as a map, e.g. {"a":1}
file: files to upload as a collection, e.g.
[{"key":"a1","fileName":"a.txt","filePath":"D:/"},{"key":"a1","fileName":"a.jpg","filePath":"D:/","contentType":"image/jpg"}]

contentType is optional
- responseCharset: string, force response content charset

@return Response object or null

1
function main() {
2
 http_request();
3
}
4

5
function http_request() {
6
 //url:string
7
 //timeout:int ms
8
 //method: post ,get
9
 //proxy: {"host":"11","port":111}
10
 //followRedirects:true false
11
 //requestBody: string
12
 //userAgent:string
13
 //ignoreContentType:true false
14
 //ignoreHttpErrors:true false
15
 //maxBodySize : int
16
 //referrer:string
17
 //header:{"UA":"test"}
18
 //cookie:{"a":1}
19
 //data:{"a":1}
20
 //file:[{}]
21
 //responseCharset: string
22
 let md = utils.dataMd5("12345");
23
 let md2 = utils.fileMd5("D:/sb.png");
24
 let url = "http://192.168.0.5:8081/api/request";
25
 let proxy = {"host": "192.168.0.5", "port": "100"};
26
 let userAgent = "xxx";
27
 let followRedirects = false;
28
 let requestBody = JSON.stringify({"A": 111});
29
 let ignoreContentType = true;
30
 let ignoreHttpErrors = true;
31
 let referrer = "xxx";
32
 let header = {
33
 "Content-Type": " application/json; charset=UTF-8",
34
 "User-Agent": "from test",
35
 "ddd": md,
36
 "dd2": md2,
37
 "imei": device.getDeviceId()
38
 };
39
 let cookie = {
40
 "cookie1": "tst1",
41
 "cookie2": "tst2"
42
 };
43
 let data = {
44
 "a1": "aaa",
45
 "pwd2": md,
46
 "md2": md2
47
 };
48
 let file = [
49
 {
50
 "key": "file",
51
 "fileName": "f.png",
52
 "filePath": "D:/sb.png"
53
 },
54
 {
55
 "key": "file",
56
 "fileName": "f2.png",
57
 "filePath": "D:/sde.png",
58
 "contentType": "image/png"
59
 }
60
 ];
61
 let params = {
62
 "url": url,
63
 "method": "POST",
64
 "userAgent": userAgent,
65
 "referrer": "baidu.com",
66
 "cookie": cookie,
67
 "data": data,
68
 "file": file
69
 };
70
 let x = http.requestEx(params);
71
 if (x) {
72
 logd("header=> " + x.header);
73
 // Direct access
74
 logd("header=> " + x.header["Location"]);
75
 for (let d in x.header) {
76
 logd("header key " + d + " " + x.header[d]);
77
 }
78
 logd("cookie=> " + x.cookie);
79
 for (let d in x.cookie) {
80
 logd("cookie key " + d + " " + x.cookie[d]);
81
 }
82
 logd("cookie=> " + x.cookie["aa"]);
83
 logd("statusCode=> " + x.statusCode);
84
 logd("statusMessage=> " + x.statusMessage);
85
 logd("charset=> " + x.charset);
86
 logd("contentType=> " + x.contentType);
87
 logd("body=> " + x.body);
88
 } else {
89
 loge("No result");
90
 }
91
}
92

93
main();

http.downloadFile Download File

Download a remote file locally; supports resumable downloads
@param remoteUrl remote file URL
@param file local file path to save to
@param timeout download timeout in milliseconds
@param headers header map, e.g.{"a":"11"}
@return true on success, false on failure

1
function main() {
2
 let url = "https://imtt.dd.qq.com/16891/apk/DF4FD15AF9A9B51BA74D2710CF738EEF.apk?fsname=com.ishugui_3.9.2.3068_3923068.apk&csr=1bbd";
3
 let x = http.downloadFile(url, "D:/ss.apk", 10 * 1000, {"User-Agent": "test"});
4
 logd("download result-> " + x);
5
}
6

7
main();

http.downloadFileDefault Download File

Download a remote file locally with resumable downloads; default timeout is 30 seconds
@param remoteUrl remote file URL
@param file local file path to save to
@param headers header map, e.g.{"a":"11"}
@return true on success, false on failure

1
function main() {
2
 let url = "https://imtt.dd.qq.com/16891/apk/DF4FD15AF9A9B51BA74D2710CF738EEF.apk?fsname=com.ishugui_3.9.2.3068_3923068.apk&csr=1bbd";
3
 let x = http.downloadFileDefault(url, "D:/ss.apk", {"User-Agent": "test"});
4
 logd("download result-> " + x);
5
}
6

7
main();

http.httpGetDefault GET Request

HTTP GET request
@param url request URL
@param timeout timeout in milliseconds
@param headers header map, e.g.{"a":"11"}
@return string response body

1
function main() {
2
 let url = "http://192.168.0.5:8081/api/httpGet?a=1";
3
 let x = http.httpGetDefault(url, 10 * 1000, {"User-Agent": "test"});
4
 logd(" result-> " + x);
5
 loge("result -> " + x);
6
}
7

8
main();

http.httpGet GET Request

HTTP GET request
@param url request URL
@param params parameter map, e.g. {"a":"11"} or a plain string
@param timeout timeout in milliseconds
@param headers header map, e.g.{"a":"11"}
@return string response body

1
function main() {
2
 let url = "http://192.168.0.5:8081/api/httpGet?a=1";
3
 let pa = {"b": "22"};
4
 let x = http.httpGet(url, pa, 10 * 1000, {"User-Agent": "test"});
5
 logd(" result-> " + x);
6
 loge("result -> " + x);
7
}
8

9
main();

http.httpPost POST Request

HTTP POST request
@param url request URL
@param params parameters, e.g. {"a":"11"} or a plain string
@param files files to upload, e.g. {"file1":"D:/1.png"}
@param timeout timeout in milliseconds
@param headers header map, e.g.{"a":"11"}
@return string response body

1
function main() {
2
 // Request without files
3
 let url = "http://192.168.0.5:8081/api/httpPost";
4
 let pa = {"b": "我是b的值"};
5
 let x = http.httpPost(url, pa, null, 10 * 1000, {"User-Agent": "test"});
6
 logd(" result-> " + x);
7
 loge("result -> " + x);
8
}
9

10
main();

1
function main() {
2
 // Request with file upload
3
 let url = "http://192.168.0.5:8081/api/httpPost";
4
 let pa = {"b": "我是b的值"};
5
 let files = {"file1": "D:/p.json", "file2": "D:/z.xml"};
6
 let x = http.httpPost(url, pa, files, 10 * 1000, {"User-Agent": "test"});
7
 logd(" result-> " + x);
8
 loge("result -> " + x);
9
}
10

11
main();

http.postJSON Send JSON

HTTP POST JSON data
@param url request URL
@param json JSON data
@param timeout timeout in milliseconds
@param headers header map, e.g.{"a":"11"}
@return string response body

1
function main() {
2
 let url = "http://192.168.0.5:8081/api/postJSON";
3
 let pa = {"b": "我是b的值"};
4
 let x = http.postJSON(url, pa, 10 * 1000, {"User-Agent": "test"});
5
 logd(" result-> " + x);
6
 loge("result -> " + x);
7
}
8

9
main();

http.newWebsocket WebSocket Communication

Create a WebSocket connection
@param url WebSocket URL to connect to
@param header header map
@param type library type — 1 = okhttp3, 2 = javawebsocket
@return {@link WebSocket} WebSocket object

1
function main() {
2
 let result = [];
3
 // Create a new WebSocket connection
4
 let ws = http.newWebsocket("ws://192.168.1.76:8081/websocket/device/call?deviceNo=111", null, 2);
5
 // Connection parameters when type=1
6
 ws.setCallTimeout(5);
7
 ws.setReadTimeout(5);
8
 ws.setWriteTimeout(5);
9
 // Heartbeat: recommended 0 because some servers do not support ping
10
 ws.setPingInterval(0)
11

12
 // Heartbeat timeout when type=2
13
 ws.setConnectionLostTimeout(5)
14
 // Set listener for connection open
15
 ws.onOpen(function (ws1, code, msg) {
16
 logi("onOpen code " + code + " msg:" + msg);
17
 })
18
 // Set text message listener
19
 ws.onText(function (ws1, text) {
20
 logi(" onText " + text);
21
 })
22
 // Set close listener
23
 ws.onClose(function (ws1, code, reason) {
24
 logi(" onClose " + code + " reason : " + reason + " remote:");
25
 })
26
 ws.onError(function (ws1, msg) {
27
 logi(" onError " + msg);
28
 result[0] = "error";
29
 })
30
 // bytes is a Java byte array object
31
 ws.onBinary(function (ws1, bytes) {
32
 // Convert to Java string
33
 logi(" onBinary " + new java.lang.String(bytes));
34
 })
35

36
 // Start connection (blocking)
37
 let r = ws.connect(10000);
38
 // Enable auto reconnect
39
 ws.setAutoReconnect(true);
40
 logd("connect {} rr = {}", result[0], r);
41

42
 while (true) {
43
 logd("isconnect " + ws.isConnected());
44
 sleep(1000)
45
 if (ws.isConnected()) {
46
 b = ws.sendText("new Date-> " + new Date())
47
 logd("send => " + b);
48
 sleep(1000)
49
 // Convert Java string to bytes
50
 ws.sendBinary(new java.lang.String("test").getBytes());
51
 } else {
52
 // Reset connection
53
 // let reset = ws.reset();
54
 // logd("reset {}",reset)
55
 // if (reset) {
56
 // logd("Reconnecting...");
57
 // let rc = ws.connect(10000);
58
 // logd("Reconnect--> "+rc);
59
 // }
60
 }
61
 }
62
 logd("isClosed " + ws.isClosed())
63
 sleep(1000)
64
 // Close connection
65
 ws.close();
66
}
67

68
main();

WebSocket Object Methods

connect Synchronous Connection

Start synchronous connection
See example

reset Reset Connection

Reset connection
@return {bool} true on success, false on failure
See example

isClosed Check Whether Closed

Check whether the connection is closed
@return true if closed, false if not closed
See example

isConnected Check Whether Connected

Check whether the connection is established
@return true if connected, false if not connected
See example

close Close Connection

Close the connection
See example

sendText Send Text

Send a text message
@param text text message
See example

sendBinary Send Binary

Send binary data
@param bin Java byte array object
See example

onOpen Open Callback

Callback when the connection opens
@param callback callback function
See example

onText Text Callback

Callback when a text message is received
@param callback callback function
See example

onClose Close Callback

Callback when the connection closes
@param callback callback function
See example

onError Error Callback

Callback when an error occurs
@param callback callback function
See example

onBinary Binary Message Callback

Callback when binary data is received
@param callback callback function
See example

setReadTimeout Set Read Timeout

Use when WebSocket library type = 1
Set read timeout
@param timeout timeout in seconds
See example

setWriteTimeout Set Write Timeout

Use when WebSocket library type = 1
Set write timeout
@param timeout timeout in seconds
See example

setPingInterval Set Ping Interval

Use when WebSocket library type = 1
Set heartbeat timeout
@param timeout timeout in seconds
See example

setConnectionLostTimeout Set Connection Lost Timeout

Use when WebSocket library type = 2
Set heartbeat timeout
@param timeout timeout in seconds
See example

setAutoReconnect Enable Auto Reconnect

Enable auto reconnect
See example