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.

845 lines
28 KiB

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