DataStreamRequestHandler.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// @file DataStreamRequestHandler.qm Qore user module implementing client support for the DataStream protocol: YAML-encoded HTTP chunked transfers where each chunk is a unique data entity
 
/*  DataStreamRequestHandler.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.
*/
 
// minimum Qore version
 
// require type definitions everywhere
 
// enable all warnings
 
 
// do not use $ signs in declarations
 
 
/*  Version History: see docs below
*/
 
namespace DataStreamRequestHandler {
 
class AbstractDataStreamRequestHandler : public RestHandler::AbstractRestStreamRequestHandler {
 
public:
            code rcb;
 
            code scb;
 
        bool recv_done = False;
 
        bool send_done = False;
 
        int err;
 
        *string send_error;
 
        constructor(hash<auto> cx, *hash<auto> ah) ;
 
 
 
    *hash<auto> getErrorResponse();
 
 
 
        hash<auto> getResponseHeaderMessageImpl();
 
 
        nothing recvImpl(hash v);
 
 
        auto sendImpl();
 
 
protected:
     nothing recvDataDone(*string err);
public:
 
 
 
protected:
         nothing recvData(auto data);
public:
 
 
 
protected:
         auto sendData();
public:
 
 
protected:
     nothing recvDataDoneImpl(*string err);
public:
 
 
 
protected:
         abstract nothing recvDataImpl(auto data);
public:
 
 
protected:
         abstract auto sendDataImpl();
public:
    };
};