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.

854 lines
29 KiB

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