agents.hpp

Go to the documentation of this file.

/*
Copyright (c) 2025 acrion innovations GmbH
Authors: Stefan Zipproth, s.zipproth@acrion.ch
 
This file is part of nexuslua, see https://github.com/acrion/nexuslua and https://nexuslua.org
 
nexuslua is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://acrion.ch/sales. For AGPL licensing, see below.
 
AGPL licensing:
 
nexuslua is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
nexuslua 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 Affero General Public License for more details.
 
You should have received a copy of the GNU Affero General Public License
along with nexuslua. If not, see <https://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include "cpp_handler.hpp"
#include "lua_table.hpp"
#include "plugin_install_result.hpp"
 
#include "nexuslua_export.h"
 
#include <filesystem>
#include <map>
#include <memory>
#include <string>
 
namespace nexuslua
{
    class Agent;
    class AgentCpp;
    class AgentLua;
    class PluginSpec;
    class AgentMessage;

    class NEXUSLUA_EXPORT agents : public std::enable_shared_from_this<agents>
    {
        struct impl;
        std::unique_ptr<impl> _impl;
 
    public:
        agents();
        virtual ~agents();
 
        void                                                       DeleteAgents();
        const std::map<std::string, std::shared_ptr<const Agent>>& GetPlugins();                                                                                                                      
        void                                                       InvalidatePluginScan();                                                                                                            
        PluginInstallResult                                        InstallPlugin(const std::filesystem::path& srcFolder, std::string& errorMessage);                                                  
        PluginInstallResult                                        InstallPlugin(const std::shared_ptr<::nexuslua::Agent>& agent, const std::filesystem::path& srcFolder, std::string& errorMessage); 
        PluginUninstallResult                                      UninstallPlugin(const std::string& name);                                                                                          
        void                                                       RestorePersistentPluginFolder(const std::shared_ptr<::nexuslua::Agent>& plugin, const std::filesystem::path& srcFolder);           
        const AgentMessage&                                        GetMessage(const std::string& agentName, const std::string& messageName);                                                          

        std::shared_ptr<AgentCpp> Add(const std::string& agentName, const CppHandler& cppHandler, const LuaTable& predefinedTable = {});

        std::shared_ptr<AgentLua> Add(const std::string& agentName, const std::filesystem::path& pathToLuaFile, const std::string& luaCode = "", const LuaTable& predefinedTable = {});

        std::shared_ptr<Agent> GetAgent(const std::string& agentName);

        void           AddMessageForCppAgent(const std::string& agentName, const std::string& messageName);
        void           WaitUntilMessageQueueIsEmpty(); 
        void           ShutdownAgents();   
        static int64_t TotalSizeOfMessagesQueues();
    };
}