Mirror of :pserver:anonymous@cvs.schmorp.de/schmorpforge libev http://software.schmorp.de/pkg/libev.html
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

839 lines
27 KiB

13 years ago
9 years ago
13 years ago
13 years ago
13 years ago
11 years ago
10 years ago
13 years ago
13 years ago
13 years ago
13 years ago
10 years ago
9 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
13 years ago
13 years ago
13 years ago
12 years ago
13 years ago
13 years ago
13 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
10 years ago
12 years ago
12 years ago
13 years ago
13 years ago
9 years ago
13 years ago
13 years ago
13 years ago
13 years ago
13 years ago
  1. /*
  2. * libev native API header
  3. *
  4. * Copyright (c) 2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann <libev@schmorp.de>
  5. * All rights reserved.
  6. *
  7. * Redistribution and use in source and binary forms, with or without modifica-
  8. * tion, are permitted provided that the following conditions are met:
  9. *
  10. * 1. Redistributions of source code must retain the above copyright notice,
  11. * this list of conditions and the following disclaimer.
  12. *
  13. * 2. Redistributions in binary form must reproduce the above copyright
  14. * notice, this list of conditions and the following disclaimer in the
  15. * documentation and/or other materials provided with the distribution.
  16. *
  17. * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  18. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
  19. * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  20. * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
  21. * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  22. * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  23. * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24. * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
  25. * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  26. * OF THE POSSIBILITY OF SUCH DAMAGE.
  27. *
  28. * Alternatively, the contents of this file may be used under the terms of
  29. * the GNU General Public License ("GPL") version 2 or any later version,
  30. * in which case the provisions of the GPL are applicable instead of
  31. * the above. If you wish to allow the use of your version of this file
  32. * only under the terms of the GPL and not to allow others to use your
  33. * version of this file under the BSD license, indicate your decision
  34. * by deleting the provisions above and replace them with the notice
  35. * and other provisions required by the GPL. If you do not delete the
  36. * provisions above, a recipient may use your version of this file under
  37. * either the BSD or the GPL.
  38. */
  39. #ifndef EV_H_
  40. #define EV_H_
  41. #ifdef __cplusplus
  42. # define EV_CPP(x) x
  43. #else
  44. # define EV_CPP(x)
  45. #endif
  46. EV_CPP(extern "C" {)
  47. /*****************************************************************************/
  48. /* pre-4.0 compatibility */
  49. #ifndef EV_COMPAT3
  50. # define EV_COMPAT3 1
  51. #endif
  52. #ifndef EV_FEATURES
  53. # define EV_FEATURES 0x7f
  54. #endif
  55. #define EV_FEATURE_CODE ((EV_FEATURES) & 1)
  56. #define EV_FEATURE_DATA ((EV_FEATURES) & 2)
  57. #define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
  58. #define EV_FEATURE_API ((EV_FEATURES) & 8)
  59. #define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
  60. #define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
  61. #define EV_FEATURE_OS ((EV_FEATURES) & 64)
  62. /* these priorities are inclusive, higher priorities will be invoked earlier */
  63. #ifndef EV_MINPRI
  64. # define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
  65. #endif
  66. #ifndef EV_MAXPRI
  67. # define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
  68. #endif
  69. #ifndef EV_MULTIPLICITY
  70. # define EV_MULTIPLICITY EV_FEATURE_CONFIG
  71. #endif
  72. #ifndef EV_PERIODIC_ENABLE
  73. # define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
  74. #endif
  75. #ifndef EV_STAT_ENABLE
  76. # define EV_STAT_ENABLE EV_FEATURE_WATCHERS
  77. #endif
  78. #ifndef EV_PREPARE_ENABLE
  79. # define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
  80. #endif
  81. #ifndef EV_CHECK_ENABLE
  82. # define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
  83. #endif
  84. #ifndef EV_IDLE_ENABLE
  85. # define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
  86. #endif
  87. #ifndef EV_FORK_ENABLE
  88. # define EV_FORK_ENABLE EV_FEATURE_WATCHERS
  89. #endif
  90. #ifndef EV_CLEANUP_ENABLE
  91. # define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
  92. #endif
  93. #ifndef EV_SIGNAL_ENABLE
  94. # define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
  95. #endif
  96. #ifndef EV_CHILD_ENABLE
  97. # ifdef _WIN32
  98. # define EV_CHILD_ENABLE 0
  99. # else
  100. # define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
  101. #endif
  102. #endif
  103. #ifndef EV_ASYNC_ENABLE
  104. # define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
  105. #endif
  106. #ifndef EV_EMBED_ENABLE
  107. # define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
  108. #endif
  109. #ifndef EV_WALK_ENABLE
  110. # define EV_WALK_ENABLE 0 /* not yet */
  111. #endif
  112. /*****************************************************************************/
  113. #if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
  114. # undef EV_SIGNAL_ENABLE
  115. # define EV_SIGNAL_ENABLE 1
  116. #endif
  117. /*****************************************************************************/
  118. typedef double ev_tstamp;
  119. #ifndef EV_ATOMIC_T
  120. # include <signal.h>
  121. # define EV_ATOMIC_T sig_atomic_t volatile
  122. #endif
  123. #if EV_STAT_ENABLE
  124. # ifdef _WIN32
  125. # include <time.h>
  126. # include <sys/types.h>
  127. # endif
  128. # include <sys/stat.h>
  129. #endif
  130. /* support multiple event loops? */
  131. #if EV_MULTIPLICITY
  132. struct ev_loop;
  133. # define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
  134. # define EV_P_ EV_P, /* a loop as first of multiple parameters */
  135. # define EV_A loop /* a loop as sole argument to a function call */
  136. # define EV_A_ EV_A, /* a loop as first of multiple arguments */
  137. # define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
  138. # define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
  139. # define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
  140. # define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
  141. #else
  142. # define EV_P void
  143. # define EV_P_
  144. # define EV_A
  145. # define EV_A_
  146. # define EV_DEFAULT
  147. # define EV_DEFAULT_
  148. # define EV_DEFAULT_UC
  149. # define EV_DEFAULT_UC_
  150. # undef EV_EMBED_ENABLE
  151. #endif
  152. /* EV_INLINE is used for functions in header files */
  153. #if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
  154. # define EV_INLINE static inline
  155. #else
  156. # define EV_INLINE static
  157. #endif
  158. #ifdef EV_API_STATIC
  159. # define EV_API_DECL static
  160. #else
  161. # define EV_API_DECL extern
  162. #endif
  163. /* EV_PROTOTYPES can be used to switch of prototype declarations */
  164. #ifndef EV_PROTOTYPES
  165. # define EV_PROTOTYPES 1
  166. #endif
  167. /*****************************************************************************/
  168. #define EV_VERSION_MAJOR 4
  169. #define EV_VERSION_MINOR 11
  170. /* eventmask, revents, events... */
  171. enum {
  172. EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
  173. EV_NONE = 0x00, /* no events */
  174. EV_READ = 0x01, /* ev_io detected read will not block */
  175. EV_WRITE = 0x02, /* ev_io detected write will not block */
  176. EV__IOFDSET = 0x80, /* internal use only */
  177. EV_IO = EV_READ, /* alias for type-detection */
  178. EV_TIMER = 0x00000100, /* timer timed out */
  179. #if EV_COMPAT3
  180. EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
  181. #endif
  182. EV_PERIODIC = 0x00000200, /* periodic timer timed out */
  183. EV_SIGNAL = 0x00000400, /* signal was received */
  184. EV_CHILD = 0x00000800, /* child/pid had status change */
  185. EV_STAT = 0x00001000, /* stat data changed */
  186. EV_IDLE = 0x00002000, /* event loop is idling */
  187. EV_PREPARE = 0x00004000, /* event loop about to poll */
  188. EV_CHECK = 0x00008000, /* event loop finished poll */
  189. EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
  190. EV_FORK = 0x00020000, /* event loop resumed in child */
  191. EV_CLEANUP = 0x00040000, /* event loop resumed in child */
  192. EV_ASYNC = 0x00080000, /* async intra-loop signal */
  193. EV_CUSTOM = 0x01000000, /* for use by user code */
  194. EV_ERROR = 0x80000000 /* sent when an error occurs */
  195. };
  196. /* can be used to add custom fields to all watchers, while losing binary compatibility */
  197. #ifndef EV_COMMON
  198. # define EV_COMMON void *data;
  199. #endif
  200. #ifndef EV_CB_DECLARE
  201. # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
  202. #endif
  203. #ifndef EV_CB_INVOKE
  204. # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
  205. #endif
  206. /* not official, do not use */
  207. #define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
  208. /*
  209. * struct member types:
  210. * private: you may look at them, but not change them,
  211. * and they might not mean anything to you.
  212. * ro: can be read anytime, but only changed when the watcher isn't active.
  213. * rw: can be read and modified anytime, even when the watcher is active.
  214. *
  215. * some internal details that might be helpful for debugging:
  216. *
  217. * active is either 0, which means the watcher is not active,
  218. * or the array index of the watcher (periodics, timers)
  219. * or the array index + 1 (most other watchers)
  220. * or simply 1 for watchers that aren't in some array.
  221. * pending is either 0, in which case the watcher isn't,
  222. * or the array index + 1 in the pendings array.
  223. */
  224. #if EV_MINPRI == EV_MAXPRI
  225. # define EV_DECL_PRIORITY
  226. #elif !defined (EV_DECL_PRIORITY)
  227. # define EV_DECL_PRIORITY int priority;
  228. #endif
  229. /* shared by all watchers */
  230. #define EV_WATCHER(type) \
  231. int active; /* private */ \
  232. int pending; /* private */ \
  233. EV_DECL_PRIORITY /* private */ \
  234. EV_COMMON /* rw */ \
  235. EV_CB_DECLARE (type) /* private */
  236. #define EV_WATCHER_LIST(type) \
  237. EV_WATCHER (type) \
  238. struct ev_watcher_list *next; /* private */
  239. #define EV_WATCHER_TIME(type) \
  240. EV_WATCHER (type) \
  241. ev_tstamp at; /* private */
  242. /* base class, nothing to see here unless you subclass */
  243. typedef struct ev_watcher
  244. {
  245. EV_WATCHER (ev_watcher)
  246. } ev_watcher;
  247. /* base class, nothing to see here unless you subclass */
  248. typedef struct ev_watcher_list
  249. {
  250. EV_WATCHER_LIST (ev_watcher_list)
  251. } ev_watcher_list;
  252. /* base class, nothing to see here unless you subclass */
  253. typedef struct ev_watcher_time
  254. {
  255. EV_WATCHER_TIME (ev_watcher_time)
  256. } ev_watcher_time;
  257. /* invoked when fd is either EV_READable or EV_WRITEable */
  258. /* revent EV_READ, EV_WRITE */
  259. typedef struct ev_io
  260. {
  261. EV_WATCHER_LIST (ev_io)
  262. int fd; /* ro */
  263. int events; /* ro */
  264. } ev_io;
  265. /* invoked after a specific time, repeatable (based on monotonic clock) */
  266. /* revent EV_TIMEOUT */
  267. typedef struct ev_timer
  268. {
  269. EV_WATCHER_TIME (ev_timer)
  270. ev_tstamp repeat; /* rw */
  271. } ev_timer;
  272. /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
  273. /* revent EV_PERIODIC */
  274. typedef struct ev_periodic
  275. {
  276. EV_WATCHER_TIME (ev_periodic)
  277. ev_tstamp offset; /* rw */
  278. ev_tstamp interval; /* rw */
  279. ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
  280. } ev_periodic;
  281. /* invoked when the given signal has been received */
  282. /* revent EV_SIGNAL */
  283. typedef struct ev_signal
  284. {
  285. EV_WATCHER_LIST (ev_signal)
  286. int signum; /* ro */
  287. } ev_signal;
  288. /* invoked when sigchld is received and waitpid indicates the given pid */
  289. /* revent EV_CHILD */
  290. /* does not support priorities */
  291. typedef struct ev_child
  292. {
  293. EV_WATCHER_LIST (ev_child)
  294. int flags; /* private */
  295. int pid; /* ro */
  296. int rpid; /* rw, holds the received pid */
  297. int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
  298. } ev_child;
  299. #if EV_STAT_ENABLE
  300. /* st_nlink = 0 means missing file or other error */
  301. # ifdef _WIN32
  302. typedef struct _stati64 ev_statdata;
  303. # else
  304. typedef struct stat ev_statdata;
  305. # endif
  306. /* invoked each time the stat data changes for a given path */
  307. /* revent EV_STAT */
  308. typedef struct ev_stat
  309. {
  310. EV_WATCHER_LIST (ev_stat)
  311. ev_timer timer; /* private */
  312. ev_tstamp interval; /* ro */
  313. const char *path; /* ro */
  314. ev_statdata prev; /* ro */
  315. ev_statdata attr; /* ro */
  316. int wd; /* wd for inotify, fd for kqueue */
  317. } ev_stat;
  318. #endif
  319. #if EV_IDLE_ENABLE
  320. /* invoked when the nothing else needs to be done, keeps the process from blocking */
  321. /* revent EV_IDLE */
  322. typedef struct ev_idle
  323. {
  324. EV_WATCHER (ev_idle)
  325. } ev_idle;
  326. #endif
  327. /* invoked for each run of the mainloop, just before the blocking call */
  328. /* you can still change events in any way you like */
  329. /* revent EV_PREPARE */
  330. typedef struct ev_prepare
  331. {
  332. EV_WATCHER (ev_prepare)
  333. } ev_prepare;
  334. /* invoked for each run of the mainloop, just after the blocking call */
  335. /* revent EV_CHECK */
  336. typedef struct ev_check
  337. {
  338. EV_WATCHER (ev_check)
  339. } ev_check;
  340. #if EV_FORK_ENABLE
  341. /* the callback gets invoked before check in the child process when a fork was detected */
  342. /* revent EV_FORK */
  343. typedef struct ev_fork
  344. {
  345. EV_WATCHER (ev_fork)
  346. } ev_fork;
  347. #endif
  348. #if EV_CLEANUP_ENABLE
  349. /* is invoked just before the loop gets destroyed */
  350. /* revent EV_CLEANUP */
  351. typedef struct ev_cleanup
  352. {
  353. EV_WATCHER (ev_cleanup)
  354. } ev_cleanup;
  355. #endif
  356. #if EV_EMBED_ENABLE
  357. /* used to embed an event loop inside another */
  358. /* the callback gets invoked when the event loop has handled events, and can be 0 */
  359. typedef struct ev_embed
  360. {
  361. EV_WATCHER (ev_embed)
  362. struct ev_loop *other; /* ro */
  363. ev_io io; /* private */
  364. ev_prepare prepare; /* private */
  365. ev_check check; /* unused */
  366. ev_timer timer; /* unused */
  367. ev_periodic periodic; /* unused */
  368. ev_idle idle; /* unused */
  369. ev_fork fork; /* private */
  370. #if EV_CLEANUP_ENABLE
  371. ev_cleanup cleanup; /* unused */
  372. #endif
  373. } ev_embed;
  374. #endif
  375. #if EV_ASYNC_ENABLE
  376. /* invoked when somebody calls ev_async_send on the watcher */
  377. /* revent EV_ASYNC */
  378. typedef struct ev_async
  379. {
  380. EV_WATCHER (ev_async)
  381. EV_ATOMIC_T sent; /* private */
  382. } ev_async;
  383. # define ev_async_pending(w) (+(w)->sent)
  384. #endif
  385. /* the presence of this union forces similar struct layout */
  386. union ev_any_watcher
  387. {
  388. struct ev_watcher w;
  389. struct ev_watcher_list wl;
  390. struct ev_io io;
  391. struct ev_timer timer;
  392. struct ev_periodic periodic;
  393. struct ev_signal signal;
  394. struct ev_child child;
  395. #if EV_STAT_ENABLE
  396. struct ev_stat stat;
  397. #endif
  398. #if EV_IDLE_ENABLE
  399. struct ev_idle idle;
  400. #endif
  401. struct ev_prepare prepare;
  402. struct ev_check check;
  403. #if EV_FORK_ENABLE
  404. struct ev_fork fork;
  405. #endif
  406. #if EV_CLEANUP_ENABLE
  407. struct ev_cleanup cleanup;
  408. #endif
  409. #if EV_EMBED_ENABLE
  410. struct ev_embed embed;
  411. #endif
  412. #if EV_ASYNC_ENABLE
  413. struct ev_async async;
  414. #endif
  415. };
  416. /* flag bits for ev_default_loop and ev_loop_new */
  417. enum {
  418. /* the default */
  419. EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
  420. /* flag bits */
  421. EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
  422. EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
  423. /* debugging/feature disable */
  424. EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
  425. #if EV_COMPAT3
  426. EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
  427. #endif
  428. EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
  429. EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
  430. };
  431. /* method bits to be ored together */
  432. enum {
  433. EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
  434. EVBACKEND_POLL = 0x00000002U, /* !win */
  435. EVBACKEND_EPOLL = 0x00000004U, /* linux */
  436. EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
  437. EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
  438. EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
  439. EVBACKEND_ALL = 0x0000003FU, /* all known backends */
  440. EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
  441. };
  442. #if EV_PROTOTYPES
  443. EV_API_DECL int ev_version_major (void);
  444. EV_API_DECL int ev_version_minor (void);
  445. EV_API_DECL unsigned int ev_supported_backends (void);
  446. EV_API_DECL unsigned int ev_recommended_backends (void);
  447. EV_API_DECL unsigned int ev_embeddable_backends (void);
  448. EV_API_DECL ev_tstamp ev_time (void);
  449. EV_API_DECL void ev_sleep (ev_tstamp delay); /* sleep for a while */
  450. /* Sets the allocation function to use, works like realloc.
  451. * It is used to allocate and free memory.
  452. * If it returns zero when memory needs to be allocated, the library might abort
  453. * or take some potentially destructive action.
  454. * The default is your system realloc function.
  455. */
  456. EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size));
  457. /* set the callback function to call on a
  458. * retryable syscall error
  459. * (such as failed select, poll, epoll_wait)
  460. */
  461. EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg));
  462. #if EV_MULTIPLICITY
  463. /* the default loop is the only one that handles signals and child watchers */
  464. /* you can call this as often as you like */
  465. EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
  466. #ifdef EV_API_STATIC
  467. EV_API_DECL struct ev_loop *ev_default_loop_ptr;
  468. #endif
  469. EV_INLINE struct ev_loop *
  470. ev_default_loop_uc_ (void)
  471. {
  472. extern struct ev_loop *ev_default_loop_ptr;
  473. return ev_default_loop_ptr;
  474. }
  475. EV_INLINE int
  476. ev_is_default_loop (EV_P)
  477. {
  478. return EV_A == EV_DEFAULT_UC;
  479. }
  480. /* create and destroy alternative loops that don't handle signals */
  481. EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
  482. EV_API_DECL ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
  483. #else
  484. EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
  485. EV_API_DECL ev_tstamp ev_rt_now;
  486. EV_INLINE ev_tstamp
  487. ev_now (void)
  488. {
  489. return ev_rt_now;
  490. }
  491. /* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
  492. EV_INLINE int
  493. ev_is_default_loop (void)
  494. {
  495. return 1;
  496. }
  497. #endif /* multiplicity */
  498. /* destroy event loops, also works for the default loop */
  499. EV_API_DECL void ev_loop_destroy (EV_P);
  500. /* this needs to be called after fork, to duplicate the loop */
  501. /* when you want to re-use it in the child */
  502. /* you can call it in either the parent or the child */
  503. /* you can actually call it at any time, anywhere :) */
  504. EV_API_DECL void ev_loop_fork (EV_P);
  505. EV_API_DECL unsigned int ev_backend (EV_P); /* backend in use by loop */
  506. EV_API_DECL void ev_now_update (EV_P); /* update event loop time */
  507. #if EV_WALK_ENABLE
  508. /* walk (almost) all watchers in the loop of a given type, invoking the */
  509. /* callback on every such watcher. The callback might stop the watcher, */
  510. /* but do nothing else with the loop */
  511. EV_API_DECL void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
  512. #endif
  513. #endif /* prototypes */
  514. /* ev_run flags values */
  515. enum {
  516. EVRUN_NOWAIT = 1, /* do not block/wait */
  517. EVRUN_ONCE = 2 /* block *once* only */
  518. };
  519. /* ev_break how values */
  520. enum {
  521. EVBREAK_CANCEL = 0, /* undo unloop */
  522. EVBREAK_ONE = 1, /* unloop once */
  523. EVBREAK_ALL = 2 /* unloop all loops */
  524. };
  525. #if EV_PROTOTYPES
  526. EV_API_DECL int ev_run (EV_P_ int flags EV_CPP (= 0));
  527. EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
  528. /*
  529. * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
  530. * keeps one reference. if you have a long-running watcher you never unregister that
  531. * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
  532. */
  533. EV_API_DECL void ev_ref (EV_P);
  534. EV_API_DECL void ev_unref (EV_P);
  535. /*
  536. * convenience function, wait for a single event, without registering an event watcher
  537. * if timeout is < 0, do wait indefinitely
  538. */
  539. EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
  540. # if EV_FEATURE_API
  541. EV_API_DECL unsigned int ev_iteration (EV_P); /* number of loop iterations */
  542. EV_API_DECL unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
  543. EV_API_DECL void ev_verify (EV_P); /* abort if loop data corrupted */
  544. EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
  545. EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
  546. /* advanced stuff for threading etc. support, see docs */
  547. EV_API_DECL void ev_set_userdata (EV_P_ void *data);
  548. EV_API_DECL void *ev_userdata (EV_P);
  549. EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
  550. EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
  551. EV_API_DECL unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
  552. EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
  553. /*
  554. * stop/start the timer handling.
  555. */
  556. EV_API_DECL void ev_suspend (EV_P);
  557. EV_API_DECL void ev_resume (EV_P);
  558. #endif
  559. #endif
  560. /* these may evaluate ev multiple times, and the other arguments at most once */
  561. /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
  562. #define ev_init(ev,cb_) do { \
  563. ((ev_watcher *)(void *)(ev))->active = \
  564. ((ev_watcher *)(void *)(ev))->pending = 0; \
  565. ev_set_priority ((ev), 0); \
  566. ev_set_cb ((ev), cb_); \
  567. } while (0)
  568. #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0)
  569. #define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
  570. #define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
  571. #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
  572. #define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
  573. #define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
  574. #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
  575. #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
  576. #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
  577. #define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
  578. #define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
  579. #define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
  580. #define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
  581. #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
  582. #define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
  583. #define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
  584. #define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
  585. #define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
  586. #define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
  587. #define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
  588. #define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
  589. #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
  590. #define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
  591. #define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
  592. #define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
  593. #define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
  594. #define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
  595. #define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
  596. #define ev_cb(ev) (ev)->cb /* rw */
  597. #if EV_MINPRI == EV_MAXPRI
  598. # define ev_priority(ev) ((ev), EV_MINPRI)
  599. # define ev_set_priority(ev,pri) ((ev), (pri))
  600. #else
  601. # define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
  602. # define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
  603. #endif
  604. #define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
  605. #ifndef ev_set_cb
  606. # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
  607. #endif
  608. /* stopping (enabling, adding) a watcher does nothing if it is already running */
  609. /* stopping (disabling, deleting) a watcher does nothing unless its already running */
  610. #if EV_PROTOTYPES
  611. /* feeds an event into a watcher as if the event actually occurred */
  612. /* accepts any ev_watcher type */
  613. EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents);
  614. EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents);
  615. #if EV_SIGNAL_ENABLE
  616. EV_API_DECL void ev_feed_signal (int signum);
  617. EV_API_DECL void ev_feed_signal_event (EV_P_ int signum);
  618. #endif
  619. EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
  620. EV_API_DECL int ev_clear_pending (EV_P_ void *w);
  621. EV_API_DECL void ev_io_start (EV_P_ ev_io *w);
  622. EV_API_DECL void ev_io_stop (EV_P_ ev_io *w);
  623. EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w);
  624. EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w);
  625. /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
  626. EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w);
  627. /* return remaining time */
  628. EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
  629. #if EV_PERIODIC_ENABLE
  630. EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w);
  631. EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w);
  632. EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w);
  633. #endif
  634. /* only supported in the default loop */
  635. #if EV_SIGNAL_ENABLE
  636. EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w);
  637. EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w);
  638. #endif
  639. /* only supported in the default loop */
  640. # if EV_CHILD_ENABLE
  641. EV_API_DECL void ev_child_start (EV_P_ ev_child *w);
  642. EV_API_DECL void ev_child_stop (EV_P_ ev_child *w);
  643. # endif
  644. # if EV_STAT_ENABLE
  645. EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w);
  646. EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w);
  647. EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w);
  648. # endif
  649. # if EV_IDLE_ENABLE
  650. EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w);
  651. EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w);
  652. # endif
  653. #if EV_PREPARE_ENABLE
  654. EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w);
  655. EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w);
  656. #endif
  657. #if EV_CHECK_ENABLE
  658. EV_API_DECL void ev_check_start (EV_P_ ev_check *w);
  659. EV_API_DECL void ev_check_stop (EV_P_ ev_check *w);
  660. #endif
  661. # if EV_FORK_ENABLE
  662. EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w);
  663. EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w);
  664. # endif
  665. # if EV_CLEANUP_ENABLE
  666. EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w);
  667. EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w);
  668. # endif
  669. # if EV_EMBED_ENABLE
  670. /* only supported when loop to be embedded is in fact embeddable */
  671. EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w);
  672. EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w);
  673. EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w);
  674. # endif
  675. # if EV_ASYNC_ENABLE
  676. EV_API_DECL void ev_async_start (EV_P_ ev_async *w);
  677. EV_API_DECL void ev_async_stop (EV_P_ ev_async *w);
  678. EV_API_DECL void ev_async_send (EV_P_ ev_async *w);
  679. # endif
  680. #if EV_COMPAT3
  681. #define EVLOOP_NONBLOCK EVRUN_NOWAIT
  682. #define EVLOOP_ONESHOT EVRUN_ONCE
  683. #define EVUNLOOP_CANCEL EVBREAK_CANCEL
  684. #define EVUNLOOP_ONE EVBREAK_ONE
  685. #define EVUNLOOP_ALL EVBREAK_ALL
  686. #if EV_PROTOTYPES
  687. EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
  688. EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
  689. EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
  690. EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
  691. #if EV_FEATURE_API
  692. EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
  693. EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
  694. EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
  695. #endif
  696. #endif
  697. #else
  698. typedef struct ev_loop ev_loop;
  699. #endif
  700. #endif
  701. EV_CPP(})
  702. #endif