YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
manager.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5
6#ifndef YARP_MANAGER_MANAGER
7#define YARP_MANAGER_MANAGER
8
10#include <yarp/manager/kbase.h>
14#include <map>
15
16namespace yarp::manager {
17
21class Manager : public MEvent{
22
23public:
24 Manager( bool withWatchDog=false);
25 Manager(const char* szModPath, const char* szAppPath,
26 const char* szResPath, bool withWatchDog=false);
27 ~Manager() override;
28
29 bool addApplication(const char* szFileName, char** szAppName_=nullptr, bool modifyName=false);
30 bool addApplications(const char* szPath);
31 bool addModule(const char* szFileName);
32 bool addModules(const char* szPath);
33 bool addResource(const char* szFileName);
34 bool addResources(const char* szPath);
35
36 bool removeApplication(const char* szFileName, const char* szAppName);
37 bool removeModule(const char* szModName);
38 bool removeResource(const char* szResName);
39
40 bool loadApplication(const char* szAppName);
41 bool saveApplication(const char* szAppName, const char* fileName=nullptr);
42 bool updateExecutable(unsigned int id, const char* szparam,
43 const char* szhost, const char* szstdio,
44 const char* szworkdir, const char* szenv );
45 bool updateConnection(unsigned int id, const char* from,
46 const char* to, const char* carrier);
47
48 Node* getNode(std::string appName);
49
50 bool run();
51 bool run(unsigned int id, bool async=false);
52 bool stop();
53 bool stop(unsigned int id, bool async=false);
54 bool kill();
55 bool kill(unsigned int id, bool async=false);
56 bool connect();
57 bool connect(unsigned int id);
58 bool disconnect();
59 bool disconnect(unsigned int id);
60 bool rmconnect(unsigned int id);
61 bool rmconnect();
62 bool running() { return allRunning(); }
63 bool running(unsigned int id);
64 bool suspended() { return allStopped(); }
65 bool suspended(unsigned int id);
66 bool connected();
67 bool connected(unsigned int id);
68 bool checkDependency();
69 bool exist(unsigned int id);
70 bool existPortFrom(unsigned int id);
71 bool existPortTo(unsigned int id);
72 bool attachStdout(unsigned int id);
73 bool detachStdout(unsigned int id);
74 bool updateResources();
75 bool updateResource(const char* szName);
76 bool waitingModuleRun(unsigned int id);
77 bool waitingModuleStop(unsigned int id);
78 bool waitingModuleKill(unsigned int id);
79 bool loadBalance();
80 void collectYarprunProcessesByHost(std::map<std::string, ProcessContainer>& hostProcesses,
81 std::map<std::string, bool>& hostQueryOk);
82
83 void setDefaultBroker(const char* szBroker) { if(szBroker) { strDefBroker = szBroker; } }
84 const char* defaultBroker() { return strDefBroker.c_str(); }
85 ExecutablePContainer& getExecutables() { return runnables; }
86 Executable* getExecutableById(size_t id);
87 bool switchBroker(size_t id);
88 CnnContainer& getConnections() { return connections;}
89 ResourcePContainer& getResources() { return resources; }
90 const char* getApplicationName() { return strAppName.c_str(); }
91
92 //const char* getDataPort(const char* szDataType);
93
94 void enableRestrictedMode() { bRestricted = true; }
95 void disableRestrictedMode() { bRestricted = false; }
96 void enableAutoConnect() { bAutoConnect = true; }
97 void disableAutoConnect() { bAutoConnect = false; }
98 void enableAutoDependency() { bAutoDependancy = true; }
99 void disableAutoDependency() { bAutoDependancy = false; }
100 void enableWatchDog() { bWithWatchDog = true; }
101 void disableWatchod() { bWithWatchDog = false; }
102 bool exportDependencyGraph(const char* szFileName) {
103 return knowledge.exportAppGraph(szFileName);
104 }
105
106 KnowledgeBase* getKnowledgeBase() { return &knowledge; }
107 ErrorLogger* getLogger() { return logger;}
108
109protected:
110 void onExecutableStart(void* which) override;
111 void onExecutableStop(void* which) override;
112 void onExecutableDied(void* which) override;
113 void onExecutableFailed(void* which) override;
114 void onCnnStablished(void* which) override;
115 void onCnnFailed(void* which) override;
116 void onError(void* which) override;
117 void onExecutableStdout(void* which, const char* msg) override;
118
119
120private:
121 bool bWithWatchDog;
122 bool bAutoDependancy;
123 bool bAutoConnect;
124 bool bRestricted;
125 ErrorLogger* logger;
126 std::string strAppName;
127 std::string strDefBroker;
128 YarpBroker connector;
129 std::vector<std::string> listOfXml;
130
131 KnowledgeBase knowledge;
132 ExecutablePContainer runnables;
133 CnnContainer connections;
134 ModulePContainer modules;
135 ResourcePContainer resources;
136
137 bool createKnowledgeBase(AppLoader &appLoader);
138 void clearExecutables();
139 bool isServer(Module* themodule);
140 bool connectExtraPorts();
141 bool checkPortsAvailable(Broker* broker);
142 bool allRunning();
143 bool oneRunning();
144 bool allStopped();
145 bool prepare(bool silent=true);
146 bool timeout(double base, double t);
147 bool updateResource(GenericResource* resource);
148 Broker* createBroker(Module* themodule);
149 bool removeBroker(Executable* exe);
150};
151
152} // namespace yarp::manager
153
154
155#endif // __YARP_MANAGER_MANAGER__
Abstract Class AppLoader.
Class Broker.
Definition broker.h:30
Singleton class ErrorLogger.
Definition utility.h:58
Class Executable.
Definition executable.h:71
Class KnowledgeBase.
Definition kbase.h:32
bool exportAppGraph(const char *szFileName)
Definition kbase.h:113
Class Manager.
Definition manager.h:21
void onExecutableStdout(void *which, const char *msg) override
Definition manager.cpp:1416
void onExecutableDied(void *which) override
Definition manager.cpp:1414
const char * defaultBroker()
Definition manager.h:84
void onExecutableStop(void *which) override
Definition manager.cpp:1412
bool removeApplication(const char *szFileName, const char *szAppName)
Definition manager.cpp:185
bool updateResource(const char *szName)
Definition manager.cpp:607
ErrorLogger * getLogger()
Definition manager.h:107
ExecutablePContainer & getExecutables()
Definition manager.h:85
bool detachStdout(unsigned int id)
Definition manager.cpp:1389
void onCnnFailed(void *which) override
Definition manager.cpp:1417
bool addModule(const char *szFileName)
Definition manager.cpp:128
bool updateConnection(unsigned int id, const char *from, const char *to, const char *carrier)
Definition manager.cpp:457
void disableRestrictedMode()
Definition manager.h:95
bool attachStdout(unsigned int id)
Definition manager.cpp:1367
void setDefaultBroker(const char *szBroker)
Definition manager.h:83
bool removeModule(const char *szModName)
Definition manager.cpp:203
CnnContainer & getConnections()
Definition manager.h:88
ResourcePContainer & getResources()
Definition manager.h:89
bool existPortFrom(unsigned int id)
Definition manager.cpp:732
bool addModules(const char *szPath)
Definition manager.cpp:142
const char * getApplicationName()
Definition manager.h:90
bool addResources(const char *szPath)
Definition manager.cpp:171
Node * getNode(std::string appName)
Definition manager.cpp:484
bool addApplication(const char *szFileName, char **szAppName_=nullptr, bool modifyName=false)
Definition manager.cpp:91
bool exist(unsigned int id)
Definition manager.cpp:490
bool existPortTo(unsigned int id)
Definition manager.cpp:753
void onError(void *which) override
Definition manager.cpp:1418
void disableAutoDependency()
Definition manager.h:99
bool switchBroker(size_t id)
Definition manager.cpp:296
bool addResource(const char *szFileName)
Definition manager.cpp:156
bool updateExecutable(unsigned int id, const char *szparam, const char *szhost, const char *szstdio, const char *szworkdir, const char *szenv)
Definition manager.cpp:431
void collectYarprunProcessesByHost(std::map< std::string, ProcessContainer > &hostProcesses, std::map< std::string, bool > &hostQueryOk)
Definition manager.cpp:1283
bool waitingModuleKill(unsigned int id)
Definition manager.cpp:712
void enableAutoDependency()
Definition manager.h:98
bool waitingModuleStop(unsigned int id)
Definition manager.cpp:694
bool removeResource(const char *szResName)
Definition manager.cpp:221
bool addApplications(const char *szPath)
Definition manager.cpp:111
void onExecutableFailed(void *which) override
Definition manager.cpp:1415
bool loadApplication(const char *szAppName)
Definition manager.cpp:241
bool exportDependencyGraph(const char *szFileName)
Definition manager.h:102
bool saveApplication(const char *szAppName, const char *fileName=nullptr)
Definition manager.cpp:267
KnowledgeBase * getKnowledgeBase()
Definition manager.h:106
void onCnnStablished(void *which) override
Definition manager.cpp:1413
bool waitingModuleRun(unsigned int id)
Definition manager.cpp:674
void disableAutoConnect()
Definition manager.h:97
Executable * getExecutableById(size_t id)
Definition manager.cpp:284
void enableRestrictedMode()
Definition manager.h:94
void onExecutableStart(void *which) override
Definition manager.cpp:1411
Class Module.
Definition module.h:99
a Node of a Graph
Definition node.h:64
std::vector< Executable * > ExecutablePContainer
Definition executable.h:166
std::vector< Module * > ModulePContainer
Definition module.h:230
std::vector< GenericResource * > ResourcePContainer
Definition resource.h:58
std::vector< Connection > CnnContainer