Creates the HTTPClient object based on the parameters passed. To connect, call any method that requires a connection and an implicit connection is established, or call HTTPClient::connect().

HTTPClient::constructor()

HTTPClient::constructor(hash$opts)

my HTTPClient $httpclient(("url":"http://hostname:8080/path"));

Destroys the HTTPClient object and closes any open connections.

delete $httpclient;

EVENT_CHANNEL_CLOSED, EVENT_DELETED

Copying objects of this class is not supported, an exception will be thrown.

Returns the current URL value for the object. To set the URL, use the HTTPClient::setURL() method.

stringHTTPClient::getURL()

$url = $httpclient.getURL();

Sets the URL value for the object. To retrieve the current URL value, use the HTTPClient::getURL() method.

nothingHTTPClient::setURL(string$url)

$httpclient.setURL("https://user:password@hostname:8080/path");

Sets or clears (in case called with no arguments) the username and password for the proxy connection; note that HTTPClient::setURL() will overwrite any values set here.

nothingHTTPClient::setUserPassword(string$user, string$pass)

nothingHTTPClient::setUserPassword()

$httpclient.setUserPassword("user1", "password1");

Clears the proxy username and password values; normally called after HTTPClient::setURL().

nothingHTTPClient::clearUserPassword()

$httpclient.clearUserPassword();

Returns the current proxy URL value for the object (NOTHING if no proxy URL is set). To set the proxy URL, use the HTTPClient::setProxyURL() method.

*stringHTTPClient::getProxyURL()

my *string $proxy_url = $httpclient.getProxyURL();

Sets the proxy URL value for the object; call with no argument or NOTHING to clear. To retrieve the current URL value, use the HTTPClient::getProxyURL() method.

nothingHTTPClient::setProxyURL()

nothingHTTPClient::setProxyURL(string$url)

$httpclient.setProxyURL("http://user:password@proxy_host:8080/path");

Clears the current proxy URL

nothingHTTPClient::clearProxyURL()

$httpclient.clearProxyURL();

Sets or clears (in case called with no arguments) the username and password for the proxy connection; call after HTTPClient::setProxyURL() because HTTPClient::setProxyURL() will overwrite any values set here.

nothingHTTPClient::setProxyUserPassword(string$user, string$pass)

nothingHTTPClient::setProxyUserPassword()

$httpclient.setProxyUserPassword("user1", "password1");

Clears the proxy username and password values; normally called after HTTPClient::setProxyURL().

nothingHTTPClient::clearProxyUserPassword()

$httpclient.clearProxyUserPassword();

Sets the SSL/TLS flag for the next proxy connection. To check the flag, use the HTTPClient::isProxySecure() method.

nothingHTTPClient::setProxySecure(softbool$secure = True)

$httpclient.setProxySecure(True);

Returns the SSL/TLS flag for proxy connection. To set the flag, use the HTTPClient::setProxySecure() method.

boolHTTPClient::isProxySecure()

$bool = $httpclient.isProxySecure();

Returns the maximum number of redirects allowed for the object. To set this value, use the HTTPClient::setMaxRedirects() method.

intHTTPClient::getMaxRedirects()

$num = $httpclient.getMaxRedirects();

Sets the maximum number of redirects allowed for the object. To retrieve this value, use the HTTPClient::getMaxRedirects() method.

nothingHTTPClient::setMaxRedirects(softint$max = 0)

$httpclient.setMaxRedirects(0); # disable redirections

Connects to the remote socket. If the protocol indicates that a secure connection should be established (or HTTPClient::setSecure() was called previsouly), SSL/TLS negotiation will be attempted. Note: For possible exceptions, see the Socket::connect() method (or Socket::connectSSL() for secure connections).

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().

nothingHTTPClient::connect()

$httpclient.connect();

EVENT_CONNECTING, EVENT_CONNECTED,EVENT_HOSTNAME_LOOKUP, EVENT_HOSTNAME_RESOLVED, EVENT_START_SSL, EVENT_SSL_ESTABLISHED

