mtsManagerGlobalInterface.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):  Min Yang Jung
  Created on: 2009-11-15

  (C) Copyright 2009-2011 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/

#ifndef _mtsManagerGlobalInterface_h
#define _mtsManagerGlobalInterface_h

#include <cisstCommon/cmnClassRegister.h>
#include <cisstMultiTask/mtsConfig.h>
#include <cisstMultiTask/mtsInterfaceCommon.h>
#include <cisstMultiTask/mtsParameterTypes.h>

class CISST_EXPORT mtsManagerGlobalInterface : public cmnGenericObject
{
    CMN_DECLARE_SERVICES(CMN_NO_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);

public:
    //-------------------------------------------------------------------------
    //  Process Management
    //-------------------------------------------------------------------------
    virtual bool AddProcess(const std::string & processName) = 0;

    virtual bool FindProcess(const std::string & processName) const = 0;

    virtual bool RemoveProcess(const std::string & processName, const bool networkDisconnect) = 0;

    //-------------------------------------------------------------------------
    //  Component Management
    //-------------------------------------------------------------------------
    virtual bool AddComponent(const std::string & processName, const std::string & componentName) = 0;

    virtual bool FindComponent(const std::string & processName, const std::string & componentName) const = 0;

    virtual bool RemoveComponent(const std::string & processName, const std::string & componentName, const bool lock = true) = 0;

    //-------------------------------------------------------------------------
    //  Interface Management
    //-------------------------------------------------------------------------
    virtual bool AddInterfaceProvidedOrOutput(const std::string & processName, const std::string & componentName, const std::string & interfaceName) = 0;

    virtual bool AddInterfaceRequiredOrInput(const std::string & processName, const std::string & componentName, const std::string & interfaceName) = 0;

    virtual bool FindInterfaceProvidedOrOutput(const std::string & processName, const std::string & componentName,
                                               const std::string & interfaceName) const = 0;

    virtual bool FindInterfaceRequiredOrInput(const std::string & processName, const std::string & componentName,
                                              const std::string & interfaceName) const = 0;

    virtual bool RemoveInterfaceProvidedOrOutput(const std::string & processName, const std::string & componentName,
                                                 const std::string & interfaceName, const bool lock = true) = 0;

    virtual bool RemoveInterfaceRequiredOrInput(const std::string & processName, const std::string & componentName,
                                                const std::string & interfaceName, const bool lock = true) = 0;

    //-------------------------------------------------------------------------
    //  Connection Management
    //-------------------------------------------------------------------------
    virtual ConnectionIDType Connect(const std::string & requestProcessName,
        const std::string & clientProcessName, const std::string & clientComponentName, const std::string & clientInterfaceRequiredName,
        const std::string & serverProcessName, const std::string & serverComponentName, const std::string & serverInterfaceProvidedName) = 0;

    virtual bool ConnectConfirm(const ConnectionIDType connectionID) = 0;

    virtual bool Disconnect(const ConnectionIDType connectionID) = 0;

    virtual bool Disconnect(
        const std::string & clientProcessName, const std::string & clientComponentName, const std::string & clientInterfaceRequiredName,
        const std::string & serverProcessName, const std::string & serverComponentName, const std::string & serverInterfaceProvidedName) = 0;

    virtual bool InitiateConnect(const ConnectionIDType connectionID) = 0;

    virtual bool ConnectServerSideInterfaceRequest(const ConnectionIDType connectionID) = 0;

    virtual void GetListOfConnections(std::vector<mtsDescriptionConnection> & list) const = 0;

    //-------------------------------------------------------------------------
    //  Networking
    //-------------------------------------------------------------------------
    virtual bool SetInterfaceProvidedProxyAccessInfo(const ConnectionIDType connectionID, const std::string & endpointInfo) = 0;

    virtual bool GetInterfaceProvidedProxyAccessInfo(const ConnectionIDType connectionID, std::string & endpointInfo) = 0;

    virtual bool GetInterfaceProvidedProxyAccessInfo(const std::string & clientProcessName,
        const std::string & serverProcessName, const std::string & serverComponentName, 
        const std::string & serverInterfaceProvidedName, std::string & endpointInfo) = 0;
};

CMN_DECLARE_SERVICES_INSTANTIATION(mtsManagerGlobalInterface)

#endif // _mtsManagerGlobalInterface_h