119 lines
4.2 KiB
C
119 lines
4.2 KiB
C
|
/* nutclientmem.h - definitions for nutclientmem C/C++ library
|
||
|
|
|
||
|
|
Copyright (C) 2021 Eric Clappier <ericclappier@eaton.com>
|
||
|
|
|
||
|
|
This program is free software; you can redistribute it and/or modify
|
||
|
|
it under the terms of the GNU General Public License as published by
|
||
|
|
the Free Software Foundation; either version 2 of the License, or
|
||
|
|
(at your option) any later version.
|
||
|
|
|
||
|
|
This program 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 General Public License for more details.
|
||
|
|
|
||
|
|
You should have received a copy of the GNU General Public License
|
||
|
|
along with this program; if not, write to the Free Software
|
||
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef NUTCLIENTMEM_HPP_SEEN
|
||
|
|
#define NUTCLIENTMEM_HPP_SEEN
|
||
|
|
|
||
|
|
/* Begin of C++ nutclient library declaration */
|
||
|
|
#ifdef __cplusplus
|
||
|
|
|
||
|
|
#include "nutclient.h"
|
||
|
|
|
||
|
|
namespace nut
|
||
|
|
{
|
||
|
|
|
||
|
|
typedef std::vector<std::string> ListValue;
|
||
|
|
typedef std::map<std::string, ListValue> ListObject;
|
||
|
|
typedef std::map<std::string, ListObject> ListDevice;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Memory client stub.
|
||
|
|
* Class to stub TCPClient for test (data store in local memory).
|
||
|
|
*/
|
||
|
|
class MemClientStub : public Client
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
* Construct a nut MemClientStub object.
|
||
|
|
*/
|
||
|
|
MemClientStub() {}
|
||
|
|
~MemClientStub() override {}
|
||
|
|
|
||
|
|
virtual void authenticate(const std::string& user, const std::string& passwd) override {
|
||
|
|
NUT_UNUSED_VARIABLE(user);
|
||
|
|
NUT_UNUSED_VARIABLE(passwd);
|
||
|
|
}
|
||
|
|
virtual void logout() override {}
|
||
|
|
|
||
|
|
virtual Device getDevice(const std::string& name) override;
|
||
|
|
virtual std::set<std::string> getDeviceNames() override;
|
||
|
|
virtual std::string getDeviceDescription(const std::string& name) override;
|
||
|
|
|
||
|
|
virtual std::set<std::string> getDeviceVariableNames(const std::string& dev) override;
|
||
|
|
virtual std::set<std::string> getDeviceRWVariableNames(const std::string& dev) override;
|
||
|
|
virtual std::string getDeviceVariableDescription(const std::string& dev, const std::string& name) override;
|
||
|
|
virtual ListValue getDeviceVariableValue(const std::string& dev, const std::string& name) override;
|
||
|
|
virtual ListObject getDeviceVariableValues(const std::string& dev) override;
|
||
|
|
virtual ListDevice getDevicesVariableValues(const std::set<std::string>& devs) override;
|
||
|
|
virtual TrackingID setDeviceVariable(const std::string& dev, const std::string& name, const std::string& value) override;
|
||
|
|
virtual TrackingID setDeviceVariable(const std::string& dev, const std::string& name, const ListValue& values) override;
|
||
|
|
|
||
|
|
virtual std::set<std::string> getDeviceCommandNames(const std::string& dev) override;
|
||
|
|
virtual std::string getDeviceCommandDescription(const std::string& dev, const std::string& name) override;
|
||
|
|
virtual TrackingID executeDeviceCommand(const std::string& dev, const std::string& name, const std::string& param="") override;
|
||
|
|
|
||
|
|
virtual void deviceLogin(const std::string& dev) override;
|
||
|
|
/* Note: "master" is deprecated, but supported
|
||
|
|
* for mixing old/new client/server combos: */
|
||
|
|
virtual void deviceMaster(const std::string& dev) override;
|
||
|
|
virtual void devicePrimary(const std::string& dev) override;
|
||
|
|
virtual void deviceForcedShutdown(const std::string& dev) override;
|
||
|
|
virtual int deviceGetNumLogins(const std::string& dev) override;
|
||
|
|
|
||
|
|
virtual TrackingResult getTrackingResult(const TrackingID& id) override;
|
||
|
|
|
||
|
|
virtual bool isFeatureEnabled(const Feature& feature) override;
|
||
|
|
virtual void setFeature(const Feature& feature, bool status) override;
|
||
|
|
|
||
|
|
private:
|
||
|
|
ListDevice _values;
|
||
|
|
};
|
||
|
|
|
||
|
|
} /* namespace nut */
|
||
|
|
|
||
|
|
#endif /* __cplusplus */
|
||
|
|
/* End of C++ nutclient library declaration */
|
||
|
|
|
||
|
|
/* Begin of C nutclient library declaration */
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif /* __cplusplus */
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Nut MEM client dedicated types and functions
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* Hidden structure representing a MEM connection.
|
||
|
|
* NUTCLIENT_MEM_t is back compatible to NUTCLIENT_t.
|
||
|
|
*/
|
||
|
|
typedef NUTCLIENT_t NUTCLIENT_MEM_t;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create a client to NUTD using memory.
|
||
|
|
* \return New client or nullptr if failed.
|
||
|
|
*/
|
||
|
|
NUTCLIENT_MEM_t nutclient_mem_create_client();
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif /* __cplusplus */
|
||
|
|
/* End of C nutclient library declaration */
|
||
|
|
|
||
|
|
#endif /* NUTCLIENTMOCK_HPP_SEEN */
|