2 This file is part of GNUnet.
3 (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 2, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_program_lib.h
23 * @brief functions related to starting programs
24 * @author Christian Grothoff
27 #ifndef GNUNET_PROGRAM_LIB_H
28 #define GNUNET_PROGRAM_LIB_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_configuration_lib.h"
39 #include "gnunet_getopt_lib.h"
40 #include "gnunet_scheduler_lib.h"
43 * Main function that will be run.
46 * @param sched the scheduler to use
47 * @param args remaining command-line arguments
48 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
49 * @param cfg configuration
51 typedef void (*GNUNET_PROGRAM_Main) (void *cls,
52 struct GNUNET_SCHEDULER_Handle * sched,
55 const struct GNUNET_CONFIGURATION_Handle *
60 * Run a standard GNUnet command startup sequence (initialize loggers
61 * and configuration, parse options).
63 * @param argc number of command line arguments
64 * @param argv command line arguments
65 * @param binaryName our expected name
66 * @param binaryHelp helptext for "-h" option (about the app)
67 * @param options command line options
68 * @param task main function to run
69 * @param task_cls closure for task
70 * @return GNUNET_SYSERR on error, GNUNET_OK on success
72 int GNUNET_PROGRAM_run (int argc,
74 const char *binaryName,
75 const char *binaryHelp,
76 const struct GNUNET_GETOPT_CommandLineOption *options,
77 GNUNET_PROGRAM_Main task, void *task_cls);
81 #if 0 /* keep Emacsens' auto-indent happy */
88 /* ifndef GNUNET_PROGRAM_LIB_H */
90 /* end of gnunet_program_lib.h */