HTTPRequest

Inherits: Node < Object

Category: Core

Brief Description

A node with the ability to send HTTP requests.

Member Functions

void cancel_request ( )
int get_body_size ( ) const
int get_downloaded_bytes ( ) const
int get_http_client_status ( ) const
int request ( String url, PoolStringArray custom_headers=PoolStringArray( ), bool ssl_validate_domain=true, int method=0, String request_data=”” )

Signals

This signal is emitted upon request completion.

Member Variables

  • int body_size_limit - Maximum allowed size for response bodies.
  • String download_file - The file to download into. Will output any received file into it.
  • int max_redirects - Maximum number of allowed redirects.
  • bool use_threads - If true multithreading is used to improve performance.

Enums

enum Result

  • RESULT_SUCCESS = 0 — Request successful.
  • RESULT_CHUNKED_BODY_SIZE_MISMATCH = 1
  • RESULT_CANT_CONNECT = 2 — Request failed while connecting.
  • RESULT_CANT_RESOLVE = 3 — Request failed while resolving.
  • RESULT_CONNECTION_ERROR = 4 — Request failed due to connection(read/write) error.
  • RESULT_SSL_HANDSHAKE_ERROR = 5 — Request failed on SSL handshake.
  • RESULT_NO_RESPONSE = 6 — Request does not have a response(yet).
  • RESULT_BODY_SIZE_LIMIT_EXCEEDED = 7 — Request exceeded its maximum size limit, see set_body_size_limit.
  • RESULT_REQUEST_FAILED = 8 — Request failed. (Unused)
  • RESULT_DOWNLOAD_FILE_CANT_OPEN = 9 — HTTPRequest couldn’t open the download file.
  • RESULT_DOWNLOAD_FILE_WRITE_ERROR = 10 — HTTPRequest couldn’t write to the download file.
  • RESULT_REDIRECT_LIMIT_REACHED = 11 — Request reached its maximum redirect limit, see set_max_redirects.

Description

A node with the ability to send HTTP requests. Uses HTTPClient internally.

Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP.

Member Function Description

  • void cancel_request ( )

Cancels the current request.

  • int get_body_size ( ) const

Returns the response body length.

  • int get_downloaded_bytes ( ) const

Returns the amount of bytes this HTTPRequest downloaded.

  • int get_http_client_status ( ) const

Returns the current status of the underlying HTTPClient. See STATUS\_\* enum on HTTPClient.