Qore Programming Language Reference Manual  0.8.9
 All Classes Namespaces Functions Variables Groups Pages
QC_HTTPClient.dox.h
1 namespace Qore {
4 
141 class HTTPClient : public Socket {
142 
143 public:
145 
150 nothing clearProxyURL();
151 
152 public:
154 
161 nothing clearProxyUserPassword();
162 
163 public:
165 
174  clearStats();
175 
176 public:
178 
185 nothing clearUserPassword();
186 
187 public:
189 
198 nothing clearWarningQueue();
199 
200 public:
202 
216 nothing connect();
217 
218 public:
220 
244  constructor(hash opts);
245 
246 public:
248 
253  constructor();
254 
255 public:
257 
259  copy();
260 
261 public:
263 
268  destructor();
269 
270 public:
272 
277 nothing disconnect();
278 
279 public:
281 
313 *string get(string path, *hash headers, *reference info);
314 
315 public:
317 
327 int getConnectTimeout();
328 
329 public:
331 
341 *string getConnectionPath();
342 
343 public:
345 
355 string getDefaultPath();
356 
357 public:
359 
369 string getEncoding();
370 
371 public:
373 
383 string getHTTPVersion();
384 
385 public:
387 
397 int getMaxRedirects();
398 
399 public:
401 
411 bool getNoDelay();
412 
413 public:
415 
425 *string getProxyURL();
426 
427 public:
429 
439 int getTimeout();
440 
441 public:
443 
453 *string getURL();
454 
455 public:
457 
479 
480 public:
482 
510 hash head(string path, *hash headers, *reference info);
511 
512 public:
514 
524 bool isConnected();
525 
526 public:
528 
538 bool isProxySecure();
539 
540 public:
542 
553 bool isSecure();
554 
555 public:
557 
589 *string post(string path, string body, *hash headers, *reference info);
590 
591 public:
593 
624 *string post(string path, *binary body, *hash headers, *reference info);
625 
626 public:
628 
658 hash send(string body, string method, *string path, *hash headers, softbool getbody = False, *reference info);
659 
660 public:
662 
691 hash send(*binary body, string method, *string path, *hash headers, softbool getbody = False, *reference info);
692 
693 public:
695 
702 nothing setConnectTimeout(timeout timeout_ms = -1);
703 
704 public:
706 
713 nothing setDefaultPath(*string path);
714 
715 public:
717 
724 nothing setEncoding(string encoding);
725 
726 public:
728 
733 nothing setEventQueue();
734 
735 public:
737 
748 nothing setEventQueue(Qore::Thread::Queue queue);
749 
750 public:
752 
761 nothing setHTTPVersion(string ver);
762 
763 public:
765 
774 nothing setMaxRedirects(softint mr = 0);
775 
776 public:
778 
795 int setNoDelay(softbool b = True);
796 
797 public:
799 
806 nothing setProxySecure(softbool b = True);
807 
808 public:
810 
817 nothing setProxyURL();
818 
819 public:
821 
833 nothing setProxyURL(string url);
834 
835 public:
837 
847 nothing setProxyUserPassword(string user, string pass);
848 
849 public:
851 
862 nothing setProxyUserPassword();
863 
864 public:
866 
877 nothing setSecure(softbool secure = True);
878 
879 public:
881 
888 nothing setTimeout(timeout timeout_ms = 0);
889 
890 public:
892 
908  setURL(string url);
909 
910 public:
912 
922 nothing setUserPassword(string user, string pass);
923 
924 public:
926 
937 nothing setUserPassword();
938 
939 public:
941 
971 nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, any arg, timeout min_ms = 1s);
972 };
973 };
hash getUsageInfo()
Returns performance statistics for the socket.
nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, any arg, timeout min_ms=1s)
Sets a Queue object to receive socket warnings.
bool getNoDelay()
Returns the TCP_NODELAY setting for the HTTPClient object.
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.
The Socket class allows Qore programs safe access to network sockets.
Definition: QC_Socket.dox.h:122
string getEncoding()
Returns the character encoding used for the object.
nothing clearWarningQueue()
Removes any warning Queue object from the Socket.
nothing setMaxRedirects(softint mr=0)
Updates the setting for the max_redirects value for the object (maximum number of HTTP redirects that...
const True
logical True
Definition: qc_qore.dox.h:94
bool isSecure()
Returns True if the current connection is encrypted, False if not.
bool isConnected()
Returns True or False giving the current connection state.
binary binary()
Always returns an empty binary object (of zero length)
nothing setTimeout(timeout timeout_ms=0)
Sets the default I/O timeout value in milliseconds.
int getTimeout()
Returns the default I/O timeout as an integer in milliseconds.
constructor()
Creates the HTTPClient object.
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...
string getHTTPVersion()
Returns the HTTP protocol version string used in outgoing messages.
const False
logical False
Definition: qc_qore.dox.h:92
nothing setProxySecure(softbool b=True)
Sets the SSL/TLS flag for the next connection to the proxy.
nothing clearProxyUserPassword()
Clears the username and password for the next proxy connection.
nothing setProxyURL()
Clears the new proxy URL value for the next connection.
*string post(string path, string body, *hash headers, *reference info)
Sends an HTTP POST request with a message body and returns the message body received as a string or N...
nothing setProxyUserPassword()
Clears the username and password for the next proxy connection.
hash head(string path, *hash headers, *reference info)
Sends an HTTP HEAD request and returns as hash of the headers received.
*string getURL()
Returns the current URL.
hash send(string body, string method, *string path, *hash headers, softbool getbody=False, *reference info)
Sends an HTTP request with the specified method and optional message body and returns headers and any...
copy()
Copying objects of this class is not supported, an exception will be thrown.
The HTTPClient class can be used to communicate with HTTP servers with and without TLS/SSL encryption...
Definition: QC_HTTPClient.dox.h:141
nothing connect()
Connects to the remote socket; SSL/TLS negotiation is performed if required.
nothing clearProxyURL()
Clears the new proxy URL value for the next connection.
nothing disconnect()
Disconnects from the remote socket if a connection is established (otherwise does nothing) ...
nothing clearUserPassword()
Clears the username and password for the connection.
nothing setConnectTimeout(timeout timeout_ms=-1)
Sets the connect timeout in milliseconds.
*string getConnectionPath()
Returns the current connection path set in the URL.
clearStats()
Clears performance statistics.
int getConnectTimeout()
Returns the connect timeout as an integer in milliseconds.
bool isProxySecure()
Returns the SSL/TLS flag for the next proxy connection.
destructor()
Destroys the HTTPClient object and closes any open connections.
Queue objects provide a blocking, thread-safe message-passing object to Qore programs ...
Definition: QC_Queue.dox.h:13
int getMaxRedirects()
Returns the current max_redirects value for the object (the maximum number of HTTP redirects that wil...
nothing setEventQueue()
Clears any Queue object that may be set on the HTTPClient object so that I/O events are no longer cap...
setURL(string url)
Sets a new 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 setUserPassword()
Clears the username and password for the connection.
hash hash(object obj)
Returns a hash of an object's members.
*string getProxyURL()
Returns the current proxy URL as a string or NOTHING if no proxy URL is set.
int setNoDelay(softbool b=True)
Sets the TCP_NODELAY setting for the object.
nothing setHTTPVersion(string ver)
Sets the HTTP protocol version string for headers in outgoing messages, allowed values are "1...