Disconnects from the remote socket if a connection is established (otherwise does nothing).

nothingHTTPClient::disconnect()

$httpclient.disconnect();

EVENT_CHANNEL_CLOSED

Sends an HTTP GET request and returns the message body received as a string. In order to get the headers and the body, use the HTTPClient::send() method instead. If necessary, a connection will be established via an implicit call to HTTPClient::connect() before sending the message.

If any content encoding is used, then the content is decoded and returned a string; if the content encoding uses an unknown method, then an exception is thrown.

*stringHTTPClient::get(string$path, hash $headers = hash(), reference$info)

*stringHTTPClient::get(string$path, hash $headers = hash())

my *string $html = $httpclient.get("/path/file.html");

EVENT_CONNECTING, EVENT_CONNECTED, EVENT_HOSTNAME_LOOKUP, EVENT_HOSTNAME_RESOLVED, EVENT_START_SSL, EVENT_SSL_ESTABLISHED, EVENT_HTTP_SEND_MESSAGE, EVENT_PACKET_SENT, EVENT_HTTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_HTTP_CONTENT_LENGTH, EVENT_HTTP_CHUNKED_START, EVENT_HTTP_CHUNKED_END, EVENT_HTTP_CHUNKED_DATA_RECEIVED, EVENT_HTTP_CHUNK_SIZE, EVENT_HTTP_FOOTERS_RECEIVED, EVENT_HTTP_REDIRECT

Sends an HTTP HEAD request and returns the headers received. If necessary, a connection will be established via an implicit call to HTTPClient::connect() before sending the message.

hashHTTPClient::head(string$path, hash$headers = hash(), reference$info)

hashHTTPClient::head(string$path, hash$headers = hash())

$response = $httpclient.head("/path");

EVENT_CONNECTING, EVENT_CONNECTED, EVENT_HOSTNAME_LOOKUP, EVENT_HOSTNAME_RESOLVED, EVENT_START_SSL, EVENT_SSL_ESTABLISHED, EVENT_HTTP_SEND_MESSAGE, EVENT_PACKET_SENT, EVENT_HTTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_HTTP_CONTENT_LENGTH, EVENT_HTTP_CHUNKED_START, EVENT_HTTP_CHUNKED_END, EVENT_HTTP_CHUNKED_DATA_RECEIVED, EVENT_HTTP_CHUNK_SIZE, EVENT_HTTP_FOOTERS_RECEIVED, EVENT_HTTP_REDIRECT

Sends an HTTP POST request with a message body and returns the message body received as a response. In order to get the headers and the body, use HTTPClient::send() instead. If necessary, a connection will be established via an implicit call to HTTPClient::connect() before sending the message.

*stringHTTPClient::post(string$path, data$body, hash$headers = hash(), reference$info)

*stringHTTPClient::post(string$path, data$body, hash$headers = hash())

Sends an HTTP request with the specified method and optional message body and returns headers and optionally the body received as a response in a hash format. If necessary, a connection will be established via an implicit call to HTTPClient::connect() before sending the message.

hashHTTPClient::send(data$body = binary(), string$method, string$path = "", hash $headers = hash(), bool$getbody = False, reference$info)

hashHTTPClient::send(data$body = binary(), string$method, string$path = "", hash $headers = hash(), bool$getbody = False)

$msg = $httpclient.send($body, "POST", "/path", ("Connection":"Keep-Alive"));

EVENT_CONNECTING, EVENT_CONNECTED, EVENT_HOSTNAME_LOOKUP, EVENT_HOSTNAME_RESOLVED, EVENT_START_SSL, EVENT_SSL_ESTABLISHED, EVENT_HTTP_SEND_MESSAGE, EVENT_PACKET_SENT, EVENT_HTTP_MESSAGE_RECEIVED, EVENT_PACKET_READ, EVENT_HTTP_CONTENT_LENGTH, EVENT_HTTP_CHUNKED_START, EVENT_HTTP_CHUNKED_END, EVENT_HTTP_CHUNKED_DATA_RECEIVED, EVENT_HTTP_CHUNK_SIZE, EVENT_HTTP_FOOTERS_RECEIVED, EVENT_HTTP_REDIRECT

