DataStreamClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// @file DataStreamClient.qm Qore user module implementing client support for the DataStream protocol: YAML-encoded HTTP chunked transfers where each chunk is a unique data entity
 
/*  DataStreamClient.qm Copyright (C) 2014 - 2019 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.
*/
 
// this module requires Qore 0.8.13 or better
 
// require type definitions everywhere
 
// enable all warnings
 
 
// do not use $ signs in declarations
 
 
/*  Version History: see docs below
*/
 
namespace DataStreamClient {
    class DataStreamSendMessage {
 
public:
        
 
 
        auto sendData();
 
 
 
protected:
         abstract auto sendDataImpl();
public:
    };
 
    class DataStreamRecvMessage {
 
public:
            // any datastream error received from the remote end
            string err;
 
 
        nothing recvData(auto data);
 
 
 
        nothing recvDataDone(*string err);
 
 
 
protected:
         nothing recvDataDoneImpl(*string err);
public:
 
 
 
protected:
         abstract nothing recvDataImpl(auto data);
public:
    };
 
class DataStreamMessage : public DataStreamSendMessage,public  DataStreamRecvMessage {
 
public:
    };
 
class DataStreamClient : public RestClient::RestClient {
 
public:
            const Version = "1.1";
 
            const VersionString = sprintf("Qore-DataStreamClient/%s", DataStreamClient::Version);
 
            const DefaultHeaders = RestClient::DefaultHeaders + {
                "User-Agent": DataStreamClient::VersionString,
                DataStreamAccept: MimeTypeYaml,
            };
 
 
        constructor(*hash<auto> opts, *softbool do_not_connect) ;
 
 
 
        recvDataStream(code rcb, code ecb, string method, string path, auto body, timeout timeout_ms = 0, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
        recvDataStream(DataStreamRecvMessage dsm, string method, string path, auto body, timeout timeout_ms = 0, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
        hash<auto> sendDataStream(code scb, string method, string path, timeout timeout_ms = 0, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
        hash<auto> sendDataStream(DataStreamSendMessage dsm, string method, string path, timeout timeout_ms = 0, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
        sendRecvDataStream(code scb, code rcb, code ecb, string method, string path, timeout timeout_ms = 0, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
        sendRecvDataStream(DataStreamMessage dsm, string method, string path, timeout timeout_ms = 0, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
        hash<auto> sendRawStream(code scb, string method, *string path, timeout timeout_ms = 0, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
        hash<auto> getRawStream(code rcb, string method, *string path, auto body, timeout timeout_ms = 0, *reference<hash<auto>> info, *hash<auto> hdr);
 
 
 
        addDefaultHeaders(hash<auto> h);
 
 
 
        setContentEncoding(string enc = 'auto');
 
 
protected:
         nothing prepareMsg(string method, string path, reference<auto> body, reference<hash<auto>> hdr, string ct = 'Content-Type');
public:
 
 
        hash<auto> sendAndDecodeResponse(*data body, string m, string path, hash<auto> hdr, *reference<hash<auto>> info, *softbool decode_errors);
 
    };
};