24 #ifndef QORE_HTTP_CLIENT_OBJECT_H_
25 #define QORE_HTTP_CLIENT_OBJECT_H_
28 #include <qore/QoreSocketObject.h>
30 #define HTTPCLIENT_DEFAULT_PORT 80
31 #define HTTPCLIENT_DEFAULT_HOST "localhost"
33 #define HTTPCLIENT_DEFAULT_TIMEOUT 300000
35 #define HTTPCLIENT_DEFAULT_MAX_REDIRECTS 5
45 struct qore_httpclient_priv *http_priv;
51 DLLLOCAL QoreHttpClientObject& operator=(
const QoreHttpClientObject&);
54 DLLEXPORT
void lock();
55 DLLEXPORT
void unlock();
107 DLLEXPORT
void addProtocol(
const char *prot,
int port,
bool ssl =
false);
194 DLLEXPORT
void setSecure(
bool is_secure);
312 DLLEXPORT
void setWarningQueue(
ExceptionSink* xsink, int64 warning_ms, int64 warning_bs,
class Queue* wq,
AbstractQoreNode* arg, int64 min_ms = 1000);
314 DLLEXPORT
void clearStats();
316 DLLLOCAL
static void static_init();
DLLEXPORT void clearProxyUserPassword()
clears the username and password for the proxy connection
DLLEXPORT QoreHashNode * head(const char *path, const QoreHashNode *headers, QoreHashNode *info, ExceptionSink *xsink)
sends an HTTP "HEAD" method and returns the headers returned, the caller owns the QoreHashNode refere...
defines string encoding functions in Qore
Definition: QoreEncoding.h:72
DLLEXPORT bool isProxySecure() const
returns the SSL proxy connection parameter flag
DLLEXPORT QoreStringNode * getURL()
returns the connection parameters as a URL, caller owns the reference count returned ...
DLLEXPORT int connect(ExceptionSink *xsink)
opens a connection and returns a code giving the result
This is the hash or associative list container type in Qore, dynamically allocated only...
Definition: QoreHashNode.h:41
DLLEXPORT bool isSecure() const
returns the SSL connection parameter flag
DLLEXPORT int setOptions(const QoreHashNode *opts, ExceptionSink *xsink)
set options with a hash, returns -1 if an exception was thrown, 0 for OK
DLLEXPORT QoreHttpClientObject()
creates the QoreHttpClientObject object
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:47
DLLEXPORT void setTimeout(int to)
sets the connection and response packet timeout value in milliseconds
DLLEXPORT int getMaxRedirects() const
returns the value of the max_redirects option
DLLEXPORT void setDefaultPath(const char *pth)
sets the default path
DLLEXPORT int setProxyURL(const char *proxy, ExceptionSink *xsink)
sets the proxy URL
DLLEXPORT void addProtocol(const char *prot, int port, bool ssl=false)
adds a protocol
virtual DLLEXPORT ~QoreHttpClientObject()
destroys the object and frees all associated memory
DLLEXPORT int setURL(const char *url, ExceptionSink *xsink)
sets the connection URL
DLLEXPORT void setDefaultPort(int prt)
sets the default port
Qore's string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:40
DLLEXPORT void setHTTP11(bool h11)
sets or clears HTTP 1.1 protocol compliance
DLLEXPORT void setConnectTimeout(int ms)
sets the connect timeout in ms
DLLEXPORT AbstractQoreNode * post(const char *path, const QoreHashNode *headers, const void *data, unsigned size, QoreHashNode *info, ExceptionSink *xsink)
sends an HTTP "POST" message to the remote server and returns the message body of the response...
DLLEXPORT bool getNoDelay() const
returns the value of the TCP_NODELAY flag on the object
DLLEXPORT void setDefaultHeaderValue(const char *header, const char *val)
sets the value of a default header to send with every outgoing message
DLLEXPORT void setUserPassword(const char *user, const char *pass)
sets the username and password for the connection
virtual DLLLOCAL void deref()
decrements the reference count of the object without the possibility of throwing a Qore-language exce...
Definition: AbstractPrivateData.h:57
DLLEXPORT int setHTTPVersion(const char *version, ExceptionSink *xsink)
sets the http version from a string
DLLEXPORT void setMaxRedirects(int max)
sets the max_redirects option
DLLEXPORT bool isConnected() const
returns the connection status of the object
DLLEXPORT const char * getHTTPVersion() const
returns the http version as a string (either "1.0" or "1.1")
DLLEXPORT void setEncoding(const QoreEncoding *qe)
sets the default encoding for the object
DLLEXPORT void disconnect()
disconnects from the remote server
DLLEXPORT int getTimeout() const
returns the connection and response packet timeout value in milliseconds
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:35
provides a way to communicate with HTTP servers using Qore data structures
Definition: QoreHttpClientObject.h:42
DLLEXPORT void setProxySecure(bool is_secure)
sets the SSL flag for use in the next connection to the proxy
DLLEXPORT QoreStringNode * getProxyURL()
returns the proxy connection parameters as a URL (or 0 if there is none), caller owns the reference c...
DLLEXPORT int setNoDelay(bool nodelay)
sets the TCP_NODELAY flag on the object
DLLEXPORT const char * getConnectionPath() const
returns the current connection path or 0 if none is set
DLLEXPORT const char * getDefaultPath() const
returns the default path or 0 if none is set
DLLEXPORT int getConnectTimeout() const
returns the connect timeout in ms, negative numbers mean no timeout
DLLEXPORT const QoreEncoding * getEncoding() const
returns the default encoding for the object
DLLEXPORT bool isHTTP11() const
returns true if HTTP 1.1 protocol compliance has been set
DLLEXPORT void setSecure(bool is_secure)
sets the SSL flag for use in the next connection
DLLEXPORT void clearUserPassword()
clears the username and password for the connection
DLLEXPORT void setEventQueue(Queue *cbq, ExceptionSink *xsink)
sets the event queue, must be already referenced before call
DLLEXPORT void setProxyUserPassword(const char *user, const char *pass)
sets the username and password for the proxy connection
DLLEXPORT QoreHashNode * send(const char *meth, const char *path, const QoreHashNode *headers, const void *data, unsigned size, bool getbody, QoreHashNode *info, ExceptionSink *xsink)
sends a message to the remote server and returns the entire response as a hash, caller owns the QoreH...
DLLEXPORT void clearProxyURL()
clears the proxy URL