 |
Qore Programming Language Reference Manual
0.9.2
|
|
Qore Programming Language Reference Manual
0.9.2
|
The HTTPClient class can be used to communicate with HTTP servers with and without TLS/SSL encryption. More...
Public Member Methods | |
| nothing | clearProxyURL () |
| Clears the new proxy URL value for the next connection. More... | |
| nothing | clearProxyUserPassword () |
| Clears the username and password for the next proxy connection. More... | |
| clearStats () | |
| Clears performance statistics. More... | |
| nothing | clearUserPassword () |
| Clears the username and password for the connection. More... | |
| nothing | clearWarningQueue () |
| Removes any warning Queue object from the Socket. More... | |
| nothing | connect () |
| Connects to the remote socket; SSL/TLS negotiation is performed if required. More... | |
| constructor (hash opts) | |
| Creates the HTTPClient object based on the option parameter passed. More... | |
| constructor () | |
| Creates the HTTPClient object. More... | |
| copy () | |
| Copying objects of this class is not supported, an exception will be thrown. More... | |
| destructor () | |
| Destroys the HTTPClient object and closes any open connections. More... | |
| nothing | disconnect () |
| Disconnects from the remote socket if a connection is established (otherwise does nothing) More... | |
| *string | get (string path, *hash headers, *reference< hash > info) |
Sends an HTTP GET request and returns the message body received as a string or NOTHING if no message body is received. More... | |
| int | getConnectTimeout () |
| Returns the connect timeout as an integer in milliseconds. More... | |
| *string | getConnectionPath () |
| Returns the current connection path set in the URL. More... | |
| string | getDefaultPath () |
| Returns the default path used by the object if no path is set in the URL. More... | |
| string | getEncoding () |
| Returns the character encoding used for the object. More... | |
| string | getHTTPVersion () |
| Returns the HTTP protocol version string used in outgoing messages. More... | |
| int | getMaxRedirects () |
Returns the current max_redirects value for the object (the maximum number of HTTP redirects that will be processed before an exception is raised) More... | |
| bool | getNoDelay () |
Returns the TCP_NODELAY setting for the HTTPClient object. More... | |
| *string | getProxyURL () |
| Returns the current proxy URL as a string or NOTHING if no proxy URL is set. More... | |
| int | getTimeout () |
| Returns the default I/O timeout as an integer in milliseconds. More... | |
| *string | getURL () |
| Returns the current URL. More... | |
| hash | getUsageInfo () |
| Returns performance statistics for the socket. More... | |
| hash | head (string path, *hash headers, *reference< hash > info) |
Sends an HTTP HEAD request and returns as hash of the headers received. More... | |
| bool | isConnected () |
| Returns True or False giving the current connection state. More... | |
| bool | isProxySecure () |
| Returns the SSL/TLS flag for the next proxy connection. More... | |
| bool | isSecure () |
| Returns True if the current connection is encrypted, False if not. More... | |
| *string | post (string path, string body, *hash headers, *reference< hash > info) |
Sends an HTTP POST request with a message body and returns the message body received as a string or NOTHING if no message body is received. More... | |
| *string | post (string path, *binary body, *hash headers, *reference< hash > info) |
Sends an HTTP POST request with a message body and returns the message body received as a string or NOTHING if no message body is received. More... | |
| hash | send (string body, string method, *string path, *hash headers, softbool getbody=False, *reference< hash > info) |
| Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format. More... | |
| hash | send (*binary body, string method, *string path, *hash headers, softbool getbody=False, *reference< hash > info) |
| Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format. More... | |
| nothing | send (Qore::OutputStream os, *data body, string method, *string path, *hash headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash > info, *code rcb) |
| Sends an HTTP request with the specified method and optional message body; headers are returned through an optional receive callback and any body received is written to the OutputStream. More... | |
| nothing | sendChunked (Qore::OutputStream os, Qore::InputStream is, string method, int max_chunk_size=4096, *string path, *hash headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash > info, *code rcb, *code tcb) |
| Sends a chunked HTTP request with the specified method and message body; headers are returned through an optional receive callback and any body received is written to the OutputStream. More... | |
| nothing | sendWithCallbacks (code scb, code rcb, string method, *string path, *hash headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash > info) |
| Sends an HTTP request with the specified method and chunked message body as given by a send callback; headers and any body received are returned through a receive callback. More... | |
| nothing | sendWithRecvCallback (code rcb, string body, string method, *string path, *hash headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash > info) |
| Sends an HTTP request with the specified method and optional message body; headers and any body received are returned through a receive callback. More... | |
| nothing | sendWithRecvCallback (code rcb, *binary body, string method, *string path, *hash headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash > info) |
| Sends an HTTP request with the specified method and optional message body; headers and any body received are returned through a receive callback. More... | |
| hash | sendWithSendCallback (code scb, string method, *string path, *hash headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash > info) |
| Sends an HTTP request with the specified method and chunked message body as given by a send callback and returns headers and any body received as a response in a hash format. More... | |
| nothing | setConnectTimeout (timeout timeout_ms=-1) |
| Sets the connect timeout in milliseconds. More... | |
| nothing | setDefaultPath (*string path) |
| Sets the default path used by the object if no path is set in the URL. More... | |
| nothing | setEncoding (string encoding) |
| Sets the string encoding for the object; any strings deserialized with this object will be tagged with this character encoding. More... | |
| nothing | setEventQueue () |
| Clears any Queue object that may be set on the HTTPClient object so that I/O events are no longer captured on the object. More... | |
| nothing | setEventQueue (Qore::Thread::Queue queue) |
| Sets a Queue object to receive HTTPClient and Socket events. More... | |
| nothing | setHTTPVersion (string ver) |
Sets the HTTP protocol version string for headers in outgoing messages, allowed values are "1.0" and "1.1". More... | |
| nothing | setMaxRedirects (softint mr=0) |
Updates the setting for the max_redirects value for the object (maximum number of HTTP redirects that will be processed before an exception is raised) More... | |
| int | setNoDelay (softbool b=True) |
Sets the TCP_NODELAY setting for the object. More... | |
| setPersistent () | |
| temporarily disables implicit reconnections; must be called when the server is already connected More... | |
| nothing | setProxySecure (softbool b=True) |
| Sets the SSL/TLS flag for the next connection to the proxy. More... | |
| nothing | setProxyURL () |
| Clears the new proxy URL value for the next connection. More... | |
| nothing | setProxyURL (string url) |
| Sets a new proxy URL value for the next connection. More... | |
| nothing | setProxyUserPassword (string user, string pass) |
| Sets the username and password for the connection to the proxy; call after HTTPClient::setProxyURL() More... | |
| nothing | setProxyUserPassword () |
| Clears the username and password for the next proxy connection. More... | |
| nothing | setSecure (softbool secure=True) |
| Sets the object to make a secure SSL/TLS connection on the next connect if the passed argument is True, or an unencrypted cleartext connection if it is False. More... | |
| nothing | setTimeout (timeout timeout_ms=0) |
| Sets the default I/O timeout value in milliseconds. More... | |
| setURL (string url) | |
| Sets a new URL value for the next connection. More... | |
| nothing | setUserPassword (string user, string pass) |
| Sets the username and password for the connection; call after HTTPClient::setURL() More... | |
| nothing | setUserPassword () |
| Clears the username and password for the connection. More... | |
| nothing | setWarningQueue (int warning_ms, int warning_bs, Queue queue, auto arg, timeout min_ms=1s) |
| Sets a Queue object to receive socket warnings. More... | |
 Public Member Methods inherited from Qore::Socket | |
