YamlRpcClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-

/*  YamlRpcClient.qm Copyright 2012 - 2016 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

// requires the binary yaml module

// need mime definitions


// do not use $ signs in declarations
// require type declarations
// enable all warnings
// do not ignore arg errors in calls, disallow access to all NOOP variants


namespace YamlRpcClient {

class YamlRpcClient : public Qore::HTTPClient {

public:
        const Version = "1.0";

        const DefaultOptions = (
            "protocols": (
                "yamlrpc": (
                    "port": 80,
                    "ssl": False,
                ),
                "yamlrpcs": (
                    "port": 443,
                    "ssl": True,
                ),
            ),
            "default_path": "YAML",
            );

        const VersionString = sprintf("Qore-YAML-RPC-Client/%s", YamlRpcClient::Version);

        const DefaultHeaders = (
            "Content-Type": MimeTypeYamlRpc + ";charset=utf-8",
            "Accept": MimeTypeYamlRpc,
            "User-Agent": YamlRpcClient::VersionString,
            );

        private :
            hash headers;
            int flags = YAML::None;
            string path;

public:


        constructor(hash opts = hash(), bool do_not_connect = False) ;



        constructor(bool do_not_connect = False) ;



        any callArgs(string method, any args);



        any callArgsWithInfo(reference info, string method, any args);



        any call(string method);


          static string makeRequest(string method, any arg, int flags = YAML::None);
    };


class YamlRpcConnection : public ConnectionProvider::HttpBasedConnection {

public:
        public :
            hash real_opts;

public:


        constructor(string name, string desc, string url, bool monitor, *hash opts, hash urlh) ;



private:
         YamlRpcClient getImpl(bool connect = True, *hash rtopts);
public:



        hash getOptions();


        *hash getDefaultOptions();


        string getType();


          static YamlRpcConnection make(string name, string desc, string url, bool monitor, *hash opts, hash urlh);
    };
};