IDobbySettings.h

/*
* If not stated otherwise in this file or this component's LICENSE file the
* following copyright and licenses apply:
*
* Copyright 2020 Sky UK
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
 * File:   IDobbySettings.h
 *
 */
#ifndef IDOBBYSETTINGS_H
#define IDOBBYSETTINGS_H
 
#include <memory>
#include <string>
#include <list>
#include <vector>
#include <map>
#include <set>
#include <netinet/in.h>
 
#if defined(RDK)
#  include <json/json.h>
#else
#  include <jsoncpp/json.h>
#endif
 
// -----------------------------------------------------------------------------
class IDobbySettings
{
public:
    virtual ~IDobbySettings() = default;
 
public:
    // -------------------------------------------------------------------------
    virtual std::string workspaceDir() const = 0;
 
    // -------------------------------------------------------------------------
    virtual std::string persistentDir() const = 0;
 
 
    // -------------------------------------------------------------------------
    virtual std::map<std::string, std::string> extraEnvVariables() const = 0;
 
    // -------------------------------------------------------------------------
    virtual std::string consoleSocketPath() const = 0;
 
public:
    // -------------------------------------------------------------------------
    struct ExtraMount
    {
        std::string source;
        std::string target;
        std::string type;
        std::set<std::string> flags;
    };
 
    // -------------------------------------------------------------------------
    struct HardwareAccessSettings
    {
        std::list<std::string> deviceNodes;
        std::set<int> groupIds;
        std::list<ExtraMount> extraMounts;
        std::map<std::string, std::string> extraEnvVariables;
    };
 
    // -------------------------------------------------------------------------
    virtual std::shared_ptr<HardwareAccessSettings> gpuAccessSettings() const = 0;
 
    // -------------------------------------------------------------------------
    virtual std::shared_ptr<HardwareAccessSettings> vpuAccessSettings() const = 0;
 
    // -------------------------------------------------------------------------
    virtual std::vector<std::string> externalInterfaces() const = 0;
 
    // -------------------------------------------------------------------------
    virtual std::string addressRangeStr() const = 0;
 
    // -------------------------------------------------------------------------
    virtual in_addr_t addressRange() const = 0;
 
    // -------------------------------------------------------------------------
    virtual std::vector<std::string> defaultPlugins() const = 0;
 
    virtual Json::Value rdkPluginsData() const = 0;
 
    struct LogRelaySettings
    {
        bool syslogEnabled;
        bool journaldEnabled;
 
        std::string syslogSocketPath;
        std::string journaldSocketPath;
    };
 
    virtual LogRelaySettings logRelaySettings() const = 0;
 
    // -------------------------------------------------------------------------
    struct StraceSettings
    {
        std::string logsDir;
        std::vector<std::string> apps;
    };
 
    virtual StraceSettings straceSettings() const = 0;
 
    // -------------------------------------------------------------------------
    struct ApparmorSettings
    {
        bool enabled;
        std::string profileName;
    };
 
    virtual ApparmorSettings apparmorSettings() const = 0;
 
    // -------------------------------------------------------------------------
    struct PidsSettings
    {
        bool enabled;
        int limit;
    };
 
    virtual PidsSettings pidsSettings() const = 0;
};
 
#endif // !defined(IDOBBYSETTINGS_H)