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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef _CLPLUMBING_GSOURCE_H
# define _CLPLUMBING_GSOURCE_H
# include <clplumbing/ipc.h>
typedef struct GFDSource_s GFDSource;
typedef struct GCHSource_s GCHSource;
typedef struct GWCSource_s GWCSource;
typedef struct GSIGSource_s GSIGSource;
typedef struct GTRIGSource_s GTRIGSource;
void G_main_setmaxdispatchdelay(GSource* s, unsigned long delayms);
void G_main_setmaxdispatchtime(GSource* s, unsigned long dispatchms);
void G_main_setdescription(GSource* s, const char * description);
void G_main_setmaxdispatchdelay_id(guint id, unsigned long delayms);
void G_main_setmaxdispatchtime_id(guint id, unsigned long dispatchms);
void G_main_setdescription_id(guint id, const char * description);
void G_main_setall_id(guint id, const char * description, unsigned long delayms, unsigned long dispatchms);
/***********************************************************************
* Functions for interfacing input to the mainloop
***********************************************************************/
GSource*
G_main_add_input(int priority,
gboolean can_recurse,
GSourceFuncs* funcs);
/***********************************************************************
* Functions for interfacing "raw" file descriptors to the mainloop
***********************************************************************/
/*
* Add a file descriptor to the gmainloop world...
*/
GFDSource* G_main_add_fd(int priority, int fd, gboolean can_recurse
, gboolean (*dispatch)(int fd, gpointer user_data)
, gpointer userdata
, GDestroyNotify notify);
/*
* Delete a file descriptor from the gmainloop world...
* Note: destroys the GFDSource object.
*/
gboolean G_main_del_fd(GFDSource* fdp);
/*
* Notify us that a file descriptor is blocked on output.
* (i.e., we should poll for output events)
*/
void g_main_output_is_blocked(GFDSource* fdp);
/**************************************************************
* Functions for interfacing IPC_Channels to the mainloop
**************************************************************/
/*
* Add an IPC_channel to the gmainloop world...
*/
GCHSource* G_main_add_IPC_Channel(int priority, IPC_Channel* ch
, gboolean can_recurse
, gboolean (*dispatch)(IPC_Channel* source_data
, gpointer user_data)
, gpointer userdata
, GDestroyNotify notify);
/*
* the events in this source is paused/resumed
*/
void G_main_IPC_Channel_pause(GCHSource* chp);
void G_main_IPC_Channel_resume(GCHSource* chp);
/*
* Delete an IPC_channel from the gmainloop world...
* Note: destroys the GCHSource object, and the IPC_Channel
* object automatically.
*/
gboolean G_main_del_IPC_Channel(GCHSource* chp);
/*
* Set the destroy notify function
*
*/
void set_IPC_Channel_dnotify(GCHSource* chp,
GDestroyNotify notify);
/*********************************************************************
* Functions for interfacing IPC_WaitConnections to the mainloop
********************************************************************/
/*
* Add an IPC_WaitConnection to the gmainloop world...
* Note that the dispatch function is called *after* the
* connection is accepted.
*/
GWCSource* G_main_add_IPC_WaitConnection(int priority, IPC_WaitConnection* ch
, IPC_Auth* auth_info
, gboolean can_recurse
, gboolean (*dispatch)(IPC_Channel* source_data
, gpointer user_data)
, gpointer userdata
, GDestroyNotify notify);
/*
* Delete an IPC_WaitConnection from the gmainloop world...
* Note: destroys the GWCSource object, and the IPC_WaitConnection
* object automatically.
*/
gboolean G_main_del_IPC_WaitConnection(GWCSource* wcp);
/**************************************************************
* Functions for interfacing Signals to the mainloop
**************************************************************/
/*
* Add an Signal to the gmainloop world...
*/
GSIGSource* G_main_add_SignalHandler(
int priority, int signal,
gboolean (*dispatch)(int nsig, gpointer user_data),
gpointer userdata, GDestroyNotify notify);
/*
* Delete an signal from the gmainloop world...
* Note: destroys the GSIGSource object, and the removes the
* Signal Handler automatically.
*/
gboolean G_main_del_SignalHandler(GSIGSource* chp);
/*
* Set the destroy notify function
*
*/
void set_SignalHandler_dnotify(GSIGSource* chp, GDestroyNotify notify);
/* manage child process death using sig source*/
#define DEFAULT_MAXDISPATCHTIME 30 /* in ms */
void set_sigchld_proctrack(int priority, unsigned long maxdisptime);
/**************************************************************
* Functions for interfacing Manual triggers to the mainloop
**************************************************************/
/*
* Add an Trigger to the gmainloop world...
*/
GTRIGSource* G_main_add_TriggerHandler(
int priority, gboolean (*dispatch)(gpointer user_data),
gpointer userdata, GDestroyNotify notify);
/*
* Delete an signal from the gmainloop world...
* Note: destroys the GTRIGSource object, and the removes the
* Trigger Handler automatically.
*/
gboolean G_main_del_TriggerHandler(GTRIGSource* chp);
/*
* Set the destroy notify function
*
*/
void set_TriggerHandler_dnotify(GTRIGSource* chp, GDestroyNotify notify);
void G_main_set_trigger(GTRIGSource* man_src);
/*
* Create a trigger for triggering an action in a short-lived (temporary)
* child process.
*
* The name isn't wonderful, but we couldn't think of a better one.
*/
GTRIGSource* G_main_add_tempproc_trigger(int priority
, int (*fun)(gpointer p) /* What to do? */
/* Called in child process */
, const char * procname /* What do we call this process? */
, gpointer userdata /* Passed to 'triggerfun' */
, void (*prefork)(gpointer p) /* Called before fork */
, void (*postfork)(gpointer p) /* Called by parent process
* after fork(2) call.
* Each has 'userdata'
* passed to it.
*/
, void (*complete)(gpointer p, int status, int signo, int exitcode)); /* called after the child process completes */
/*
* Special notes:
* - No more than one child process will be active at a time per trigger
* object.
*
* - If you trigger the action while this object has a child active,
* then it will be re-triggered after the currently running child
* completes. There is no necessary correlation between the
* number of times a the action is triggered and how many
* times it is executed. What is guaranteed is that after you
* trigger the action, it will happen (at least) once - as soon
* as the scheduler gets around to it at the priority you've
* assigned it. But if several are triggered while a child
* process is running, only one process will be instantiated to
* take the action requested by all the trigger calls.
*
* - Child processes are forked off at the priority of the trigger,
* not the priority of the SIGCHLD handler.
*
* - This is useful for writing out updates to a file for example.
* While we're writing one copy out, subsequent updates are
* held off until this one completes. When it completes, then
* the file is written again - but not "n" times - just the
* latest version available at the time the trigger is
* activated (run).
*/
#endif
|