Sets the default connect timeout in milliseconds. Negative numbers mean use the default system 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.).

nothingHTTPClient::setConnectTimeout(timeout$timeout_ms = -1)

$httpclient.setConnectTimeout(2m); # sets timeout to 2 minutes

Sets the default read timeout in milliseconds. Zero means immediate timeout (will return data only if it is already available), and negative numbers mean never timeout (wait forever for data). 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.).

nothingHTTPClient::setTimeout(timeout$timeout_ms = -1)

$httpclient.setTimeout(2m); # sets timeout to 2 minutes

Returns the connect timeout as an integer in milliseconds. Negative numbers mean the default system timeout is used instead.

intHTTPClient::getConnectTimeout()

$timeout = $httpclient.getConnectTimeout();

Returns the default read timeout as an integer in milliseconds. Zero means immediate timeout (only returns data if it is already available), and negative numbers mean never timeout (wait forever for data).

intHTTPClient::getTimeout()

$timeout = $httpclient.getTimeout();

Sets the HTTP protocol version string for headers in outgoing messages, allowed values are '1.0' and '1.1'.

nothingHTTPClient::setHTTPVersion(string$ver)

$httpclient.setHTTPVersion("1.1");

Returns the HTTP protocol version string used in outgoing messages.

stringHTTPClient::getHTTPVersion()

$version = $httpclient.getHTTPVersion();

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.

nothingHTTPClient::setSecure(softbool$secure = True)

$httpclient.setSecure(True);

Returns True if the current connection is encrypted, False if not.

boolHTTPClient::isSecure()

$bool = $httpclient.isSecure();

Returns a string code giving the result of verifying the remote certificate or NOTHING if an encrypted connection is not established. Return value are the keys described in the X509_VerificationReasons hash constant. This hash can also be used to generate a textual description of the verification result.

*stringHTTPClient::verifyPeerCertificate()

my *string $str = $httpclient.verifyPeerCertificate();

Returns the name of the cipher for an encrypted connection.

*stringHTTPClient::getSSLCipherName()

my *string $str = $httpclient.getSSLCipherName();

Returns the version of the cipher for an encrypted connection.

*stringHTTPClient::getSSLCipherVersion()

my *string $str = $httpclient.getSSLCipherVersion();

Sets the string encoding for the object; any strings deserialized with this object will be tagged with this character encoding.

nothingHTTPClient::setEncoding(string$encoding)

$httpclient.setEncoding("ISO-8859-1");

Returns the character encoding used for the object

stringHTTPClient::getEncoding()

$str = $httpclient.getEncoding();

Sets a Queue object to receive HTTPClient and Socket events. To remove the event queue and stop monitoring events, pass NOTHING to the method. See Event Handling for more information.

nothingHTTPClient::setEventQueue()

nothingHTTPClient::setEventQueue(Queue$queue)

$httpclient.setEventQueue($queue);

Returns the TCP_NODELAY setting for the HTTPClient object. See also HTTPClient::setNoDelay().

boolHTTPClient::getNoDelay()

$nodelay = $httpclient.getNoDelay();

Sets the TCP_NODELAY setting for the HTTPClient 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.

See also HTTPClient::getNoDelay().

intHTTPClient::setNoDelay(softbool$nodelay = True)

$httpclient.setNoDelay(True);

Returns the connection state of the HTTPClient object. Connections are implicitly established whenever a method is callde requiring a connection; to explicitly establish a connection, see HTTPClient::connect().

boolHTTPClient::isConnected()

my bool $connected = $httpclient.isConnected();