QoreHttpClientObject.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    QoreHttpClientObject.h
 
    Qore Programming Language
 
    Copyright (C) 2006 - 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 
    Note that the Qore library is released under a choice of three open-source
    licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
    information.
*/
 
#ifndef QORE_HTTP_CLIENT_OBJECT_H_
#define QORE_HTTP_CLIENT_OBJECT_H_
 
#include <qore/common.h>
#include <qore/QoreSocketObject.h>
#include <qore/OutputStream.h>
 
#define HTTPCLIENT_DEFAULT_PORT 80                 
#define HTTPCLIENT_DEFAULT_HOST "localhost"        
 
#define HTTPCLIENT_DEFAULT_TIMEOUT 300000          
#define HTTPCLIENT_DEFAULT_CONNECT_TIMEOUT 60000   
 
#define HTTPCLIENT_DEFAULT_MAX_REDIRECTS 5         
 
class Queue;
 
 
class QoreHttpClientObject : public QoreSocketObject {
    friend hashdecl qore_httpclient_priv;
    friend class HttpClientConnectSendRecvPollOperation;
 
public:
    DLLEXPORT QoreHttpClientObject();
 
    DLLEXPORT virtual ~QoreHttpClientObject();
 
 
    DLLEXPORT QoreObject* startPollConnect(ExceptionSink* xsink, QoreObject* self);
 
 
    DLLEXPORT QoreObject* startPollSendRecv(ExceptionSink* xsink, QoreObject* self, const QoreString* method,
            const QoreString* path, const AbstractQoreNode* data_save, const void* data, size_t size,
            const QoreHashNode* headers, const QoreEncoding* enc = nullptr);
 
 
    DLLEXPORT int setOptions(const QoreHashNode* opts, ExceptionSink* xsink);
 
 
    DLLEXPORT void setDefaultPort(int prt);
 
 
    DLLEXPORT void setDefaultPath(const char* pth);
 
 
    DLLEXPORT const char* getDefaultPath() const;
 
 
    DLLEXPORT const char* getConnectionPath() const;
 
 
    DLLEXPORT void setConnectionPath(const char* path);
 
 
    DLLEXPORT void addProtocol(const char* prot, int port, bool ssl = false);
 
    DLLEXPORT void setTimeout(int to);
 
    DLLEXPORT int getTimeout() const;
 
    DLLEXPORT void setEncoding(const QoreEncoding* qe);
 
    DLLEXPORT const QoreEncoding* getEncoding() const;
 
 
    DLLEXPORT int setHTTPVersion(const char* version, ExceptionSink* xsink);
 
 
    DLLEXPORT const char* getHTTPVersion() const;
 
 
    DLLEXPORT void setHTTP11(bool h11);
 
