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.

ev.h 29KB

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