ProcessSpawnManager.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */


#ifndef _MIRA_PROCESSSPAWNMANAGER_H_
#define _MIRA_PROCESSSPAWNMANAGER_H_

#include <vector>

#include <platform/Process.h>
#include <utils/Path.h>

namespace mira {


class ProcessSpawnManager
{
public:

    struct ProcessInfo
    {
        ~ProcessInfo();

        std::string getName() const;

        Process process;

        std::string name;
        std::string pid;
        bool respawn;
        bool required;

        // infos for respawn
        bool shutdownRecursively;
        Path executable; // the used executable
        std::vector<std::string> args; // arguments of the process
        boost::optional<Process::Environment> env;
        std::string cleanup_cmd;
    };
    typedef boost::shared_ptr<ProcessInfo> ProcessInfoPtr;

    std::vector<ProcessInfoPtr> mProcesses;

    boost::thread mWatchdogThread;
    boost::mutex mMutex;

    typedef boost::function<void(const ProcessInfo& p)> RequiredProcessTerminatedFn;

    RequiredProcessTerminatedFn mRequiredProcessTerminatedFn;

public:
    ~ProcessSpawnManager();

    void startProcess(const Path& executable, const std::vector<std::string>& args,
                      const std::string& name = "",
                      bool respawn=false, bool required=false,
                      bool shutdownRecursively=false,
                      boost::optional<Process::Environment> env = boost::none,
                      const std::string& cleanupCmd="");

    void startWatchdog(RequiredProcessTerminatedFn fn = RequiredProcessTerminatedFn());

private:
    void watchdog();
};


} // namespace

#endif