RpcMethod.h

Go to the documentation of this file.

/* Copyright 2013-2019 Homegear GmbH
 *
 * Homegear is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * Homegear is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with Homegear.  If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU Lesser General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
*/

#ifndef RPCMETHOD_H_
#define RPCMETHOD_H_

#include "../Variable.h"
#include "../Sockets/RpcClientInfo.h"

#include <vector>
#include <memory>

namespace BaseLib
{
namespace Rpc
{

class RpcMethod
{
public:
    struct ParameterError
    {
        enum Enum { noError, wrongCount, wrongType };
    };

    RpcMethod() {}
    virtual ~RpcMethod() {}

    ParameterError::Enum checkParameters(std::shared_ptr<std::vector<PVariable>> parameters, std::vector<VariableType> types);
    ParameterError::Enum checkParameters(std::shared_ptr<std::vector<PVariable>> parameters, std::vector<std::vector<VariableType>> types);
    virtual PVariable invoke(PRpcClientInfo clientInfo, std::shared_ptr<std::vector<PVariable>> parameters);
    PVariable getError(ParameterError::Enum error);
    PVariable getSignature() { return _signatures; }
    void addSignature(VariableType returnType, std::vector<VariableType> parameterTypes);
    PVariable getHelp() { return _help; }
    void setHelp(std::string help);
protected:
    PVariable _signatures;
    PVariable _help;
};
typedef std::shared_ptr<RpcMethod> PRpcMethod;

}
}
#endif