    DLLEXPORT bool isHTTP11() const;
 
 
    DLLEXPORT int setURL(const char* url, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreStringNode* getURL();
 
 
    DLLEXPORT QoreStringNode* getSafeURL();
 
 
    DLLEXPORT void setUserPassword(const char* user, const char* pass);
 
    DLLEXPORT void clearUserPassword();
 
 
    DLLEXPORT int setProxyURL(const char* proxy, ExceptionSink* xsink);
 
 
    DLLEXPORT QoreStringNode* getProxyURL();
 
 
    DLLEXPORT QoreStringNode* getSafeProxyURL();
 
    DLLEXPORT void clearProxyURL();
 
 
    DLLEXPORT void setProxyUserPassword(const char* user, const char* pass);
 
    DLLEXPORT void clearProxyUserPassword();
 
 
    DLLEXPORT QoreStringNode* getUsername() const;
 
 
    DLLEXPORT QoreStringNode* getPassword() const;
 
 
    DLLEXPORT QoreStringNode* getProxyUsername() const;
 
 
    DLLEXPORT QoreStringNode* getProxyPassword() const;
 
    DLLEXPORT void setSecure(bool is_secure);
 
    DLLEXPORT bool isSecure() const;
 
    DLLEXPORT void setProxySecure(bool is_secure);
 
    DLLEXPORT bool isProxySecure() const;
 
    DLLEXPORT void setMaxRedirects(int max);
 
    DLLEXPORT int getMaxRedirects() const;
 
 
    DLLEXPORT int connect(ExceptionSink* xsink);
 
    DLLEXPORT void disconnect();
 
 
    DLLEXPORT QoreHashNode* send(const char* meth, const char* path, const QoreHashNode* headers, const void* data,
            unsigned size, bool getbody, QoreHashNode* info, ExceptionSink* xsink);
 
    DLLEXPORT QoreHashNode* send(const char* meth, const char* path, const QoreHashNode* headers,
            const QoreStringNode& body, bool getbody, QoreHashNode* info, ExceptionSink* xsink);
 
    DLLEXPORT QoreHashNode* sendWithSendCallback(const char* meth, const char* mpath, const QoreHashNode* headers,
            const ResolvedCallReferenceNode* send_callback, bool getbody, QoreHashNode* info, int timeout_ms,
            ExceptionSink* xsink);
 
    DLLEXPORT void sendWithRecvCallback(const char* meth, const char* mpath, const QoreHashNode* headers,
            const void* data, unsigned size, bool getbody, QoreHashNode* info, int timeout_ms,
            const ResolvedCallReferenceNode* recv_callback, QoreObject* obj, ExceptionSink* xsink);
 
    DLLEXPORT void sendWithRecvCallback(const char* meth, const char* mpath, const QoreHashNode* headers,
            const QoreStringNode& body, bool getbody, QoreHashNode* info, int timeout_ms,
            const ResolvedCallReferenceNode* recv_callback, QoreObject* obj, ExceptionSink* xsink);
 
    DLLEXPORT void sendWithCallbacks(const char* meth, const char* mpath, const QoreHashNode* headers,
            const ResolvedCallReferenceNode* send_callback, bool getbody, QoreHashNode* info, int timeout_ms,
            const ResolvedCallReferenceNode* recv_callback, QoreObject* obj, ExceptionSink* xsink);
 
 
    DLLEXPORT void sendWithOutputStream(const char* meth, const char* mpath, const QoreHashNode* headers,
            const void* data, unsigned size, bool getbody, QoreHashNode* info, int timeout_ms,
            const ResolvedCallReferenceNode* recv_callback, QoreObject* obj, OutputStream *os, ExceptionSink* xsink);
 
 
    DLLEXPORT void sendWithOutputStream(const char* meth, const char* mpath, const QoreHashNode* headers,
            const QoreStringNode& body, bool getbody, QoreHashNode* info, int timeout_ms,
            const ResolvedCallReferenceNode* recv_callback, QoreObject* obj, OutputStream *os, ExceptionSink* xsink);
 
 
    DLLEXPORT void sendChunked(const char* meth, const char* mpath, const QoreHashNode* headers, bool getbody,
            QoreHashNode* info, int timeout_ms, const ResolvedCallReferenceNode* recv_callback, QoreObject* obj,
            OutputStream *os, InputStream* is, size_t max_chunk_size,
            const ResolvedCallReferenceNode* trailer_callback, ExceptionSink* xsink);
 
 
    DLLEXPORT AbstractQoreNode* get(const char* path, const QoreHashNode* headers, QoreHashNode* info,
            ExceptionSink* xsink);
 
 
    DLLEXPORT QoreHashNode* head(const char* path, const QoreHashNode* headers, QoreHashNode* info,
            ExceptionSink* xsink);
 
 
    DLLEXPORT AbstractQoreNode* post(const char* path, const QoreHashNode* headers, const void* data, unsigned size,
            QoreHashNode* info, ExceptionSink* xsink);
 
 
    DLLEXPORT AbstractQoreNode* post(const char* path, const QoreHashNode* headers, const QoreStringNode& body,
            QoreHashNode* info, ExceptionSink* xsink);
 
 
    DLLEXPORT void setDefaultHeaderValue(const char* header, const char* val);
 
 
    DLLEXPORT void addDefaultHeaders(const QoreHashNode* hdr);
 
 
    DLLEXPORT QoreHashNode* getDefaultHeaders() const;
 
    using AbstractPrivateData::deref;
 
    DLLEXPORT virtual void deref(ExceptionSink* xsink);
 
 
    DLLEXPORT void setConnectTimeout(int ms);
 
 
    DLLEXPORT int getConnectTimeout() const;
 
 
    DLLEXPORT int setNoDelay(bool nodelay);
 
    DLLEXPORT void setEventQueue(Queue* cbq, ExceptionSink* xsink);
 
    DLLEXPORT void setEventQueue(ExceptionSink* xsink, Queue* q, QoreValue arg, bool with_data);
 
    DLLEXPORT bool getNoDelay() const;
 
    DLLEXPORT bool isConnected() const;
 
    DLLEXPORT void setPersistent(ExceptionSink* xsink);
 
    DLLEXPORT void clearWarningQueue(ExceptionSink* xsink);
    DLLEXPORT void setWarningQueue(ExceptionSink* xsink, int64 warning_ms, int64 warning_bs, Queue* wq, QoreValue arg,
            int64 min_ms = 1000);
    DLLEXPORT QoreHashNode* getUsageInfo() const;
    DLLEXPORT void clearStats();
 
 
    DLLEXPORT bool setErrorPassthru(bool set);
 
 
    DLLEXPORT bool getErrorPassthru() const;
 
 
    DLLEXPORT bool setRedirectPassthru(bool set);
 
 
    DLLEXPORT bool getRedirectPassthru() const;
 
 
    DLLEXPORT bool setEncodingPassthru(bool set);
 
 
    DLLEXPORT bool getEncodingPassthru() const;
 
 
    DLLEXPORT QoreStringNode* getHostHeaderValue() const;
 
 
    DLLEXPORT void setAssumedEncoding(const char* enc);
 
 
    DLLEXPORT QoreStringNode* getAssumedEncoding() const;
 
 
    DLLEXPORT bool setPreEncodedUrls(bool set);
 
 
    DLLEXPORT bool getPreEncodedUrls() const;
 
    DLLLOCAL static void static_init();
 
    DLLLOCAL void cleanup(ExceptionSink* xsink);
 
protected:
    DLLEXPORT void lock();
    DLLEXPORT void unlock();
 
private:
    hashdecl qore_httpclient_priv* http_priv;
 
    DLLLOCAL QoreHttpClientObject(const QoreHttpClientObject&);
 
    DLLLOCAL QoreHttpClientObject& operator=(const QoreHttpClientObject&);
};
 
#endif