PidStopperLinux.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
5  *
6  * ArmarX is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * ArmarX is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  *
18  * @package ArmarXCore::core
19  * @author Nicola Miskowiec
20  * @date 2016
21  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
22  * GNU General Public License
23  */
24 
25 
26 #pragma once
27 
28 #include "../data_structure/ApplicationInstance.h"
29 #include "ApplicationStopper.h"
30 
31 namespace ScenarioManager::Exec
32 {
33  /**
34  * @class PidStopperLinux
35  * @ingroup exec
36  * @brief Stops or kills applications on Linux based on their pid.
37  * This ApplicationStopper stops (kill -15) or kills (kill -9) application processes on Linux.
38  * It should not be used on other operating systems, due to the usage of system calls.
39  */
41  {
42 
43  public:
44  /**
45  * Stops an application based on its pid. Uses kill -15.
46  * @param application application to be killed
47  */
48  void stop(Data_Structure::ApplicationInstancePtr application) override;
49 
50  virtual void removeApplication(Data_Structure::ApplicationInstancePtr application, StatusManager statusManager);
51  virtual void removeScenario(Data_Structure::ScenarioPtr scenario, StatusManager statusManager);
52 
53  /**
54  * Kills an application based on its pid. Uses kill -9.
55  * @param application application to be killed
56  */
57  void kill(Data_Structure::ApplicationInstancePtr application) override;
58  };
59 
60 }
ScenarioManager::Exec::PidStopperLinux::removeScenario
virtual void removeScenario(Data_Structure::ScenarioPtr scenario, StatusManager statusManager)
Definition: PidStopperLinux.cpp:65
ScenarioManager::Data_Structure::ApplicationInstancePtr
std::shared_ptr< ApplicationInstance > ApplicationInstancePtr
Definition: ApplicationInstance.h:33
ScenarioManager::Data_Structure::ScenarioPtr
std::shared_ptr< Scenario > ScenarioPtr
Definition: Scenario.h:36
ScenarioManager::Exec
Definition: ApplicationStarter.h:35
ScenarioManager::Exec::PidStopperLinux::removeApplication
virtual void removeApplication(Data_Structure::ApplicationInstancePtr application, StatusManager statusManager)
Definition: PidStopperLinux.cpp:60
ScenarioManager::StatusManager
Definition: StatusManager.h:7
ScenarioManager::Exec::PidStopperLinux::stop
void stop(Data_Structure::ApplicationInstancePtr application) override
Stops an application based on its pid.
Definition: PidStopperLinux.cpp:34
ScenarioManager::Exec::ApplicationStopper
Interface for classes that handle how application get stopped and killed.
Definition: ApplicationStopper.h:39
ApplicationStopper.h
ScenarioManager::Exec::PidStopperLinux
Stops or kills applications on Linux based on their pid. This ApplicationStopper stops (kill -15) or ...
Definition: PidStopperLinux.h:40
ScenarioManager::Exec::PidStopperLinux::kill
void kill(Data_Structure::ApplicationInstancePtr application) override
Kills an application based on its pid.
Definition: PidStopperLinux.cpp:47