Qore Programming Language Reference Manual  1.2.0
QC_HTTPClient.dox.h
1 
3 namespace Qore {
5 
199 class HTTPClient : public Socket {
200 
201 public:
203 
209 nothing addDefaultHeaders(hash<auto> hdr);
210 
211 public:
213 
218 nothing clearProxyURL();
219 
220 public:
222 
230 
231 public:
233 
243 
244 public:
246 
254 
255 public:
257 
267 
268 public:
270 
284 nothing connect();
285 
286 public:
288 
352  constructor(hash<auto> opts);
353 
354 public:
356 
362 
363 public:
365 
367  copy();
368 
369 public:
371 
377 
378 public:
380 
385 nothing disconnect();
386 
387 public:
389 
443 *string get(string path, *hash<auto> headers, *reference<hash<auto>> info);
444 
445 public:
447 
461 
462 public:
464 
475 
476 public:
478 
491 
492 public:
494 
503 hash<string,string> getDefaultHeaders();
504 
505 public:
507 
517 string getDefaultPath();
518 
519 public:
521 
531 string getEncoding();
532 
533 public:
535 
551 
552 public:
554 
571 
572 public:
574 
584 string getHTTPVersion();
585 
586 public:
588 
601 
602 public:
604 
615 
616 public:
618 
628 bool getNoDelay();
629 
630 public:
632 
642 *string getProxyURL();
643 
644 public:
646 
661 
662 public:
664 
675 
676 public:
678 
688 *string getURL();
689 
690 public:
692 
713 hash<auto> getUsageInfo();
714 
715 public:
717 
765 hash<auto> head(string path, *hash<auto> headers, *reference<hash<auto>> info);
766 
767 public:
769 
779 bool isConnected();
780 
781 public:
783 
794 
795 public:
797 
808 bool isSecure();
809 
810 public:
812 
864 *string post(string path, string body, *hash<auto> headers, *reference<hash<auto>> info);
865 
866 public:
868 
919 *string post(string path, *binary body, *hash<auto> headers, *reference<hash<auto>> info);
920 
921 public:
923 
975 hash<auto> send(string body, string method, *string path, *hash<auto> headers, softbool getbody = False, *reference<hash<auto>> info);
976 
977 public:
979 
1030 hash<auto> send(*binary body, string method, *string path, *hash<auto> headers, softbool getbody = False, *reference<hash<auto>> info);
1031 
1032 public:
1034 
1089 nothing send(Qore::OutputStream os, *data body, string method, *string path, *hash<auto> headers, timeout timeout_ms = 0, softbool getbody = False, *reference<hash<auto>> info, *code rcb);
1090 
1091 public:
1093 
1157 nothing sendChunked(Qore::OutputStream os, Qore::InputStream is, string method, int max_chunk_size = 4096, *string path, *hash<auto> headers, timeout timeout_ms = 0, softbool getbody = False, *reference<hash<auto>> info, *code rcb, *code tcb);
1158 
1159 public:
1161 
1227 nothing sendWithCallbacks(code scb, code rcb, string method, *string path, *hash<auto> headers, timeout timeout_ms = 0, softbool getbody = False, *reference<hash<auto>> info);
1228 
1229 public:
1231 
1293 nothing sendWithRecvCallback(code rcb, string body, string method, *string path, *hash<auto> headers, timeout timeout_ms = 0, softbool getbody = False, *reference<hash<auto>> info);
1294 
1295 public:
1297 
1357 nothing sendWithRecvCallback(code rcb, *binary body, string method, *string path, *hash<auto> headers, timeout timeout_ms = 0, softbool getbody = False, *reference<hash<auto>> info);
1358 
1359 public:
1361 
1418 hash<auto> sendWithSendCallback(code scb, string method, *string path, *hash<auto> headers, timeout timeout_ms = 0, softbool getbody = False, *reference<hash> info);
1419 
1420 public:
1422 
1431  setAssumedEncoding(*string encoding);
1432 
1433 public:
1435 
1442 nothing setConnectTimeout(timeout timeout_ms = -1);
1443 
1444 public:
1446 
1455  setConnectionPath(*string uri_path);
1456 
1457 public:
1459 
1466 nothing setDefaultPath(*string path);
1467 
1468 public:
1470 
1477 nothing setEncoding(string encoding);
1478 
1479 public:
1481 
1496 bool setEncodingPassthru(bool set = True);
1497 
1498 public:
1500 
1517 bool setErrorPassthru(bool set = True);
1518 
1519 public:
1521 
1526 nothing setEventQueue();
1527 
1528 public:
1530 
1545 nothing setEventQueue(Qore::Thread::Queue queue, auto arg, *bool with_data);
1546 
1547 public:
1549 
1558 nothing setHTTPVersion(string ver);
1559 
1560 public:
1562 
1571 nothing setMaxRedirects(softint mr = 0);
1572 
1573 public:
1575 
1592 int setNoDelay(softbool b = True);
1593 
1594 public:
1596 
1609 
1610 public:
1612 
1619 nothing setProxySecure(softbool b = True);
1620 
1621 public:
1623 
1630 nothing setProxyURL();
1631 
1632 public:
1634 
1646 nothing setProxyURL(string url);
1647 
1648 public:
1650 
1660 nothing setProxyUserPassword(string user, string pass);
1661 
1662 public:
1664 
1676 
1677 public:
1679 
1692 bool setRedirectPassthru(bool set = True);
1693 
1694 public:
1696 
1707 nothing setSecure(softbool secure = True);
1708 
1709 public:
1711 
1718 nothing setTimeout(timeout timeout_ms = 0);
1719 
1720 public:
1722 
1738  setURL(string url);
1739 
1740 public:
1742 
1752 nothing setUserPassword(string user, string pass);
1753 
1754 public:
1756 
1768 
1769 public:
1771 
1803 nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, auto arg, timeout min_ms = 1s);
1804 };
1805 }
The HTTPClient class can be used to communicate with HTTP servers with and without TLS/SSL encryption...
Definition: QC_HTTPClient.dox.h:199
string getHostHeaderValue()
returns the Host header value for this object
bool getEncodingPassthru()
get the encoding passthru status
bool isProxySecure()
Returns the SSL/TLS flag for the next proxy connection.
nothing setHTTPVersion(string ver)
Sets the HTTP protocol version string for headers in outgoing messages, allowed values are "1....
bool setErrorPassthru(bool set=True)
set the error passthru status
constructor()
Creates the HTTPClient object.
*string getConnectionPath()
Returns the current connection path set in the URL.
nothing setProxyURL(string url)
Sets a new proxy URL value for the next connection.
string getDefaultPath()
Returns the default path used by the object if no path is set in the URL.
nothing sendChunked(Qore::OutputStream os, Qore::InputStream is, string method, int max_chunk_size=4096, *string path, *hash< auto > headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash< auto >> info, *code rcb, *code tcb)
Sends a chunked HTTP request with the specified method and message body; headers are returned through...
setPersistent()
temporarily disables implicit reconnections; must be called when the server is already connected
*string getProxyURL()
Returns the current proxy URL as a string or NOTHING if no proxy URL is set.
nothing sendWithRecvCallback(code rcb, string body, string method, *string path, *hash< auto > headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash< auto >> info)
Sends an HTTP request with the specified method and optional message body; headers and any body recei...
bool getNoDelay()
Returns the TCP_NODELAY setting for the HTTPClient object.
nothing clearWarningQueue()
Removes any warning Queue object from the Socket.
nothing sendWithRecvCallback(code rcb, *binary body, string method, *string path, *hash< auto > headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash< auto >> info)
Sends an HTTP request with the specified method and optional message body; headers and any body recei...
string getHTTPVersion()
Returns the HTTP protocol version string used in outgoing messages.
bool setEncodingPassthru(bool set=True)
set the encoding passthru status
bool isSecure()
Returns True if the current connection is encrypted, False if not.
nothing setConnectTimeout(timeout timeout_ms=-1)
Sets the connect timeout in milliseconds.
string getAssumedEncoding()
returns the assumed character encoding for messages from the HTTP server without any charset indicato...
nothing setSecure(softbool secure=True)
Sets the object to make a secure SSL/TLS connection on the next connect if the passed argument is Tru...
hash< auto > send(string body, string method, *string path, *hash< auto > headers, softbool getbody=False, *reference< hash< auto >> info)
Sends an HTTP request with the specified method and optional message body and returns headers and any...
clearStats()
Clears performance statistics.
hash< auto > send(*binary body, string method, *string path, *hash< auto > headers, softbool getbody=False, *reference< hash< auto >> info)
Sends an HTTP request with the specified method and optional message body and returns headers and any...
bool getErrorPassthru()
get the error passthru status
nothing connect()
Connects to the remote socket; SSL/TLS negotiation is performed if required.
int getConnectTimeout()
Returns the connect timeout as an integer in milliseconds.
setURL(string url)
Sets a new URL value for the next connection.
nothing setEncoding(string encoding)
Sets the string encoding for the object; any strings deserialized with this object will be tagged wit...
nothing setDefaultPath(*string path)
Sets the default path used by the object if no path is set in the URL.
*string post(string path, *binary body, *hash< auto > headers, *reference< hash< auto >> info)
Sends an HTTP POST request with a message body and returns the message body received as a string or N...
string getEncoding()
Returns the character encoding used for the object.
nothing clearUserPassword()
Clears the username and password for the connection.
nothing send(Qore::OutputStream os, *data body, string method, *string path, *hash< auto > headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash< auto >> info, *code rcb)
Sends an HTTP request with the specified method and optional message body; headers are returned throu...
*string getURL()
Returns the current URL.
setConnectionPath(*string uri_path)
Overrides any connection path set in the URL.
nothing sendWithCallbacks(code scb, code rcb, string method, *string path, *hash< auto > headers, timeout timeout_ms=0, softbool getbody=False, *reference< hash< auto >> info)
Sends an HTTP request with the specified method and chunked message body as given by a send callback;...
nothing setUserPassword(string user, string pass)
Sets the username and password for the connection; call after HTTPClient::setURL()
copy()
Copying objects of this class is not supported, an exception will be thrown.
hash< auto > head(string path, *hash< auto > headers, *reference< hash< auto >> info)
Sends an HTTP HEAD request and returns as hash of the headers received.
constructor(hash< auto > opts)
Creates the HTTPClient object based on the option parameter passed.
nothing setUserPassword()
Clears the username and password for the connection.
nothing setEventQueue(Qore::Thread::Queue queue, auto arg, *bool with_data)
Sets a Queue object to receive HTTPClient and Socket events.
*string post(string path, string body, *hash< auto > headers, *reference< hash< auto >> info)
Sends an HTTP POST request with a message body and returns the message body received as a string or N...
*string get(string path, *hash< auto > headers, *reference< hash< auto >> info)
Sends an HTTP GET request and returns the message body received as a string or NOTHING if no message ...
hash< auto > sendWithSendCallback(code scb, string method, *string path, *hash< auto > 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 ...
nothing addDefaultHeaders(hash< auto > hdr)
Sets headers to send by default with every outgoing request.
nothing clearProxyUserPassword()
Clears the username and password for the next proxy connection.
nothing clearProxyURL()
Clears the new proxy URL value for the next connection.
int getTimeout()
Returns the default I/O timeout as an integer in milliseconds.
destructor()
Destroys the HTTPClient object and closes any open connections.
bool isConnected()
Returns True or False giving the current connection state.
bool getRedirectPassthru()
get the redirect passthru status
nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, auto arg, timeout min_ms=1s)
Sets a Queue object to receive socket warnings.
nothing setProxySecure(softbool b=True)
Sets the SSL/TLS flag for the next connection to the proxy.
int setNoDelay(softbool b=True)
Sets the TCP_NODELAY setting for the object.
hash< auto > getUsageInfo()
Returns performance statistics for the socket.
nothing setMaxRedirects(softint mr=0)
Updates the setting for the max_redirects value for the object (maximum number of HTTP redirects that...
nothing disconnect()
Disconnects from the remote socket if a connection is established (otherwise does nothing)
setAssumedEncoding(*string encoding)
sets the assumed character encoding for messages from the HTTP server without any charset indicator
nothing setProxyURL()
Clears the new proxy URL value for the next connection.
bool setRedirectPassthru(bool set=True)
set the redirect passthru status
hash< string, string > getDefaultHeaders()
Returns a hash of default headers to be sent with every outgoing request.
nothing setEventQueue()
Clears any Queue object that may be set on the HTTPClient object so that I/O events are no longer cap...
nothing setProxyUserPassword()
Clears the username and password for the next proxy connection.
nothing setTimeout(timeout timeout_ms=0)
Sets the default I/O timeout value in milliseconds.
nothing setProxyUserPassword(string user, string pass)
Sets the username and password for the connection to the proxy; call after HTTPClient::setProxyURL()
int getMaxRedirects()
Returns the current max_redirects value for the object (the maximum number of HTTP redirects that wil...
This class defines an abstract interface for input streams.
Definition: QC_InputStream.dox.h:19
This class defines an abstract interface for output streams.
Definition: QC_OutputStream.dox.h:18
The Socket class allows Qore programs safe access to network sockets.
Definition: QC_Socket.dox.h:136
Queue objects provide a blocking, thread-safe message-passing object to Qore programs
Definition: QC_Queue.dox.h:22
const True
logical True
Definition: qc_qore.dox.h:98
const False
logical False
Definition: qc_qore.dox.h:96
binary binary()
Always returns an empty binary object (of zero length)
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3