broker.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_MANAGER_BROKER
#define YARP_MANAGER_BROKER
 
#include <string>
#include <vector>
 
#include <yarp/manager/ymm-types.h>
 
 
namespace yarp::manager {
 
 
class BrokerEventSink
{
public:
    virtual ~BrokerEventSink() {}
    virtual void onBrokerStdout(const char* msg) {}
    virtual void onBrokerModuleFailed() {}
};
 
 
class Broker {
 
public:
    Broker();
    virtual ~Broker();
    void setEventSink(BrokerEventSink* pEventSink);
    virtual bool init() = 0; //only connector
    virtual bool init(const char* szcmd, const char* szparam,
            const char* szhost, const char* szstdio,
            const char* szworkdir, const char* szenv ) = 0;
    virtual void fini() = 0;
    virtual bool start() = 0;
    virtual bool stop() = 0;
    virtual bool kill() = 0;
    virtual bool connect(const std::string& from, const std::string& to, const std::string& carrier, bool persist = false) = 0;
    virtual bool disconnect(const std::string& from, const std::string& to, const std::string& carrier) = 0;
    virtual int  running() = 0; // 0 if is not running and 1 if is running; otherwise -1.
    virtual bool exists(const std::string& port) = 0;
    virtual std::string requestRpc(const std::string& szport, const std::string& request, double timeout = 0.0) = 0;
    virtual bool connected(const std::string& from, const std::string& to, const std::string& carrier) = 0;
    virtual std::string error() = 0;
    virtual bool initialized() = 0;
    virtual bool attachStdout() = 0;
    virtual void detachStdout() = 0;
 
    unsigned int generateID();
 
    void enableWatchDog() { bWithWatchDog = true; }
    void disableWatchDog() { bWithWatchDog = false; }
    bool hasWatchDog() { return bWithWatchDog; }
    void setDisplay(const char* szDisplay) { if(szDisplay) { strDisplay = szDisplay; } }
 
    std::string getDisplay() const {return strDisplay; }
protected:
    unsigned int UNIQUEID;
    BrokerEventSink* eventSink;
    bool bWithWatchDog;
    std::string strDisplay;
 
private:
 
};
 
} // namespace yarp::manager
 
 
#endif // __YARP_MANAGER_BROKER__