D-Bus  1.13.7
dbus-spawn.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-spawn.h Wrapper around fork/exec
3  *
4  * Copyright (C) 2002, 2003 Red Hat, Inc.
5  * Copyright (C) 2003 CodeFactory AB
6  *
7  * Licensed under the Academic Free License version 2.1
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  *
23  */
24 
25 #ifndef DBUS_SPAWN_H
26 #define DBUS_SPAWN_H
27 
28 #include <dbus/dbus-string.h>
29 #include <dbus/dbus-errors.h>
30 #include <dbus/dbus-watch.h>
31 
33 
34 typedef void (* DBusSpawnChildSetupFunc) (void *user_data);
35 
36 typedef struct DBusBabysitter DBusBabysitter;
37 
38 typedef void (* DBusBabysitterFinishedFunc) (DBusBabysitter *sitter,
39  void *user_data);
40 
41 typedef enum {
42  DBUS_SPAWN_REDIRECT_OUTPUT = (1 << 0),
43  DBUS_SPAWN_SILENCE_OUTPUT = (1 << 1),
44  DBUS_SPAWN_NONE = 0
45 } DBusSpawnFlags;
46 
48  const char *log_name,
49  char * const *argv,
50  char **env,
51  DBusSpawnFlags flags,
52  DBusSpawnChildSetupFunc child_setup,
53  void *user_data,
54  DBusError *error);
55 void _dbus_babysitter_set_result_function (DBusBabysitter *sitter,
56  DBusBabysitterFinishedFunc finished,
57  void *user_data);
63  DBusError *error);
65  int *status);
67  DBusAddWatchFunction add_function,
68  DBusRemoveWatchFunction remove_function,
69  DBusWatchToggledFunction toggled_function,
70  void *data,
71  DBusFreeFunction free_data_function);
72 void _dbus_babysitter_block_for_child_exit (DBusBabysitter *sitter);
73 
75 
76 #endif /* DBUS_SPAWN_H */
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:63
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
void(* DBusWatchToggledFunction)(DBusWatch *watch, void *data)
Called when dbus_watch_get_enabled() may return a different value than it did before.
int status
Exit status code.
dbus_bool_t _dbus_babysitter_get_child_exited(DBusBabysitter *sitter)
Checks whether the child has exited, without blocking.
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
dbus_bool_t _dbus_babysitter_get_child_exit_status(DBusBabysitter *sitter, int *status)
Gets the exit status of the child.
void _dbus_babysitter_kill_child(DBusBabysitter *sitter)
Blocks until the babysitter process gives us the PID of the spawned grandchild, then kills the spawne...
Babysitter implementation details.
dbus_bool_t _dbus_spawn_async_with_babysitter(DBusBabysitter **sitter_p, const char *log_name, char *const *argv, char **env, DBusSpawnFlags flags, DBusSpawnChildSetupFunc child_setup, void *user_data, DBusError *error)
Spawns a new process.
dbus_bool_t _dbus_babysitter_set_watch_functions(DBusBabysitter *sitter, DBusAddWatchFunction add_function, DBusRemoveWatchFunction remove_function, DBusWatchToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function)
Sets watch functions to notify us when the babysitter object needs to read/write file descriptors...
Object representing an exception.
Definition: dbus-errors.h:48
dbus_bool_t(* DBusAddWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus needs a new watch to be monitored by the main loop.
void(* DBusRemoveWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus no longer needs a watch to be monitored by the main loop.
void _dbus_babysitter_unref(DBusBabysitter *sitter)
Decrement the reference count on the babysitter object.
char * log_name
the name under which to log messages about this process being spawned
void _dbus_babysitter_set_child_exit_error(DBusBabysitter *sitter, DBusError *error)
Sets the DBusError with an explanation of why the spawned child process exited (on a signal...
DBusBabysitter * _dbus_babysitter_ref(DBusBabysitter *sitter)
Increment the reference count on the babysitter object.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.