1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/*
This file is part of GNUnet.
Copyright (C) 2001-2013 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @addtogroup libgnunetutil
* Multi-function utilities library for GNUnet programs
* @{
*
* @author Christian Grothoff
*
* @file
* Functions related to starting programs
*
* @defgroup program Program library
* Start command-line programs.
* @{
*/
#ifndef GNUNET_PROGRAM_LIB_H
#define GNUNET_PROGRAM_LIB_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "gnunet_configuration_lib.h"
#include "gnunet_getopt_lib.h"
#include "gnunet_scheduler_lib.h"
/**
* Main function that will be run.
*
* @param cls closure
* @param args remaining command-line arguments
* @param cfgfile name of the configuration file used (for saving, can be NULL!)
* @param cfg configuration
*/
typedef void
(*GNUNET_PROGRAM_Main) (void *cls,
char *const *args,
const char *cfgfile,
const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
* Run a standard GNUnet command startup sequence (initialize loggers
* and configuration, parse options).
*
* @param argc number of command line arguments in @a argv
* @param argv command line arguments
* @param binaryName our expected name
* @param binaryHelp help text for the program
* @param options command line options
* @param task main function to run
* @param task_cls closure for @a task
* @param run_without_scheduler #GNUNET_NO start the scheduler,
* #GNUNET_YES do not start the scheduler just run the main task
* @return #GNUNET_SYSERR on error,
* #GNUNET_NO if successful option processing called
* for the program to terminate,
* #GNUNET_OK on success (#a task was invoked)
*/
enum GNUNET_GenericReturnValue
GNUNET_PROGRAM_run2 (int argc,
char *const *argv,
const char *binaryName,
const char *binaryHelp,
const struct GNUNET_GETOPT_CommandLineOption *options,
GNUNET_PROGRAM_Main task,
void *task_cls,
int run_without_scheduler);
/**
* Run a standard GNUnet command startup sequence (initialize loggers
* and configuration, parse options).
*
* @param argc number of command line arguments
* @param argv command line arguments
* @param binaryName our expected name
* @param binaryHelp helptext for "-h" option (about the app)
* @param options command line options
* @param task main function to run
* @param task_cls closure for @a task
* @return #GNUNET_SYSERR on error,
* #GNUNET_NO if successful option processing called
* for the program to terminate,
* #GNUNET_OK on success (#a task was invoked)
*/
enum GNUNET_GenericReturnValue
GNUNET_PROGRAM_run (int argc,
char *const *argv,
const char *binaryName,
const char *binaryHelp,
const struct GNUNET_GETOPT_CommandLineOption *options,
GNUNET_PROGRAM_Main task,
void *task_cls);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef GNUNET_PROGRAM_LIB_H */
#endif
/** @} */ /* end of group program */
/** @} */ /* end of group addition */
/* end of gnunet_program_lib.h */
|
