DABC (Data Acquisition Backbone Core)  2.9.9
api.h
Go to the documentation of this file.
1 // $Id: api.h 4074 2018-09-03 12:59:19Z adamczew $
2 
3 /************************************************************
4  * The Data Acquisition Backbone Core (DABC) *
5  ************************************************************
6  * Copyright (C) 2009 - *
7  * GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
8  * Planckstr. 1, 64291 Darmstadt, Germany *
9  * Contact: http://dabc.gsi.de *
10  ************************************************************
11  * This software can be used under the GPL license *
12  * agreements as stated in LICENSE.txt file *
13  * which is part of the distribution. *
14  ************************************************************/
15 
16 #ifndef DABC_api
17 #define DABC_api
18 
19 #ifndef DABC_Hierarchy
20 #include "dabc/Hierarchy.h"
21 #endif
22 
23 namespace dabc {
24 
30  extern bool CreateManager(const std::string &name, int cmd_port = -1);
31 
34  extern bool InstallSignalHandlers();
35 
37  extern bool CtrlCPressed();
38 
41  extern bool DestroyManager();
42 
44  extern std::string MakeNodeName(const std::string &arg);
45 
49  extern bool ConnectDabcNode(const std::string &nodeaddr);
50 
52  extern Hierarchy GetNodeHierarchy(const std::string &nodeaddr);
53 }
54 
55 #endif
Represents objects hierarchy of remote (or local) DABC process.
Definition: Hierarchy.h:285
Event manipulation API.
Definition: api.h:23
bool InstallSignalHandlers()
Method is used to install DABC-specific Ctrl-C handler It allows to correctly stop program execution ...
Definition: api.cxx:83
bool CtrlCPressed()
Returns true when CtrlC was pressed in handler.
Definition: api.cxx:106
Hierarchy GetNodeHierarchy(const std::string &nodeaddr)
Function request hierarchy of objects on remote node.
Definition: api.cxx:162
bool CreateManager(const std::string &name, int cmd_port=-1)
Function should be used to create manager instance.
Definition: api.cxx:26
bool DestroyManager()
Function can be used to destroy manager.
Definition: api.cxx:112
std::string MakeNodeName(const std::string &arg)
Function creates node name, which can be supplied as receiver of dabc commands.
Definition: api.cxx:124
bool ConnectDabcNode(const std::string &nodeaddr)
Function establish connection with specified dabc node.
Definition: api.cxx:135