DataStreamUtil.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// @file DataStreamUtil.qm Qore user module implementing support for the DataStream protocol: YAML-encoded HTTP chunked transfers where each chunk is a unique data entity
 
/*  DataStreamUtil.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.123or better
 
// require type definitions everywhere
 
// enable all warnings
 
 
 
 
// do not use $ signs in declarations
 
 
/*  Version History: see docs below
*/
 
namespace DataStreamUtil {
 
    const DataStreamContentType = "DataStream-Content-Type";
 
    const DataStreamContentEncoding = "DataStream-Content-Encoding";
 
    const DataStreamAccept = "DataStream-Accept";
 
    const DataStreamAcceptEncoding = "DataStream-Accept-Encoding";
 
    const DataStreamError = "DataStream-Error";
 
    const DataStreamContentEncodingHash = (
        "gzip": True,
        "bzip2": True,
        "deflate": True,
        "identity": True,
    );
 
    const DataStreamDeserializeYaml = (
        "code": "yaml",
        "in": \parse_yaml(),
    );
 
    const DataStreamDeserializeXml = (
        "code": "xml",
        "in": hash<auto> (string xml) {
            try {
                return parse_xmlrpc_value(xml);
            } catch ();
 
        },
    );
 
    const DataStreamDeserializationSupport = (
        MimeTypeYamlRpc: DataStreamDeserializeYaml,
        MimeTypeYaml: DataStreamDeserializeYaml,
        MimeTypeJson: (
            "code": "json",
            "in": \parseJSON(),
        ),
        MimeTypeXml: DataStreamDeserializeXml,
        MimeTypeXmlApp: DataStreamDeserializeXml,
    );
 
 
     *code ds_get_content_decode(*string ce);
 
 
 
     *code ds_get_content_encode(*string ce);
 
 
 
     code ds_get_send(code scb, *code enc_func);
 
 
 
     code ds_get_recv(code rcb, code ecb, *code bcb);
 
 
 
     nothing ds_set_chunked_headers(reference<hash<auto>> hdr, *string content_encoding, *softbool req);
 
 
 
     nothing ds_set_non_chunked_headers(reference<hash<auto>> hdr, *string content_encoding, *softbool req);
 
 
 
     string ds_get_ds_accept_enc_header(*string ae);
 
}
 
// private namespace for non-exported definitions
namespace DataStreamUtilPrivate {
    // private function
    ds_do_request_headers(reference<hash<auto>> hdr);
 
}