HTTPRequest

    Category: Core

    A node with the ability to send HTTP requests.

    Properties

    Methods

    void ( )
    int ( ) const
    int ( ) const
    Status ( ) const
    Error ( String url, custom_headers=PoolStringArray( ), bool ssl_validate_domain=true, method=0, String request_data=”” )

    This signal is emitted upon request completion.

    Enumerations

    enum Result:

    • 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 .
    • 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.

    Description

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

    Property Descriptions

    • body_size_limit

    Maximum allowed size for response bodies.

    Setterset_download_file(value)
    Getterget_download_file()

    The file to download into. Will output any received file into it.

    • max_redirects

    Maximum number of allowed redirects.

    Setterset_use_threads(value)
    Getteris_using_threads()

    Method Descriptions

    • void cancel_request ( )

    Cancels the current request.

    • get_body_size ( ) const

    Returns the response body length.

    • int get_downloaded_bytes ( ) const

    Returns the amount of bytes this HTTPRequest downloaded.

    • get_http_client_status ( ) const

    Returns the current status of the underlying HTTPClient. See STATUS_* enum on .

    • Error request ( url, PoolStringArray custom_headers=PoolStringArray( ), ssl_validate_domain=true, Method method=0, request_data=”” )

    Returns @GlobalScope.OK if request is successfully created. (Does not imply that the server has responded), if not in the tree, @GlobalScope.ERR_BUSY if still processing previous request, if given string is not a valid URL format, or @GlobalScope.ERR_CANT_CONNECT if not using thread and the cannot connect to host.