HTTPRequest¶
类别: 核心
简要说明¶
能够发送HTTP请求的节点。
属性¶
-1 |
||
“ |
||
8 |
||
0 |
||
假 |
方法¶
无效 |
cancel_request ( ) |
get_body_size ( ) const |
|
get_downloaded_bytes ( ) const |
|
get_http_client_status ( ) const |
|
request ( String url, PoolStringArray custom_headers=PoolStringArray( ), bool ssl_validate_domain=true, Method method=0, String request_data="" ) |
信号¶
request_completed ( int result, int response_code, PoolStringArray headers, PoolByteArray body )
请求完成时发出。
枚举¶
枚举 结果 :
RESULT_SUCCESS = 0 ---请求成功。
RESULT_CHUNKED_BODY_SIZE_MISMATCH = 1
RESULT_CANT_CONNECT = 2 ---连接时请求失败。
RESULT_CANT_RESOLVE = 3 ---解析时请求失败。
RESULT_CONNECTION_ERROR = 4 ---由于连接(读/写)错误,请求失败。
RESULT_SSL_HANDSHAKE_ERROR = 5 ---请求在SSL握手时失败。
RESULT_NO_RESPONSE = 6 ---请求还没有响应。
RESULT_BODY_SIZE_LIMIT_EXCEEDED = 7 ---请求超出其最大大小限制,请参阅 body_size_limit .
RESULT_REQUEST_FAILED = 8 ---请求失败。(未使用)
RESULT_DOWNLOAD_FILE_CANT_OPEN = 9 ---httpRequest无法打开下载文件。
RESULT_DOWNLOAD_FILE_WRITE_ERROR = 10 ---httpRequest无法写入下载文件。
RESULT_REDIRECT_LIMIT_REACHED = 11 ---请求已达到其最大重定向限制,请参阅 max_redirects .
RESULT_TIMEOUT = 12
属性描述¶
int body_size_limit
违约 |
-1 |
设定器 |
设置车身尺寸限制(值) |
吸气剂 |
获取u body u size u limit()。 |
响应正文的最大允许大小。
String download_file
违约 |
“ |
设定器 |
设置下载文件(值) |
吸气剂 |
获取下载文件() |
要下载到的文件。将任何接收到的文件输出到其中。
int max_redirects
违约 |
8 |
设定器 |
设置最大重定向(值) |
吸气剂 |
获取最大重定向次数()。 |
允许的最大重定向数。
int timeout
违约 |
0 |
设定器 |
设置超时(值) |
吸气剂 |
获取超时值() |
bool use_threads
违约 |
假 |
设定器 |
设置“使用”线程(值) |
吸气剂 |
_正在使用_线程() |
如果 true
,多线程用于提高性能。
方法说明¶
void cancel_request ( )
取消当前请求。
int get_body_size ( ) const
返回响应正文长度。
int get_downloaded_bytes ( ) const
返回此httpRequest下载的字节数。
Status get_http_client_status ( ) const
返回基础的当前状态 HTTPClient . 见 STATUS_*
枚举打开 HTTPClient .
Error request ( String url, PoolStringArray custom_headers=PoolStringArray( ), bool ssl_validate_domain=true, Method method=0, String request_data="" )
在基础上创建请求 HTTPClient . 如果没有配置错误,则尝试使用 HTTPClient.connect_to_host 并将参数传递到 HTTPClient.request .
返回 @GlobalScope.OK 如果成功创建请求。(不表示服务器已响应) @GlobalScope.ERR_UNCONFIGURED 如果不在树上, @GlobalScope.ERR_BUSY 如果仍在处理上一个请求, @GlobalScope.ERR_INVALID_PARAMETER 如果给定的字符串不是有效的URL格式,或者 @GlobalScope.ERR_CANT_CONNECT 如果不使用螺纹和 HTTPClient 无法连接到主机。