| Socket | accept () |
| Accepts connections on a listening socket. More... | |
| *Socket | accept (timeout timeout_ms) |
| Accepts connections on a listening socket (see Socket::listen()) accepting a timeout value with a millisecond resolution. More... | |
| acceptAllCertificates (bool accept_all=True) | |
| with peer verification enabled, all certificates are accepted regardless of the validity of the Certificate Authority More... | |
| Socket | acceptSSL () |
| Accepts connections on a listening socket and attempts to negotiate a TLS/SSL connection. More... | |
| *Socket | acceptSSL (timeout timeout_ms) |
| Accepts connections on a listening socket and attempts to negotiate a TLS/SSL connection accepting a timeout value with a millisecond resolution. More... | |
| int | bind (string str, softbool reuseaddr=False) |
| Opens and binds the socket to a port, interface and port (if the bind_to string has a format "host:port"), or UNIX domain socket file. More... | |
| int | bind (int port, softbool reuseaddr=False) |
| Opens and binds the socket to an INET port on all interfaces. More... | |
| nothing | bindINET (*string iface, *softstring service, softbool reuseaddr=False, softint family=AF_UNSPEC, softint socktype=SOCK_STREAM, softint protocol=0) |
| Opens and binds the socket to the given IPv4 or IPv6 interface (or if no interface is given, then to all interfaces on the local system) and port (the port number will be derived from the service name if a numeric port number is not given) More... | |
| nothing | bindUNIX (string path, softint socktype=SOCK_STREAM, softint protocol=0) |
| Opens and binds the socket to the given UNIX domain socket file as given by the filename argument. If any errors occur, an exception is thrown. More... | |
| clearStats () | |
| Clears performance statistics. More... | |
| nothing | clearWarningQueue () |
| Removes any warning Queue object from the Socket. More... | |
| int | close () |
| Closes an open socket. More... | |
| nothing | connect (string target, timeout timeout_ms=-1) |
| Connects to a remote port (if the string has a format "host:port") or UNIX domain socket file with an optional timeout value with a millisecond resolution. More... | |
| nothing | connectINET (string host, softstring service, timeout timeout_ms=-1, softint family=AF_UNSPEC, softint socktype=SOCK_STREAM, softint protocol=0) |
| Connects to the given host and port with an optional timeout value with a millisecond resolution. More... | |
| nothing | connectINETSSL (string host, softstring service, timeout timeout_ms=-1, softint family=AF_UNSPEC, softint socktype=SOCK_STREAM, softint protocol=0) |
| Connects to the given host and port and attempts to establish a TLS/SSL connection; accepts an optional timeout value with a millisecond resolution. More... | |
| nothing | connectSSL (string target, timeout timeout_ms=-1) |
| Connects to a remote socket and attempts to establish a TLS/SSL connection; accepts an optional timeout value with a millisecond resolution. More... | |
| nothing | connectUNIX (string path, softint socktype=SOCK_STREAM, softint protocol=0) |
| Connects to a UNIX domain socket file. More... | |
| nothing | connectUNIXSSL (string path, softint socktype=SOCK_STREAM, softint protocol=0) |
| Connects to the given UNIX domain socket file and attempts to establish a TLS/SSL connection. More... | |
| constructor () | |
| Creates the socket object. More... | |
| copy () | |
| Creates a new Socket object, not based on the source being copied. More... | |
| bool | getAcceptAllCertificates () |
| returns the current value of the "accept all certificates" flag More... | |
| string | getCharset () |
| Returns the character encoding for the socket. More... | |
| string | getEncoding () |
| Returns the character encoding for the socket. More... | |
| bool | getNoDelay () |
Returns the TCP_NODELAY setting for the socket. More... | |
| hash | getPeerInfo (bool host_lookup=True) |
| Returns a hash of information about the remote end for connected sockets. More... | |
| int | getPort () |
| Returns the port number of the socket for INET sockets. More... | |
| int | getRecvTimeout () |
| Returns the receive timeout socket option value as an integer in milliseconds. More... | |
| *string | getSSLCipherName () |
| Returns the name of the cipher for an encrypted connection or NOTHING if a secure connection has not been established. More... | |
| *string | getSSLCipherVersion () |
| Returns the version string of the cipher for an encrypted connection or NOTHING if a secure connection has not been established. More... | |
| int | getSendTimeout () |
| Returns the send timeout socket option value as an integer in milliseconds. More... | |
| int | getSocket () |
| Returns the socket file descriptor number. More... | |
| hash | getSocketInfo (bool host_lookup=True) |
| Returns information about the local socket as a hash. More... | |
| int | getSslVerifyMode () |
| returns the current SSL verification mode More... | |
| hash | getUsageInfo () |
| Returns performance statistics for the socket. More... | |
| bool | isDataAvailable (timeout timeout_ms=0) |
| Returns True or False depending on whether there is data to be read on the socket. More... | |
| bool | isOpen () |
| Returns True if the socket is open. More... | |
| bool | isSecure () |
| Returns True if the connection is a secure TLS/SSL connection. More... | |
| bool | isWriteFinished (timeout timeout_ms=0) |
| Returns True or False depending on whether all the data has been written to the socket. More... | |
| int | listen (int backlog=20) |
| Listens for connections on a bound socket; sets the socket in a listening state. More... | |
| bool | pendingHttpChunkedBody () |
| returns True if the socket is still connected, and a HTTP header was read indicating chunked transfer encoding, but no chunked body has been read yet More... | |
| hash | readHTTPChunkedBody (timeout timeout_ms=-1) |
Reads in an HTTP message body sent in chunked transfer encoding and returns it with any footers received as a string in the "body" key of a hash (including footers received) More... | |
| hash | readHTTPChunkedBodyBinary (timeout timeout_ms=-1) |
Reads in an HTTP message body sent in chunked transfer encoding and returns it with any footers received as a binary object in the "body" key of a hash (including footers received) More... | |
| readHTTPChunkedBodyBinaryWithCallback (code rcb, timeout timeout_ms=-1) | |
Reads in an HTTP message body sent in chunked transfer encoding and returns it with any footers received as a string in the "body" key of a hash (including footers received) More... | |
| hash | readHTTPChunkedBodyToOutputStream (Qore::OutputStream os, timeout timeout_ms=-1) |
| Reads in an HTTP message body sent in chunked transfer encoding, writes it in an OutputStream and returns any footers received. More... | |
| readHTTPChunkedBodyWithCallback (code rcb, timeout timeout_ms=-1) | |
Reads in an HTTP message body sent in chunked transfer encoding and returns it with any footers received as a string in the "body" key of a hash (including footers received) More... | |
| hash | readHTTPHeader (timeout timeout_ms=-1, *reference< hash > info) |
Retuns a hash representing the data in the HTTP header read, or, if the data cannot be parsed as an HTTP header, then an exception is thrown, and the data read is returned as a string in the arg key of the exception hash. More... | |
| string | readHTTPHeaderString (timeout timeout_ms=-1) |
Retuns a string representing the data in the HTTP header read (reads until "\r\n\r\n") More... | |
| string | recv (softint size=0, timeout timeout_ms=-1) |
| Receives data from the socket and returns a string tagged with the Socket's character encoding. More... | |
| binary | recvBinary (softint size=0, timeout timeout_ms=-1) |
| Receives data from the socket and returns a binary object. More... | |
| nothing | recvToOutputStream (Qore::OutputStream os, softint size=-1, timeout timeout_ms=-1) |
| Receives data from the socket and writes the bytes to an OutputStream. More... | |
| int | recvi1 (timeout timeout_ms=-1) |
| Receives a 1-byte signed integer from the socket. More... | |
| int | recvi2 (timeout timeout_ms=-1) |
| Receives a 2-byte (16-bit) signed integer in big-endian format (network byte order) from the socket. More... | |
| int | recvi2LSB (timeout timeout_ms=-1) |
| Receives a 2-byte (16-bit) signed integer in little-endian format from the socket. More... | |
| int | recvi4 (timeout timeout_ms=-1) |
| Receives a 4-byte (32-bit) signed integer in big-endian format (network byte order) from the socket. More... | |
| int | recvi4LSB (timeout timeout_ms=-1) |
| Receives a 4-byte (32-bit) signed integer in little-endian format from the socket. More... | |
| int | recvi8 (timeout timeout_ms=-1) |
| Receives an 8-byte (64-bit) signed integer in big-endian format (network byte order) from the socket. More... | |
| int | recvi8LSB (timeout timeout_ms=-1) |
| Receives an 8-byte (64-bit) signed integer in little-endian format from the socket. More... | |
| int | recvu1 (timeout timeout_ms=-1) |
| Receives a 1-byte unsigned integer from the socket. More... | |
| int | recvu2 (timeout timeout_ms=-1) |
| Receives a 2-byte (16-bit) unsigned integer in big-endian format (network byte order) from the socket. More... | |
| int | recvu2LSB (timeout timeout_ms=-1) |
| Receives a 2-byte (16-bit) unsigned integer in little-endian format from the socket. More... | |
| int | recvu4 (timeout timeout_ms=-1) |
| Receives a 4-byte (32-bit) unsigned integer in big-endian format (network byte order) from the socket. More... | |
| int | recvu4LSB (timeout timeout_ms=-1) |
| Receives a 4-byte (32-bit) unsigned integer in little-endian format from the socket. More... | |
| int | send (binary bin, timeout timeout_ms=-1) |
| Sends binary data over the socket; if any errors occur, an exception is thrown. More... | |
| int | send (string str, timeout timeout_ms=-1) |
| Sends string data over the socket; string data is converted to the socket's encoding if necessary; if any errors occur, an exception is thrown. More... | |
| nothing | send2 (binary bin, timeout timeout_ms=-1) |
| Sends binary data over the socket; if any errors occur, an exception is thrown. More... | |
| nothing | send2 (string str, timeout timeout_ms=-1) |
| Sends string data over the socket; string data is converted to the socket's encoding if necessary; if any errors occur, an exception is thrown. More... | |
| int | sendBinary (string str, timeout timeout_ms=-1) |
| Sends string data over the socket without converting the string to the socket's encoding, but instead is sent exactly as-is; if any errors occur, an exception is thrown. More... | |
| int | sendBinary (binary bin, timeout timeout_ms=-1) |
| Sends binary data over the socket; if any errors occur, an exception is thrown. More... | |
| nothing | sendBinary2 (string str, timeout timeout_ms=-1) |
| Sends string data over the socket without converting the string to the socket's encoding, but instead is sent exactly as-is; if any errors occur, an exception is thrown. More... | |
| nothing | sendBinary2 (binary bin, timeout timeout_ms=-1) |
| Sends binary data over the socket; if any errors occur, an exception is thrown. More... | |
| nothing | sendFromInputStream (Qore::InputStream is, softint size=-1, timeout timeout_ms=-1) |
| Reads data from an InputStream and sends the bytes over the socket. More... | |
| nothing | sendHTTPChunkedBodyFromInputStream (Qore::InputStream is, int max_chunk_size=4096, timeout timeout_ms=-1, *code tcb) |
| Sends an HTTP message body in chunked transfer encoding. More... | |
| nothing | sendHTTPChunkedBodyTrailer (*hash trailer, timeout timeout_ms=-1) |
| Sends the trialer of an HTTP message body in chunked transfer encoding. More... | |
| nothing | sendHTTPMessage (string method, string path, string http_version, hash headers, *string body, *reference< hash > info, timeout timeout_ms=-1) |
| Sends an HTTP message with a method and user-defined headers given as a hash and an optional message body. More... | |
| nothing | sendHTTPMessage (string method, string path, string http_version, hash headers, binary body, *reference< hash > info, timeout timeout_ms=-1) |
| Sends an HTTP message with a method and user-defined headers given as a hash and an optional message body. More... | |
| nothing | sendHTTPMessageWithCallback (code scb, string method, string path, string http_version, hash headers, *reference< hash > info, timeout timeout_ms=-1) |
| Sends an HTTP message with a method and user-defined headers given as a hash and an optional message body. More... | |
| nothing | sendHTTPResponse (softint status_code, string status_desc, string http_version, hash headers, *string body, timeout timeout_ms=-1) |
| Sends an HTTP response with user-defined headers given as a hash and an optional message body. More... | |
| nothing | sendHTTPResponse (softint status_code, string status_desc, string http_version, hash headers, binary body, timeout timeout_ms=-1) |
| Sends an HTTP response with user-defined headers given as a hash and a message body as literal binary data. More... | |
| nothing | sendHTTPResponseWithCallback (code scb, softint status_code, string status_desc, string http_version, hash headers, timeout timeout_ms=-1) |
| Sends an HTTP response with user-defined headers given as a hash and a message body as literal binary data. More... | |
| int | sendi1 (softint i=0, timeout timeout_ms=-1) |
| Sends a 1-byte integer over the socket. More... | |
| int | sendi2 (softint i=0, timeout timeout_ms=-1) |
| Sends a 2-byte (16-bit) integer in big-endian format (network byte order) over the socket. More... | |
| int | sendi2LSB (softint i=0, timeout timeout_ms=-1) |
| Sends a 2-byte (16-bit) integer in little-endian format over the socket. More... | |
| int | sendi4 (softint i=0, timeout timeout_ms=-1) |
| Sends a 4-byte (32-bit) integer in big-endian format (network byte order) over the socket. More... | |
| int | sendi4LSB (softint i=0, timeout timeout_ms=-1) |
| Sends a 4-byte (32-bit) integer in little-endian format over the socket. More... | |
| int | sendi8 (softint i=0, timeout timeout_ms=-1) |
| Sends an 8-byte (64-bit) integer in big-endian format (network byte order) over the socket. More... | |
| int | sendi8LSB (softint i=0, timeout timeout_ms=-1) |
| Sends an 8-byte (64-bit) integer in little-endian format over the socket. More... | |
| nothing | setCertificate (SSLCertificate cert) |
| Sets the X.509 certificate to use for negotiating encrypted connections. More... | |
| nothing | setCertificate (string cert_pem) |
| Sets the X.509 certificate to use for negotiating encrypted connections from the PEM-encoded string representing the X.509 certificate. More... | |
| nothing | setCertificate (binary cert_der) |
| Sets the X.509 certificate to use for negotiating encrypted connections from the DER-encoded binary object representing the X.509 certificate. More... | |
| nothing | setCharset (string encoding) |
| Sets the character encoding for the socket. More... | |
| nothing | setEncoding (string encoding) |
| Sets the character encoding for the socket. More... | |
| nothing | setEventQueue () |
| Removes any Queue object from the Socket object so that socket events are no longer added to the Queue. More... | |
| nothing | setEventQueue (Queue queue) |
| Sets a Queue object to receive socket events. More... | |
| int | setNoDelay (bool nd=True) |
Sets the boolean TCP_NODELAY setting for the socket. More... | |
| nothing | setPrivateKey (SSLPrivateKey key) |
| Sets the private key to use for negotiating encrypted connections along with the X.509 certificate. More... | |
| nothing | setPrivateKey (string key_pem, *string pass) |
| Sets the private key to use for negotiating encrypted connections along with the X.509 certificate from a PEM-encoded string representing the private key and an optional password. More... | |
| nothing | setPrivateKey (binary key_der) |
| Sets the private key to use for negotiating encrypted connections along with the X.509 certificate from a DER-encoded binary object representing the private key. More... | |
| int | setRecvTimeout (timeout timeout_ms) |
| sets the receive timeout as a socket option More... | |
| int | setSendTimeout (timeout timeout_ms) |
| sets the send timeout as a socket option More... | |
| setSslVerifyMode (int mode) | |
| sets the SSL verification mode More... | |
| nothing | setWarningQueue (int warning_ms, int warning_bs, Queue queue, auto arg, timeout min_ms=1s) |
| Sets a Queue object to receive socket warnings. More... | |
| int | shutdown () |
| Ensures that a socket will be closed even if the file descriptor is shared with other processes (for example, after a call to fork()) More... | |
| nothing | shutdownSSL () |
| Shuts down the SSL connection on a secure connection. More... | |
| nothing | upgradeClientToSSL (timeout timeout_ms=-1) |
| Upgrades a client socket connection to a TLS/SSL connection. More... | |
| nothing | upgradeServerToSSL (timeout timeout_ms=-1) |
| Upgrades a server socket connection to a TLS/SSL connection. More... | |
| *string | verifyPeerCertificate () |
| Returns a string code giving the result of verifying the remote certificate or NOTHING if an encrypted connection is not currently established. More... | |
The HTTPClient class can be used to communicate with HTTP servers with and without TLS/SSL encryption.
The HTTPClient class can be used to communicate with HTTP servers using the HTTP or HTTPS (HTTP using an SSL/TLS encrypted connection) protocol.
By default "Connection: Keep-Alive" is always sent regardless of the HTTP protocol level set for the object, however if a server response contains "Connection: close", the connection will be closed as soon as the full response (including any message body if present) has been read.
HTTP redirect responses are supported and can be limited with the max_redirects constructor hash key or by using the HTTPClient::setMaxRedirects() method. The default maximum number of redirects allowed is 5.
HTTP basic authentication is supported; set the username and password in the URL (ex: "http://username:password@host:port/path"). To change the URL from the one set by the constructor, call HTTPClient::setURL().
HTTP proxies and basic proxy authentication are supported by setting the proxy constructor hash key to the proxy URL (with a proxy username and password if required) or by calling the HTTPClient::setProxyURL() method.
Objects of this class are thread-safe and support serializing multiple simultaneous requests from many threads. If a request is in progress and another thread attempts to make a request at the same time, the second thread will block until the first is complete. Therefore the total amount of time a thread could wait for a response in a multi-threaded context could be greater than the timeout value (which applies to the maximum time a single internal send() or recv() action can take).
This class understands and automatically decodes "deflate", "gzip", and "bzip2" content encodings as well.
The default I/O timeout value is 300,000 milliseconds (5 minutes). Note that the timeout value applies to individual internal send() or recv() operations; for this reason for large transfers the overall I/O time could exceed the timeout value.
When an exception is thrown (for example, a response code of < 100 or >= 400 is received from the server), any message body returned will be in the "arg" key of the exception hash.
This class understands the protocols in the following table.
HTTPClient Class Protocols
| Protocol/Scheme | Default Port | SSL? | Description |
http | 80 | No | Unencrypted HTTP protocol |
https | 443 | Yes | HTTP protocol with SSL/TLS encryption |
Whenever using an HTTPClient method where a hash of headers can be passed to the method, some headers are generated by default by the class and can be overridden, and some are cannot be overridden and are ignored if passed by the client. See the following tables for details.
HTTPClient Mandatory Headers
| Header | Description |
Content-Length | This header is only sent if a message body is sent, and, if so, the length is calculated automatically. |
HTTPClient Default, but Overridable Headers
| Header | Default Value |
Accept | "text/html" |
Content-Type | "text/html" |
User-Agent | "Qore-HTTP-Client/0.8.8" |
Connection | "Keep-Alive" |
Accept-Encoding | "gzip,deflate,bzip2" |
This class supports posting network events to a Queue. See I/O Event Handling for more information.
The events raised by this object are listed in the following table: HTTPClient Events
| Name | Description |
| EVENT_HTTP_CONTENT_LENGTH | Raised when the HTTP "Content-Length" header is received. |
| EVENT_HTTP_CHUNKED_START | Raised when HTTP chunked data is about to be received. |
| EVENT_HTTP_CHUNKED_END | Raised when all HTTP chunked data has been received. |
| EVENT_HTTP_REDIRECT | Raised when an HTTP redirect message is received. |
| EVENT_HTTP_SEND_MESSAGE | Raised when an HTTP message is sent. |
| EVENT_HTTP_MESSAGE_RECEIVED | Raised when an HTTP message is received. |
| EVENT_HTTP_FOOTERS_RECEIVED | Raised when HTTP footers are received. |
| EVENT_HTTP_CHUNKED_DATA_RECEIVED | Raised when a block of HTTP chunked data is received. |
| EVENT_HTTP_CHUNK_SIZE | Raised when the next chunk size for HTTP chunked data is known. |
The Qore HTTPClient class allows GET requests to be made with a message body, however please note that this is a bad practice according to HTTP 1.1 RFCs; specifically:
if the request method does not include defined semantics for an entity-body, then the message-body SHOULD be ignored when handling the request.
A payload within a GET request message has no defined semantics; sending a payload body on a GET request might cause some existing implementations to reject the request.
Therefore we can conclude that GET methods do not include defined semantics, and therefore message bodies included with GET requests SHOULD be ignored according to the HTTP 1.1 spec, therefore it's recommended not to send a message body with a GET request if standards compliance and compatibility is a goal.
scheme://socket=url_encoded_path/path, where url_encoded_path is a path with URL-encoding as performed by encode_url(string, True); for example: "http://socket=%2ftmp%socket-dir%2fsocket-file-1/url/path"; this allows a filesystem path to be used in the host portion of the URL and for the URL to include a URL path as well.UTF-8); this class does not include a ";charset=utf-8" in the "Content-Type" header by default; this must be set explicitly by users of this class if necessary. | nothing Qore::HTTPClient::clearProxyURL | ( | ) |
Clears the new proxy URL value for the next connection.
| nothing Qore::HTTPClient::clearProxyUserPassword | ( | ) |
Clears the username and password for the next proxy connection.
Call this method after calling HTTPClient::setProxyURL() to clear any proxy authentication information present in the URL used in HTTPClient::setProxyURL()
| Qore::HTTPClient::clearStats | ( | ) |
Clears performance statistics.
| nothing Qore::HTTPClient::clearUserPassword | ( | ) |
Clears the username and password for the connection.
Call this method after calling HTTPClient::setURL() to clear any authentication information present in the URL used in HTTPClient::setURL()
| nothing Qore::HTTPClient::clearWarningQueue | ( | ) |
Removes any warning Queue object from the Socket.
| nothing Qore::HTTPClient::connect | ( | ) |
Connects to the remote socket; SSL/TLS negotiation is performed if required.
If the protocol indicates that a secure connection should be established (or HTTPClient::setSecure() was called previsouly), SSL/TLS negotiation will be attempted.
If the TCP_NODELAY flag has been set (see HTTPClient::setNoDelay()), then after a successful connection to the remote socket, this option will be set on the socket. If an error occurs setting the TCP_NODELAY option, the internal flag is set to false (use HTTPClient::getNoDelay() to check the flag's state) and the error code can be retrieved with errno().
| Qore::HTTPClient::constructor | ( | hash | opts | ) |
Creates the HTTPClient object based on the option parameter passed.
To connect, call any method that requires a connection and an implicit connection is established, or call HTTPClient::connect().
| opts | sets options and changes default behaviour for the object, etc; key names are case-sensitive and therefore must all be in lower-case:
|
| HTTP-CLIENT-OPTION-ERROR | invalid or unknown option passed in option hash |
| HTTP-CLIENT-URL-ERROR | invalid URL string |
| HTTP-CLIENT-UNKNOWN-PROTOCOL | unknown protocol passed in URL |
| ILLEGAL-FILESYSTEM-ACCESS | if the calling context is restricted with the Qore::PO_NO_FILESYSTEM sandboxing restriction and one of the following options is used: ssl_cert_path or ssl_key_path |
scheme://socket=url_encoded_path/path, where url_encoded_path is a path with URL-encoding as performed by encode_url(string, True); for example: "http://socket=%2ftmp%socket-dir%2fsocket-file-1/url/path"; this allows a filesystem path to be used in the host portion of the URL and for the URL to include a URL path as well.ssl_cert_path or ssl_key_path options are usedssl_cert_path or ssl_key_path ssl_cert_path ssl_key_path ssl_key_password ssl_verify_cert | Qore::HTTPClient::constructor | ( | ) |
Creates the HTTPClient object.
| Qore::HTTPClient::copy | ( | ) |
Copying objects of this class is not supported, an exception will be thrown.
| HTTPCLIENT-COPY-ERROR | copying HTTPClient objects is not yet supported |
| Qore::HTTPClient::destructor | ( | ) |
Destroys the HTTPClient object and closes any open connections.
| nothing Qore::HTTPClient::disconnect | ( | ) |
Disconnects from the remote socket if a connection is established (otherwise does nothing)
Sends an HTTP GET request and returns the message body received as a string or NOTHING if no message body is received.
In order to get the headers and the body, use the HTTPClient::send() method instead (although note that sending an HTTP message bosdy with a GET request is not standards compliant; see HTTP GET Requests With a Message Body for more information).
If no connection has already been established, an internal call to HTTPClient::connect() will be made before sending the request.
If any content encoding is used for the message body in the reply, the content is decoded and returned as a string; if the content encoding uses an unknown method, then an exception is thrown.
| path | the path for the message (i.e. "/path/resource?method¶m=value") |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| info | an optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request; this hash contains the following keys:
|
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received or status error communicating with HTTP server (status code < 100 or > 299); in case of a status error the "arg" key of the exception hash will be set to a hash equal to the return value of the send() method including a "status_code" key (giving the status code) and a "body" key (giving the message body returned by the server) |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
| *string Qore::HTTPClient::getConnectionPath | ( | ) |
Returns the current connection path set in the URL.
| int Qore::HTTPClient::getConnectTimeout | ( | ) |
Returns the connect timeout as an integer in milliseconds.
| string Qore::HTTPClient::getDefaultPath | ( | ) |
Returns the default path used by the object if no path is set in the URL.
| string Qore::HTTPClient::getEncoding | ( | ) |
Returns the character encoding used for the object.
| string Qore::HTTPClient::getHTTPVersion | ( | ) |
Returns the HTTP protocol version string used in outgoing messages.
| int Qore::HTTPClient::getMaxRedirects | ( | ) |
Returns the current max_redirects value for the object (the maximum number of HTTP redirects that will be processed before an exception is raised)
max_redirects value for the object (the maximum number of HTTP redirects that will be processed before an exception is raised)| bool Qore::HTTPClient::getNoDelay | ( | ) |
Returns the TCP_NODELAY setting for the HTTPClient object.
| *string Qore::HTTPClient::getProxyURL | ( | ) |
| int Qore::HTTPClient::getTimeout | ( | ) |
Returns the default I/O timeout as an integer in milliseconds.
| *string Qore::HTTPClient::getURL | ( | ) |
Returns the current URL.
| hash Qore::HTTPClient::getUsageInfo | ( | ) |
Returns performance statistics for the socket.
"bytes_sent": an integer giving the total amount of bytes sent"bytes_recv": an integer giving the total amount of bytes received"us_sent": an integer giving the total number of microseconds spent sending data"us_recv": an integer giving the total number of microseconds spent receiving data"arg": (only if warning values have been set with HTTPClient::setWarningQueue()) the optional argument for warning hashes"timeout": (only if warning values have been set with HTTPClient::setWarningQueue()) the warning timeout in microseconds"min_throughput": (only if warning values have been set with HTTPClient::setWarningQueue()) the minimum warning throughput in bytes/secSends an HTTP HEAD request and returns as hash of the headers received.
If no connection is established, an internal call to HTTPClient::connect() will be made before sending the message.
| path | the path for the message (i.e. "/path/resource?method¶m=value") |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| info | an optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request; this hash contains the following keys:
|
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received or status error communicating with HTTP server (status code < 100 or > 299); in case of a status error the "arg" key of the exception hash will be set to a hash equal to the return value of the send() method including a "status_code" key (giving the status code) and a "body" key (giving the message body returned by the server) |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
| bool Qore::HTTPClient::isConnected | ( | ) |
| bool Qore::HTTPClient::isProxySecure | ( | ) |
Returns the SSL/TLS flag for the next proxy connection.
| bool Qore::HTTPClient::isSecure | ( | ) |
Sends an HTTP POST request with a message body and returns the message body received as a string or NOTHING if no message body is received.
In order to get the headers and the body in the response, use the HTTPClient::send() method instead.
If no connection is established, an internal call to HTTPClient::connect() will be made before sending the message.
| path | the path for the message (i.e. "/path/resource?method¶m=value") |
| body | the string to use as the message body |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| info | an optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request; this hash contains the following keys:
|
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received or status error communicating with HTTP server (status code < 100 or > 299); in case of a status error the "arg" key of the exception hash will be set to a hash equal to the return value of the send() method including a "status_code" key (giving the status code) and a "body" key (giving the message body returned by the server) |
| ENCODING-CONVERSION-ERROR | the given string could not be converted to the socket's character encoding |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
| *string Qore::HTTPClient::post | ( | string | path, |
| *binary | body, | ||
| *hash | headers, | ||
| *reference< hash > | info | ||
| ) |
Sends an HTTP POST request with a message body and returns the message body received as a string or NOTHING if no message body is received.
In order to get the headers and the body in the response, use the HTTPClient::send() method instead.
If no connection is established, an internal call to HTTPClient::connect() will be made before sending the message.
| path | the path for the message (i.e. "/path/resource?method¶m=value") |
| body | the optional data to use as the message body |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| info | an optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request; this hash contains the following keys:
|
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received or status error communicating with HTTP server (status code < 100 or > 299); in case of a status error the "arg" key of the exception hash will be set to a hash equal to the return value of the send() method including a "status_code" key (giving the status code) and a "body" key (giving the message body returned by the server) |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
| hash Qore::HTTPClient::send | ( | string | body, |
| string | method, | ||
| *string | path, | ||
| *hash | headers, | ||
| softbool | getbody = False, |
||
| *reference< hash > | info | ||
| ) |
Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format.
If a connection has not already been established, an internal call to HTTPClient::connect() will be made before sending the message
| body | The message body to send; note that sending an HTTP message bosdy with a GET request is not standards compliant; see HTTP GET Requests With a Message Body for more information |
| method | The name of the HTTP method ("GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE", "CONNECT", or "PATCH"). Additional methods can be added in the constructor with the a additional_methods option. |
| path | The path for the message (i.e. "/path/resource?method¶m=value") |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| getbody | If this argument is True, then the object will try to receive a message body even if no "Content-Length" header is present in the response. Use this only with broken servers that send message bodies without a "Content-Length" header. |
| info | An optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request; this hash contains the following keys:
|
"body" key and the HTTP status will be assigned to the "status_code" key.| HTTP-CLIENT-METHOD-ERROR | invalid/unknown HTTP method passed |
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received or status error communicating with HTTP server (status code < 100 or > 299); in case of a status error the "arg" key of the exception hash will be set to a hash equal to the normal return value of this method including a "status_code" key (giving the status code) and a "body" key (giving the message body returned by the server) |
| ENCODING-CONVERSION-ERROR | the given string could not be converted to the socket's character encoding |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
| hash Qore::HTTPClient::send | ( | *binary | body, |
| string | method, | ||
| *string | path, | ||
| *hash | headers, | ||
| softbool | getbody = False, |
||
| *reference< hash > | info | ||
| ) |
Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format.
If a connection has not already been established, an internal call to HTTPClient::connect() will be made before sending the message
| body | The message body to send; pass NOTHING (no value) to send no body |
| method | The name of the HTTP method ("GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE", "CONNECT", or "PATCH"). Additional methods can be added in the constructor with the a additional_methods option. |
| path | The path for the message (i.e. "/path/resource?method¶m=value") |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| getbody | If this argument is True, then the object will try to receive a message body even if no "Content-Length" header is present in the response. Use this only with broken servers that send message bodies without a "Content-Length" header. |
| info | An optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request; this hash contains the following keys:
|
"body" key and the HTTP status will be assigned to the "status_code" key.| HTTP-CLIENT-METHOD-ERROR | invalid/unknown HTTP method passed |
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received or status error communicating with HTTP server (status code < 100 or > 299); in case of a status error the "arg" key of the exception hash will be set to a hash equal to the normal return value of this method including a "status_code" key (giving the status code) and a "body" key (giving the message body returned by the server) |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
| nothing Qore::HTTPClient::send | ( | Qore::OutputStream | os, |
| *data | body, | ||
| string | method, | ||
| *string | path, | ||
| *hash | headers, | ||
| timeout | timeout_ms = 0, |
||
| softbool | getbody = False, |
||
| *reference< hash > | info, | ||
| *code | rcb | ||
| ) |
Sends an HTTP request with the specified method and optional message body; headers are returned through an optional receive callback and any body received is written to the OutputStream.
This method is useful for receiving data in real time; data are sent to the output stream as soon as they are received. If a connection has not already been established, an internal call to HTTPClient::connect() will be made before sending the message
| os | The OutputStream to write the response body to |
| body | The message body to send; pass NOTHING (no value) to send no body |
| method | The name of the HTTP method ("GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE", "CONNECT", or "PATCH"). Additional methods can be added in the constructor with the a additional_methods option. |
| path | The path for the message (i.e. "/path/resource?method¶m=value") |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| timeout_ms | the timeout in milliseconds for the socket I/O operations; 0 means use the default timeout value |
| getbody | If this argument is True, then the object will try to receive a message body even if no "Content-Length" header is present in the response. Use this only with broken servers that send message bodies without a "Content-Length" header. |
| info | An optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request. |
| rcb | An optional receive callback for message headers received only; header or trailer data is placed in a hash with the following keys:
|
| HTTP-CLIENT-METHOD-ERROR | invalid/unknown HTTP method passed |
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received or status error communicating with HTTP server (status code < 100 or > 299); in case of a status error the "arg" key of the exception hash will be set to a hash equal to the normal return value of this method including a "status_code" key (giving the status code) and a "body" key (giving the message body returned by the server); status errors are not thrown in case a receive callback is used |
| ENCODING-CONVERSION-ERROR | the given string could not be converted to the socket's character encoding |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
| nothing Qore::HTTPClient::sendChunked | ( | Qore::OutputStream | os, |
| Qore::InputStream | is, | ||
| string | method, | ||
| int | max_chunk_size = 4096, |
||
| *string | path, | ||
| *hash | headers, | ||
| timeout | timeout_ms = 0, |
||
| softbool | getbody = False, |
||
| *reference< hash > | info, | ||
| *code | rcb, | ||
| *code | tcb | ||
| ) |
Sends a chunked HTTP request with the specified method and message body; headers are returned through an optional receive callback and any body received is written to the OutputStream.
This method is useful for receiving data in real time; data are sent to the output stream as soon as they are received. If a connection has not already been established, an internal call to HTTPClient::connect() will be made before sending the message
| os | The OutputStream to write the response body to |
| is | The InputStream to read the request body from; each read will be sent as a separate chunk |
| method | The name of the HTTP method ("GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE", "CONNECT", or "PATCH"). Additional methods can be added in the constructor with the a additional_methods option. |
| max_chunk_size | the maximum chunk size as the read block size for the InputStream read block size; the actual size of the data read will determine the size of each HTTP chunk |
| path | The path for the message (i.e. "/path/resource?method¶m=value") |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| timeout_ms | the timeout in milliseconds for the socket I/O operations; 0 means use the default timeout value |
| getbody | If this argument is True, then the object will try to receive a message body even if no "Content-Length" header is present in the response. Use this only with broken servers that send message bodies without a "Content-Length" header. |
| info | An optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request. |
| rcb | An optional receive callback for message headers received only; header or trailer data is placed in a hash with the following keys:
|
| tcb | An optional trailer callback for message trailers to write in the outgoing chunked message; the callback takes no arguments and must return either NOTHING or hash giving a hash of trailers for the final chunk |
| HTTP-CLIENT-METHOD-ERROR | invalid/unknown HTTP method passed |
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received or status error communicating with HTTP server (status code < 100 or > 299); in case of a status error the "arg" key of the exception hash will be set to a hash equal to the normal return value of this method including a "status_code" key (giving the status code) and a "body" key (giving the message body returned by the server); status errors are not thrown in case a receive callback is used |
| HTTP-CHUNK-ERROR | the chunk size given is not greater than 0 |
| HTTP-TRAILER-ERROR | the trailer callback must return either NOTHING or hash; this exception is thrown is another type is returned |
| ENCODING-CONVERSION-ERROR | the given string could not be converted to the socket's character encoding |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
| nothing Qore::HTTPClient::sendWithCallbacks | ( | code | scb, |
| code | rcb, | ||
| string | method, | ||
| *string | path, | ||
| *hash | headers, | ||
| timeout | timeout_ms = 0, |
||
| softbool | getbody = False, |
||
| *reference< hash > | info | ||
| ) |
Sends an HTTP request with the specified method and chunked message body as given by a send callback; headers and any body received are returned through a receive callback.
This method is useful for sending chunked message data where the response is also a sent with chunked transfer encoding; chunks are sent to the receive callback as soon as they are received. If a connection has not already been established, an internal call to HTTPClient::connect() will be made before sending the message
| scb | The callback giving the chunked HTTP data to send; this callback must return either a string or a binary value each time it is called to give the chunked data to send; when all data has been sent, then a hash of message trailers can be sent or simply NOTHING which will close the chunked message |
| rcb | The receive callback for the data received; first this method is called with a hash of the message headers, and then with any message body; if a chunked HTTP message is received, then the callback is called once for each chunk; when the message has been received, then the receive callback is called with a hash representing any trailer data received in a chunked transfer or NOTHING if the data was received in a normal message body or if there was no trailer data in a chunked transfer. The argument to this callback is always a hash; data calls have the following keys:
|
| method | The name of the HTTP method ("GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE", "CONNECT", or "PATCH"). Additional methods can be added in the constructor with the a additional_methods option. |
| path | The path for the message (i.e. "/path/resource?method¶m=value") |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| timeout_ms | the timeout in milliseconds for the socket I/O operations; 0 means use the default timeout value |
| getbody | If this argument is True, then the object will try to receive a message body even if no "Content-Length" header is present in the response. Use this only with broken servers that send message bodies without a "Content-Length" header. |
| info | An optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request; this hash contains the following keys:
|
| HTTP-CLIENT-METHOD-ERROR | invalid/unknown HTTP method passed |
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received or status error communicating with HTTP server (status code < 100 or > 299); in case of a status error the "arg" key of the exception hash will be set to a hash equal to the normal return value of this method including a "status_code" key (giving the status code) and a "body" key (giving the message body returned by the server) |
| ENCODING-CONVERSION-ERROR | the given string could not be converted to the socket's character encoding |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
"Transfer-Encoding: chunked" header is automatically set with this method if no "Transfer-Encoding" header is already presentsend_aborted flag is set in the argument to rcb | nothing Qore::HTTPClient::sendWithRecvCallback | ( | code | rcb, |
| string | body, | ||
| string | method, | ||
| *string | path, | ||
| *hash | headers, | ||
| timeout | timeout_ms = 0, |
||
| softbool | getbody = False, |
||
| *reference< hash > | info | ||
| ) |
Sends an HTTP request with the specified method and optional message body; headers and any body received are returned through a receive callback.
This method is useful for receiving chunked message data in real time; chunks are sent to the receive callback as soon as they are received. If a connection has not already been established, an internal call to HTTPClient::connect() will be made before sending the message
| rcb | The receive callback for the data received; first this method is called with a hash of the message headers, and then with any message body; if a chunked HTTP message is received, then the callback is called once for each chunk; when the message has been received, then the receive callback is called with a hash representing any trailer data received in a chunked transfer or NOTHING if the data was received in a normal message body or if there was no trailer data in a chunked transfer. The argument to this callback is always a hash; data calls have the following keys:
|
| body | The message body to send |
| method | The name of the HTTP method ("GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE", "CONNECT", or "PATCH"). Additional methods can be added in the constructor with the a additional_methods option. |
| path | The path for the message (i.e. "/path/resource?method¶m=value") |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| timeout_ms | the timeout in milliseconds for the socket I/O operations; 0 means use the default timeout value |
| getbody | If this argument is True, then the object will try to receive a message body even if no "Content-Length" header is present in the response. Use this only with broken servers that send message bodies without a "Content-Length" header. |
| info | An optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request; this hash contains the following keys:
|
| HTTP-CLIENT-METHOD-ERROR | invalid/unknown HTTP method passed |
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received |
| ENCODING-CONVERSION-ERROR | the given string could not be converted to the socket's character encoding |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
| nothing Qore::HTTPClient::sendWithRecvCallback | ( | code | rcb, |
| *binary | body, | ||
| string | method, | ||
| *string | path, | ||
| *hash | headers, | ||
| timeout | timeout_ms = 0, |
||
| softbool | getbody = False, |
||
| *reference< hash > | info | ||
| ) |
Sends an HTTP request with the specified method and optional message body; headers and any body received are returned through a receive callback.
This method is useful for receiving chunked message data in real time; chunks are sent to the receive callback as soon as they are received. If a connection has not already been established, an internal call to HTTPClient::connect() will be made before sending the message
| rcb | The receive callback for the data received; first this method is called with a hash of the message headers, and then with any message body; if a chunked HTTP message is received, then the callback is called once for each chunk; when the message has been received, then the receive callback is called with a hash representing any trailer data received in a chunked transfer or NOTHING if the data was received in a normal message body or if there was no trailer data in a chunked transfer. The argument to this callback is always a hash; data calls have the following keys:
|
| body | The message body to send; pass NOTHING (no value) to send no body |
| method | The name of the HTTP method ("GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE", "CONNECT", or "PATCH"). Additional methods can be added in the constructor with the a additional_methods option. |
| path | The path for the message (i.e. "/path/resource?method¶m=value") |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| timeout_ms | the timeout in milliseconds for the socket I/O operations; 0 means use the default timeout value |
| getbody | If this argument is True, then the object will try to receive a message body even if no "Content-Length" header is present in the response. Use this only with broken servers that send message bodies without a "Content-Length" header. |
| info | An optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request; this hash contains the following keys:
|
| HTTP-CLIENT-METHOD-ERROR | invalid/unknown HTTP method passed |
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received |
| ENCODING-CONVERSION-ERROR | the given string could not be converted to the socket's character encoding |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
| hash Qore::HTTPClient::sendWithSendCallback | ( | code | scb, |
| string | method, | ||
| *string | path, | ||
| *hash | headers, | ||
| timeout | timeout_ms = 0, |
||
| softbool | getbody = False, |
||
| *reference< hash > | info | ||
| ) |
Sends an HTTP request with the specified method and chunked message body as given by a send callback and returns headers and any body received as a response in a hash format.
If a connection has not already been established, an internal call to HTTPClient::connect() will be made before sending the message
| scb | The callback giving the chunked HTTP data to send; this callback must return either a string or a binary value each time it is called to give the chunked data to send; when all data has been sent, then a hash of message trailers can be sent or simply NOTHING which will close the chunked message |
| method | The name of the HTTP method ("GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "TRACE", "CONNECT", or "PATCH"). Additional methods can be added in the constructor with the a additional_methods option. |
| path | The path for the message (i.e. "/path/resource?method¶m=value") |
| headers | An optional hash of headers to include in the message; values are converted to strings; a list is converted to a string of comma-separated values; headers that differ only in case will be overwritten by the last header in the hash with a matching name with a case-insensitive search |
| timeout_ms | the timeout in milliseconds for the socket I/O operations; 0 means use the default timeout value |
| getbody | If this argument is True, then the object will try to receive a message body even if no "Content-Length" header is present in the response. Use this only with broken servers that send message bodies without a "Content-Length" header. |
| info | An optional reference to an lvalue that will be used as an output variable giving a hash of request headers and other information about the HTTP request; this hash contains the following keys:
|
"body" key and the HTTP status will be assigned to the "status_code" key.| HTTP-CLIENT-METHOD-ERROR | invalid/unknown HTTP method passed |
| HTTP-CLIENT-REDIRECT-ERROR | invalid redirect location given by remote |
| HTTP-CLIENT-MAXIMUM-REDIRECTS-EXCEEDED | maximum redirect count exceeded |
| HTTP-CLIENT-RECEIVE-ERROR | unknown content encoding received or status error communicating with HTTP server (status code < 100 or > 299); in case of a status error the "arg" key of the exception hash will be set to a hash equal to the normal return value of this method including a "status_code" key (giving the status code) and a "body" key (giving the message body returned by the server) |
| ENCODING-CONVERSION-ERROR | the given string could not be converted to the socket's character encoding |
| SOCKET-SEND-ERROR | There was an error sending the data |
| SOCKET-CLOSED | The remote end closed the connection |
| SOCKET-RECV-ERROR | There was an error receiving the data |
| SOCKET-TIMEOUT | Data transmission or reception for a single send() or recv() action exceeded the timeout period |
| SOCKET-SSL-ERROR | There was an SSL error while reading data from the socket |
| SOCKET-HTTP-ERROR | Invalid HTTP data was received |
"Transfer-Encoding: chunked" header is automatically set with this method if no "Transfer-Encoding" header is already present| nothing Qore::HTTPClient::setConnectTimeout | ( | timeout | timeout_ms = -1 | ) |
Sets the connect timeout in milliseconds.
| timeout_ms | the connect timeout in milliseconds; negative numbers mean use the default system connect timeout. Note that like all Qore functions and methods taking timeout values, a relative date/time value can be used to make the units clear (i.e. 30s = 30 seconds, etc.). |
| nothing Qore::HTTPClient::setDefaultPath | ( | *string | path | ) |
Sets the default path used by the object if no path is set in the URL.
| path | the default path value to set or if NOTHING then clears the path |
| nothing Qore::HTTPClient::setEncoding | ( | string | encoding | ) |
Sets the string encoding for the object; any strings deserialized with this object will be tagged with this character encoding.
| encoding | the string encoding for the object; any strings deserialized with this object will be tagged with this character encoding |
| nothing Qore::HTTPClient::setEventQueue | ( | ) |
Clears any Queue object that may be set on the HTTPClient object so that I/O events are no longer captured on the object.
| nothing Qore::HTTPClient::setEventQueue | ( | Qore::Thread::Queue | queue | ) |
Sets a Queue object to receive HTTPClient and Socket events.
| queue | a Queue object to receive HTTPClient and Socket events; note that the Queue passed cannot have any maximum size set or a QUEUE-ERROR will be thrown |
| QUEUE-ERROR | the Queue passed has a maximum size set |
| nothing Qore::HTTPClient::setHTTPVersion | ( | string | ver | ) |
Sets the HTTP protocol version string for headers in outgoing messages, allowed values are "1.0" and "1.1".
| ver | "1.0" or "1.1" for the HTTP protocol compliance version |
| HTTP-VERSION-ERROR | invalid HTTP version passed (allowed values: "1.0" and "1.1") |
| nothing Qore::HTTPClient::setMaxRedirects | ( | softint | mr = 0 | ) |
Updates the setting for the max_redirects value for the object (maximum number of HTTP redirects that will be processed before an exception is raised)
| mr | the setting for the maximum number of HTTP redirects that will be processed before an exception is raised |
Sets the TCP_NODELAY setting for the object.
When this setting is True, then data will be immediately sent out over the HTTPClient object's socket, when it is False, then data transmission may be delayed to be packaged with other data for the same target.
Delayed data transmissions may cause problems when the sender immediately closes the socket after sending data; in this case the receiver may not get the data even though the send succeeded.
Note that if no value is given to the method, the argument will be assumed to be True, and output buffering will be turned off for the HTTPClient object.
If the socket is not connected when this call is made, then an internal flag is set and the TCP_NODELAY option is enabled when the next connection is established. If the socket is connected, then if an error occurs setting the TCP_NODELAY option on the socket, this method will return a non-zero error code; the actual error can be checked with the errno() function.
| b | the TCP_NODELAY setting for the object |
| Qore::HTTPClient::setPersistent | ( | ) |
temporarily disables implicit reconnections; must be called when the server is already connected
The persistent flag is automatically reset to False whenever the connection is closed; it must be called manually for every connection to turn off implicit reconnections.
To turn off the persistent flag manually, call HTTPClient::disconnect()
| nothing Qore::HTTPClient::setProxySecure | ( | softbool | b = True | ) |
Sets the SSL/TLS flag for the next connection to the proxy.
| nothing Qore::HTTPClient::setProxyURL | ( | ) |
Clears the new proxy URL value for the next connection.
This variant of the method is equivalent to HTTPClient::clearProxyURL()
| nothing Qore::HTTPClient::setProxyURL | ( | string | url | ) |
Sets a new proxy URL value for the next connection.
| url | the new proxy URL value for the next connection |
| HTTP-CLIENT-URL-ERROR | invalid proxy URL string; invalid authorization credentials in proxy URL (username without password or vice-versa) |
| HTTP-CLIENT-PROXY-PROTOCOL-ERROR | unknown protocol passed in URL |
scheme://socket=url_encoded_path/path, where url_encoded_path is a path with URL-encoding as performed by encode_url(string, True); for example: "http://socket=%2ftmp%socket-dir%2fsocket-file-1/url/path"; this allows a filesystem path to be used in the host portion of the URL and for the URL to include a URL path as well. Sets the username and password for the connection to the proxy; call after HTTPClient::setProxyURL()
Call this method after calling HTTPClient::setProxyURL() to set proxy authentication information when not present in the URL used in HTTPClient::setProxyURL()
| user | the username to use for proxy authentication in the next HTTP connection |
| pass | the password to use for proxy authentication in the next HTTP connection |
| nothing Qore::HTTPClient::setProxyUserPassword | ( | ) |
Clears the username and password for the next proxy connection.
Call this method after calling HTTPClient::setProxyURL() to clear any proxy authentication information present in the URL used in HTTPClient::setProxyURL()
This variant of the method is equivalent to HTTPClient::clearProxyUserPassword()
| nothing Qore::HTTPClient::setSecure | ( | softbool | secure = True | ) |
Sets the object to make a secure SSL/TLS connection on the next connect if the passed argument is True, or an unencrypted cleartext connection if it is False.
This method overrides the default behaviour for the protocol set for the object
Note that the behavior of this method when called with no argument changed in version 0.8.0; prior to version 0.8.0 calling this method with no argument would turn off secure mode; the behavior was changed to the current functionality in order to make the usage of this method consistent with other methods of the same name and to make it more logical.
| nothing Qore::HTTPClient::setTimeout | ( | timeout | timeout_ms = 0 | ) |
Sets the default I/O timeout value in milliseconds.
| timeout_ms | 0 means immediate timeout (when reading will return data only if it is already available), and negative numbers mean never timeout. Note that like all Qore functions and methods taking timeout values, a relative date/time value can be used to make the units clear (i.e. 2m = two minutes, etc.). |
| Qore::HTTPClient::setURL | ( | string | url | ) |
Sets a new URL value for the next connection.
To retrieve the current URL value, use the HTTPClient::getURL() method
| url | the new URL for the object |
| HTTP-CLIENT-URL-ERROR | invalid URL string; invalid authorization credentials in URL (username without password or vice-versa) |
| HTTP-CLIENT-UNKNOWN-PROTOCOL | unknown protocol (scheme) passed in URL |
scheme://socket=url_encoded_path/path, where url_encoded_path is a path with URL-encoding as performed by encode_url(string, True); for example: "http://socket=%2ftmp%socket-dir%2fsocket-file-1/url/path"; this allows a filesystem path to be used in the host portion of the URL and for the URL to include a URL path as well. Sets the username and password for the connection; call after HTTPClient::setURL()
Call this method after calling HTTPClient::setURL() to set authentication information when not present in the URL used in HTTPClient::setURL()
| user | the username to use for authentication in the next HTTP connection |
| pass | the password to use for authentication in the next HTTP connection |
| nothing Qore::HTTPClient::setUserPassword | ( | ) |
Clears the username and password for the connection.
Call this method after calling HTTPClient::setURL() to clear any authentication information present in the URL used in HTTPClient::setURL()
This variant of the method is equivalent to HTTPClient::clearUserPassword()
| nothing Qore::HTTPClient::setWarningQueue | ( | int | warning_ms, |
| int | warning_bs, | ||
| Queue | queue, | ||
| auto | arg, | ||
| timeout | min_ms = 1s |
||
| ) |
Sets a Queue object to receive socket warnings.
| warning_ms | the threshold in milliseconds for individual socket actions (send, receive, connect), if exceeded, a socket warning is placed on the warning queue with the following keys:
|
| warning_bs | value in bytes per second; if any call has performance below this threshold, a socket warning is placed on the warning queue with the following keys:
|
| queue | the Queue object to receive warning events |
| arg | an optional argument to be placed in the "arg" key in each warning hash (could be used to identify the socket for example) |
| min_ms | the minimum transfer time with a resolution of milliseconds for a transfer to be eligible for triggering a warning; transfers that take less than this period of time are not eligible for raising a warning |
| QUEUE-ERROR | the Queue passed has a maximum size set |
| SOCKET-SETWARNINGQUEUE-ERROR | at least one of warning_ms and warning_bs must be > 0 |