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
|
/**
* @file eventloop.h Purple Event Loop API
* @ingroup core
*
* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _PURPLE_EVENTLOOP_H_
#define _PURPLE_EVENTLOOP_H_
#include <glib.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* An input condition.
*/
typedef enum
{
PURPLE_INPUT_READ = 1 << 0, /**< A read condition. */
PURPLE_INPUT_WRITE = 1 << 1 /**< A write condition. */
} PurpleInputCondition;
typedef void (*PurpleInputFunction)(gpointer, gint, PurpleInputCondition);
typedef struct _PurpleEventLoopUiOps PurpleEventLoopUiOps;
struct _PurpleEventLoopUiOps
{
/**
* Creates a callback timer with an interval measured in milliseconds.
* @see g_timeout_add, purple_timeout_add
**/
guint (*timeout_add)(guint interval, GSourceFunc function, gpointer data);
/**
* Removes a callback timer.
* @see purple_timeout_remove, g_source_remove
*/
gboolean (*timeout_remove)(guint handle);
/**
* Adds an input handler.
* @see purple_input_add, g_io_add_watch_full
*/
guint (*input_add)(int fd, PurpleInputCondition cond,
PurpleInputFunction func, gpointer user_data);
/**
* Removes an input handler.
* @see purple_input_remove, g_source_remove
*/
gboolean (*input_remove)(guint handle);
/**
* Get the current error status for an input.
* Implementation of this UI op is optional. Implement it if the UI's sockets
* or event loop needs to customize determination of socket error status.
* @see purple_input_get_error, getsockopt
*/
int (*input_get_error)(int fd, int *error);
/**
* Creates a callback timer with an interval measured in seconds.
*
* This allows UIs to group timers for better power efficiency. For
* this reason, @a interval may be rounded by up to a second.
*
* Implementation of this UI op is optional. If it's not implemented,
* calls to purple_timeout_add_seconds() will be serviced by the
* timeout_add UI op.
*
* @see g_timeout_add_seconds, purple_timeout_add_seconds()
**/
guint (*timeout_add_seconds)(guint interval, GSourceFunc function, gpointer data);
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
};
/**************************************************************************/
/** @name Event Loop API */
/**************************************************************************/
/*@{*/
/**
* Creates a callback timer.
*
* The timer will repeat until the function returns @c FALSE. The
* first call will be at the end of the first interval.
*
* If the timer is in a multiple of seconds, use purple_timeout_add_seconds()
* instead as it allows UIs to group timers for power efficiency.
*
* @param interval The time between calls of the function, in
* milliseconds.
* @param function The function to call.
* @param data data to pass to @a function.
* @return A handle to the timer which can be passed to
* purple_timeout_remove to remove the timer.
*/
guint purple_timeout_add(guint interval, GSourceFunc function, gpointer data);
/**
* Creates a callback timer.
*
* The timer will repeat until the function returns @c FALSE. The
* first call will be at the end of the first interval.
*
* This function allows UIs to group timers for better power efficiency. For
* this reason, @a interval may be rounded by up to a second.
*
* @param interval The time between calls of the function, in
* seconds.
* @param function The function to call.
* @param data data to pass to @a function.
* @return A handle to the timer which can be passed to
* purple_timeout_remove to remove the timer.
*/
guint purple_timeout_add_seconds(guint interval, GSourceFunc function, gpointer data);
/**
* Removes a timeout handler.
*
* @param handle The handle, as returned by purple_timeout_add.
*
* @return Something.
*/
gboolean purple_timeout_remove(guint handle);
/**
* Adds an input handler.
*
* @param fd The input file descriptor.
* @param cond The condition type.
* @param func The callback function for data.
* @param user_data User-specified data.
*
* @return The resulting handle (will be greater than 0).
* @see g_io_add_watch_full
*/
guint purple_input_add(int fd, PurpleInputCondition cond,
PurpleInputFunction func, gpointer user_data);
/**
* Removes an input handler.
*
* @param handle The handle of the input handler. Note that this is the return
* value from purple_input_add, <i>not</i> the file descriptor.
*/
gboolean purple_input_remove(guint handle);
/**
* Get the current error status for an input.
* The return value and error follow getsockopt() with a level of SOL_SOCKET and an
* option name of SO_ERROR, and this is how the error is determined if the UI does not
* implement the input_get_error UI op.
*
* @param fd The input file descriptor.
* @param error A pointer to an int which on return will have the error, or 0 if no error.
*
* @return 0 if there is no error; -1 if there is an error, in which case errno will be set.
*/
int
purple_input_get_error(int fd, int *error);
/*@}*/
/**************************************************************************/
/** @name UI Registration Functions */
/**************************************************************************/
/*@{*/
/**
* Sets the UI operations structure to be used for accounts.
*
* @param ops The UI operations structure.
*/
void purple_eventloop_set_ui_ops(PurpleEventLoopUiOps *ops);
/**
* Returns the UI operations structure used for accounts.
*
* @return The UI operations structure in use.
*/
PurpleEventLoopUiOps *purple_eventloop_get_ui_ops(void);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_EVENTLOOP_H_ */
|
