Open Lighting Architecture  Latest Git
Init.h
Go to the documentation of this file.
1 /*
2  * This library is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU Lesser General Public
4  * License as published by the Free Software Foundation; either
5  * version 2.1 of the License, or (at your option) any later version.
6  *
7  * This library is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10  * Lesser General Public License for more details.
11  *
12  * You should have received a copy of the GNU Lesser General Public
13  * License along with this library; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15  *
16  * Init.h
17  * A grab bag of functions useful for programs.
18  * Copyright (C) 2012 Simon Newton
19  */
20 
44 #ifndef INCLUDE_OLA_BASE_INIT_H_
45 #define INCLUDE_OLA_BASE_INIT_H_
46 
47 #include <ola/ExportMap.h>
48 #include <ola/Callback.h>
49 #include <string>
50 
51 namespace ola {
72 bool ServerInit(int argc, char *argv[], ExportMap *export_map);
73 
88 bool ServerInit(int *argc,
89  char *argv[],
90  ExportMap *export_map,
91  const std::string &first_line,
92  const std::string &description);
93 
107 bool AppInit(int *argc,
108  char *argv[],
109  const std::string &first_line,
110  const std::string &description);
111 
119 bool NetworkInit();
120 
127 bool InstallSignal(int signal, void(*fp)(int signo));
128 
135 bool InstallSEGVHandler();
136 
148 void InitExportMap(int argc, char* argv[], ExportMap *export_map);
149 
163 void Daemonise();
164 
168 void ClockInit();
170 } // namespace ola
171 #endif // INCLUDE_OLA_BASE_INIT_H_
bool InstallSEGVHandler()
Install signal handlers to deal with SIGBUS & SIGSEGV.
Definition: Init.cpp:278
Export variables on the http server.
void InitExportMap(int argc, char *argv[], ExportMap *export_map)
Populate the ExportMap with a couple of basic variables.
Definition: Init.cpp:291
bool NetworkInit()
Perform platform-specific initialization of the networking subsystem.
Definition: Init.cpp:242
bool ServerInit(int argc, char *argv[], ExportMap *export_map)
Used to initialize a server.
Definition: Init.cpp:190
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
void ClockInit()
Logs status of clock capabilities.
Definition: Init.cpp:395
bool AppInit(int *argc, char *argv[], const string &first_line, const string &description)
Used to initialize a application. Installs the SEGV handler and initializes the random number generat...
Definition: Init.cpp:221
bool InstallSignal(int sig, void(*fp)(int signo))
Install a signal handler.
Definition: Init.cpp:258
void Daemonise()
Run as a daemon.
Definition: Init.cpp:323