ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
(Generate patch)

Comparing libev/ev.h (file contents):
Revision 1.146 by root, Fri Oct 22 06:14:28 2010 UTC vs.
Revision 1.187 by root, Wed Dec 28 04:22:06 2016 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010,2011,2012,2015 Marc Alexander Lehmann <libev@schmorp.de>
5 * All rights reserved. 5 * All rights reserved.
6 * 6 *
7 * Redistribution and use in source and binary forms, with or without modifica- 7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met: 8 * tion, are permitted provided that the following conditions are met:
9 * 9 *
10 * 1. Redistributions of source code must retain the above copyright notice, 10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer. 11 * this list of conditions and the following disclaimer.
12 * 12 *
13 * 2. Redistributions in binary form must reproduce the above copyright 13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the 14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution. 15 * documentation and/or other materials provided with the distribution.
16 * 16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 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- 18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 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- 20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
… …
39 39
40#ifndef EV_H_ 40#ifndef EV_H_
41#define EV_H_ 41#define EV_H_
42 42
43#ifdef __cplusplus 43#ifdef __cplusplus
44extern "C" { 44# define EV_CPP(x) x
45# if __cplusplus >= 201103L
46# define EV_THROW noexcept
47# else
48# define EV_THROW throw ()
45#endif 49# endif
50#else
51# define EV_CPP(x)
52# define EV_THROW
53#endif
54
55EV_CPP(extern "C" {)
46 56
47/*****************************************************************************/ 57/*****************************************************************************/
48 58
49/* pre-4.0 compatibility */ 59/* pre-4.0 compatibility */
50#ifndef EV_COMPAT3 60#ifndef EV_COMPAT3
51# define EV_COMPAT3 1 61# define EV_COMPAT3 1
52#endif 62#endif
53 63
54#ifndef EV_FEATURES 64#ifndef EV_FEATURES
65# if defined __OPTIMIZE_SIZE__
66# define EV_FEATURES 0x7c
67# else
55# define EV_FEATURES 0x7f 68# define EV_FEATURES 0x7f
69# endif
56#endif 70#endif
57 71
58#define EV_FEATURE_CODE ((EV_FEATURES) & 1) 72#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
59#define EV_FEATURE_DATA ((EV_FEATURES) & 2) 73#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
60#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4) 74#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
… …
97 111
98#ifndef EV_FORK_ENABLE 112#ifndef EV_FORK_ENABLE
99# define EV_FORK_ENABLE EV_FEATURE_WATCHERS 113# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
100#endif 114#endif
101 115
116#ifndef EV_CLEANUP_ENABLE
117# define EV_CLEANUP_ENABLE EV_FEATURE_WATCHERS
118#endif
119
102#ifndef EV_SIGNAL_ENABLE 120#ifndef EV_SIGNAL_ENABLE
103# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS 121# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
104#endif 122#endif
105 123
106#ifndef EV_CHILD_ENABLE 124#ifndef EV_CHILD_ENABLE
… …
132 150
133/*****************************************************************************/ 151/*****************************************************************************/
134 152
135typedef double ev_tstamp; 153typedef double ev_tstamp;
136 154
155#include <string.h> /* for memmove */
156
137#ifndef EV_ATOMIC_T 157#ifndef EV_ATOMIC_T
138# include <signal.h> 158# include <signal.h>
139# define EV_ATOMIC_T sig_atomic_t volatile 159# define EV_ATOMIC_T sig_atomic_t volatile
140#endif 160#endif
141 161
… …
143# ifdef _WIN32 163# ifdef _WIN32
144# include <time.h> 164# include <time.h>
145# include <sys/types.h> 165# include <sys/types.h>
146# endif 166# endif
147# include <sys/stat.h> 167# include <sys/stat.h>
148#endif
149
150/* in C++ we can use this to provide default arguments */
151#ifdef __cplusplus
152# define EV_DEFARG(x) = x
153#else
154# define EV_DEFARG(x)
155#endif 168#endif
156 169
157/* support multiple event loops? */ 170/* support multiple event loops? */
158#if EV_MULTIPLICITY 171#if EV_MULTIPLICITY
159struct ev_loop; 172struct ev_loop;
160# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */ 173# define EV_P struct ev_loop *loop /* a loop as sole parameter in a declaration */
161# define EV_P_ EV_P, /* a loop as first of multiple parameters */ 174# define EV_P_ EV_P, /* a loop as first of multiple parameters */
162# define EV_A loop /* a loop as sole argument to a function call */ 175# define EV_A loop /* a loop as sole argument to a function call */
163# define EV_A_ EV_A, /* a loop as first of multiple arguments */ 176# define EV_A_ EV_A, /* a loop as first of multiple arguments */
164# define EV_DEFAULT_UC ev_default_loop_uc () /* the default loop, if initialised, as sole arg */ 177# define EV_DEFAULT_UC ev_default_loop_uc_ () /* the default loop, if initialised, as sole arg */
165# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */ 178# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
166# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */ 179# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
167# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */ 180# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
168# define EV_PDEF EV_P EV_DEFARG (EV_DEFAULT_UC) /* EV_P, but with default argument in C++ */
169# define EV_PDEF_ EV_P EV_DEFARG (EV_DEFAULT_UC), /* EV_P_, but with default argument in C++ */
170#else 181#else
171# define EV_P void 182# define EV_P void
172# define EV_P_ 183# define EV_P_
173# define EV_A 184# define EV_A
174# define EV_A_ 185# define EV_A_
175# define EV_DEFAULT 186# define EV_DEFAULT
176# define EV_DEFAULT_ 187# define EV_DEFAULT_
177# define EV_DEFAULT_UC 188# define EV_DEFAULT_UC
178# define EV_DEFAULT_UC_ 189# define EV_DEFAULT_UC_
179# define EV_PDEF EV_P
180# define EV_PDEF_ EV_P_
181# undef EV_EMBED_ENABLE 190# undef EV_EMBED_ENABLE
182#endif 191#endif
183 192
184/* EV_INLINE is used for functions in header files */ 193/* EV_INLINE is used for functions in header files */
185#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3 194#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
186# define EV_INLINE static inline 195# define EV_INLINE static inline
187#else 196#else
188# define EV_INLINE static 197# define EV_INLINE static
189#endif 198#endif
190 199
200#ifdef EV_API_STATIC
201# define EV_API_DECL static
202#else
203# define EV_API_DECL extern
204#endif
205
191/* EV_PROTOTYPES can be sued to switch of prototype declarations */ 206/* EV_PROTOTYPES can be used to switch of prototype declarations */
192#ifndef EV_PROTOTYPES 207#ifndef EV_PROTOTYPES
193# define EV_PROTOTYPES 1 208# define EV_PROTOTYPES 1
194#endif 209#endif
195 210
196/*****************************************************************************/ 211/*****************************************************************************/
197 212
198#define EV_VERSION_MAJOR 4 213#define EV_VERSION_MAJOR 4
199#define EV_VERSION_MINOR 0 214#define EV_VERSION_MINOR 24
200 215
201/* eventmask, revents, events... */ 216/* eventmask, revents, events... */
202enum { 217enum {
203 EV_UNDEF = -1, /* guaranteed to be invalid */ 218 EV_UNDEF = (int)0xFFFFFFFF, /* guaranteed to be invalid */
204 EV_NONE = 0x00, /* no events */ 219 EV_NONE = 0x00, /* no events */
205 EV_READ = 0x01, /* ev_io detected read will not block */ 220 EV_READ = 0x01, /* ev_io detected read will not block */
206 EV_WRITE = 0x02, /* ev_io detected write will not block */ 221 EV_WRITE = 0x02, /* ev_io detected write will not block */
207 EV__IOFDSET = 0x80, /* internal use only */ 222 EV__IOFDSET = 0x80, /* internal use only */
208 EV_IO = EV_READ, /* alias for type-detection */ 223 EV_IO = EV_READ, /* alias for type-detection */
209 EV_TIMER = 0x00000100, /* timer timed out */ 224 EV_TIMER = 0x00000100, /* timer timed out */
210#if EV_COMPAT3 225#if EV_COMPAT3
211 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */ 226 EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
212#endif 227#endif
213 EV_PERIODIC = 0x00000200, /* periodic timer timed out */ 228 EV_PERIODIC = 0x00000200, /* periodic timer timed out */
214 EV_SIGNAL = 0x00000400, /* signal was received */ 229 EV_SIGNAL = 0x00000400, /* signal was received */
215 EV_CHILD = 0x00000800, /* child/pid had status change */ 230 EV_CHILD = 0x00000800, /* child/pid had status change */
216 EV_STAT = 0x00001000, /* stat data changed */ 231 EV_STAT = 0x00001000, /* stat data changed */
217 EV_IDLE = 0x00002000, /* event loop is idling */ 232 EV_IDLE = 0x00002000, /* event loop is idling */
218 EV_PREPARE = 0x00004000, /* event loop about to poll */ 233 EV_PREPARE = 0x00004000, /* event loop about to poll */
219 EV_CHECK = 0x00008000, /* event loop finished poll */ 234 EV_CHECK = 0x00008000, /* event loop finished poll */
220 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */ 235 EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
221 EV_FORK = 0x00020000, /* event loop resumed in child */ 236 EV_FORK = 0x00020000, /* event loop resumed in child */
237 EV_CLEANUP = 0x00040000, /* event loop resumed in child */
222 EV_ASYNC = 0x00040000, /* async intra-loop signal */ 238 EV_ASYNC = 0x00080000, /* async intra-loop signal */
223 EV_CUSTOM = 0x01000000, /* for use by user code */ 239 EV_CUSTOM = 0x01000000, /* for use by user code */
224 EV_ERROR = 0x80000000 /* sent when an error occurs */ 240 EV_ERROR = (int)0x80000000 /* sent when an error occurs */
225}; 241};
226 242
227/* can be used to add custom fields to all watchers, while losing binary compatibility */ 243/* can be used to add custom fields to all watchers, while losing binary compatibility */
228#ifndef EV_COMMON 244#ifndef EV_COMMON
229# define EV_COMMON void *data; 245# define EV_COMMON void *data;
… …
321{ 337{
322 EV_WATCHER_TIME (ev_periodic) 338 EV_WATCHER_TIME (ev_periodic)
323 339
324 ev_tstamp offset; /* rw */ 340 ev_tstamp offset; /* rw */
325 ev_tstamp interval; /* rw */ 341 ev_tstamp interval; /* rw */
326 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 342 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now) EV_THROW; /* rw */
327} ev_periodic; 343} ev_periodic;
328 344
329/* invoked when the given signal has been received */ 345/* invoked when the given signal has been received */
330/* revent EV_SIGNAL */ 346/* revent EV_SIGNAL */
331typedef struct ev_signal 347typedef struct ev_signal
… …
396 EV_WATCHER (ev_check) 412 EV_WATCHER (ev_check)
397} ev_check; 413} ev_check;
398 414
399#if EV_FORK_ENABLE 415#if EV_FORK_ENABLE
400/* the callback gets invoked before check in the child process when a fork was detected */ 416/* the callback gets invoked before check in the child process when a fork was detected */
417/* revent EV_FORK */
401typedef struct ev_fork 418typedef struct ev_fork
402{ 419{
403 EV_WATCHER (ev_fork) 420 EV_WATCHER (ev_fork)
404} ev_fork; 421} ev_fork;
422#endif
423
424#if EV_CLEANUP_ENABLE
425/* is invoked just before the loop gets destroyed */
426/* revent EV_CLEANUP */
427typedef struct ev_cleanup
428{
429 EV_WATCHER (ev_cleanup)
430} ev_cleanup;
405#endif 431#endif
406 432
407#if EV_EMBED_ENABLE 433#if EV_EMBED_ENABLE
408/* used to embed an event loop inside another */ 434/* used to embed an event loop inside another */
409/* the callback gets invoked when the event loop has handled events, and can be 0 */ 435/* the callback gets invoked when the event loop has handled events, and can be 0 */
… …
417 ev_check check; /* unused */ 443 ev_check check; /* unused */
418 ev_timer timer; /* unused */ 444 ev_timer timer; /* unused */
419 ev_periodic periodic; /* unused */ 445 ev_periodic periodic; /* unused */
420 ev_idle idle; /* unused */ 446 ev_idle idle; /* unused */
421 ev_fork fork; /* private */ 447 ev_fork fork; /* private */
448#if EV_CLEANUP_ENABLE
449 ev_cleanup cleanup; /* unused */
450#endif
422} ev_embed; 451} ev_embed;
423#endif 452#endif
424 453
425#if EV_ASYNC_ENABLE 454#if EV_ASYNC_ENABLE
426/* invoked when somebody calls ev_async_send on the watcher */ 455/* invoked when somebody calls ev_async_send on the watcher */
… …
454#endif 483#endif
455 struct ev_prepare prepare; 484 struct ev_prepare prepare;
456 struct ev_check check; 485 struct ev_check check;
457#if EV_FORK_ENABLE 486#if EV_FORK_ENABLE
458 struct ev_fork fork; 487 struct ev_fork fork;
488#endif
489#if EV_CLEANUP_ENABLE
490 struct ev_cleanup cleanup;
459#endif 491#endif
460#if EV_EMBED_ENABLE 492#if EV_EMBED_ENABLE
461 struct ev_embed embed; 493 struct ev_embed embed;
462#endif 494#endif
463#if EV_ASYNC_ENABLE 495#if EV_ASYNC_ENABLE
… …
475 /* debugging/feature disable */ 507 /* debugging/feature disable */
476 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */ 508 EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
477#if EV_COMPAT3 509#if EV_COMPAT3
478 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */ 510 EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
479#endif 511#endif
480 EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */ 512 EVFLAG_SIGNALFD = 0x00200000U, /* attempt to use signalfd */
513 EVFLAG_NOSIGMASK = 0x00400000U /* avoid modifying the signal mask */
481}; 514};
482 515
483/* method bits to be ored together */ 516/* method bits to be ored together */
484enum { 517enum {
485 EVBACKEND_SELECT = 0x00000001U, /* about anywhere */ 518 EVBACKEND_SELECT = 0x00000001U, /* available just about anywhere */
486 EVBACKEND_POLL = 0x00000002U, /* !win */ 519 EVBACKEND_POLL = 0x00000002U, /* !win, !aix, broken on osx */
487 EVBACKEND_EPOLL = 0x00000004U, /* linux */ 520 EVBACKEND_EPOLL = 0x00000004U, /* linux */
488 EVBACKEND_KQUEUE = 0x00000008U, /* bsd */ 521 EVBACKEND_KQUEUE = 0x00000008U, /* bsd, broken on osx */
489 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */ 522 EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 */ /* NYI */
490 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */ 523 EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
491 EVBACKEND_ALL = 0x0000003FU 524 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
525 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
492}; 526};
493 527
494#if EV_PROTOTYPES 528#if EV_PROTOTYPES
495int ev_version_major (void); 529EV_API_DECL int ev_version_major (void) EV_THROW;
496int ev_version_minor (void); 530EV_API_DECL int ev_version_minor (void) EV_THROW;
497 531
498unsigned int ev_supported_backends (void); 532EV_API_DECL unsigned int ev_supported_backends (void) EV_THROW;
499unsigned int ev_recommended_backends (void); 533EV_API_DECL unsigned int ev_recommended_backends (void) EV_THROW;
500unsigned int ev_embeddable_backends (void); 534EV_API_DECL unsigned int ev_embeddable_backends (void) EV_THROW;
501 535
502ev_tstamp ev_time (void); 536EV_API_DECL ev_tstamp ev_time (void) EV_THROW;
503void ev_sleep (ev_tstamp delay); /* sleep for a while */ 537EV_API_DECL void ev_sleep (ev_tstamp delay) EV_THROW; /* sleep for a while */
504 538
505/* Sets the allocation function to use, works like realloc. 539/* Sets the allocation function to use, works like realloc.
506 * It is used to allocate and free memory. 540 * It is used to allocate and free memory.
507 * If it returns zero when memory needs to be allocated, the library might abort 541 * If it returns zero when memory needs to be allocated, the library might abort
508 * or take some potentially destructive action. 542 * or take some potentially destructive action.
509 * The default is your system realloc function. 543 * The default is your system realloc function.
510 */ 544 */
511void ev_set_allocator (void *(*cb)(void *ptr, long size)); 545EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size) EV_THROW) EV_THROW;
512 546
513/* set the callback function to call on a 547/* set the callback function to call on a
514 * retryable syscall error 548 * retryable syscall error
515 * (such as failed select, poll, epoll_wait) 549 * (such as failed select, poll, epoll_wait)
516 */ 550 */
517void ev_set_syserr_cb (void (*cb)(const char *msg)); 551EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg) EV_THROW) EV_THROW;
518 552
519#if EV_MULTIPLICITY 553#if EV_MULTIPLICITY
554
555/* the default loop is the only one that handles signals and child watchers */
556/* you can call this as often as you like */
557EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0)) EV_THROW;
558
559#ifdef EV_API_STATIC
560EV_API_DECL struct ev_loop *ev_default_loop_ptr;
561#endif
562
520EV_INLINE struct ev_loop * 563EV_INLINE struct ev_loop *
521ev_default_loop_uc (void) 564ev_default_loop_uc_ (void) EV_THROW
522{ 565{
523 extern struct ev_loop *ev_default_loop_ptr; 566 extern struct ev_loop *ev_default_loop_ptr;
524 567
525 return ev_default_loop_ptr; 568 return ev_default_loop_ptr;
526} 569}
527 570
528/* the default loop is the only one that handles signals and child watchers */ 571EV_INLINE int
529/* you can call this as often as you like */ 572ev_is_default_loop (EV_P) EV_THROW
530EV_INLINE struct ev_loop *
531ev_default_loop (unsigned int flags EV_DEFARG (0))
532{ 573{
533 struct ev_loop *loop = ev_default_loop_uc (); 574 return EV_A == EV_DEFAULT_UC;
534
535 if (!loop)
536 {
537 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
538
539 loop = ev_default_loop_init (flags);
540 }
541
542 return loop;
543} 575}
544 576
545/* create and destroy alternative loops that don't handle signals */ 577/* create and destroy alternative loops that don't handle signals */
546struct ev_loop *ev_loop_new (unsigned int flags EV_DEFARG (0)); 578EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)) EV_THROW;
547void ev_loop_destroy (EV_PDEF);
548void ev_loop_fork (EV_PDEF);
549 579
550ev_tstamp ev_now (EV_PDEF); /* time w.r.t. timers and the eventloop, updated after each poll */ 580EV_API_DECL ev_tstamp ev_now (EV_P) EV_THROW; /* time w.r.t. timers and the eventloop, updated after each poll */
551 581
552#else 582#else
553 583
554int ev_default_loop (unsigned int flags EV_DEFARG (0)); /* returns true when successful */ 584EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)) EV_THROW; /* returns true when successful */
585
586EV_API_DECL ev_tstamp ev_rt_now;
555 587
556EV_INLINE ev_tstamp 588EV_INLINE ev_tstamp
557ev_now (void) 589ev_now (void) EV_THROW
558{ 590{
559 extern ev_tstamp ev_rt_now;
560
561 return ev_rt_now; 591 return ev_rt_now;
562} 592}
593
594/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
595EV_INLINE int
596ev_is_default_loop (void) EV_THROW
597{
598 return 1;
599}
600
563#endif /* multiplicity */ 601#endif /* multiplicity */
564 602
565EV_INLINE int 603/* destroy event loops, also works for the default loop */
566ev_is_default_loop (EV_PDEF) 604EV_API_DECL void ev_loop_destroy (EV_P);
567{
568#if EV_MULTIPLICITY
569 extern struct ev_loop *ev_default_loop_ptr;
570 605
571 return !!(EV_A == ev_default_loop_ptr);
572#else
573 return 1;
574#endif
575}
576
577void ev_default_destroy (void); /* destroy the default loop */
578/* this needs to be called after fork, to duplicate the default loop */ 606/* this needs to be called after fork, to duplicate the loop */
579/* if you create alternative loops you have to call ev_loop_fork on them */ 607/* when you want to re-use it in the child */
580/* you can call it in either the parent or the child */ 608/* you can call it in either the parent or the child */
581/* you can actually call it at any time, anywhere :) */ 609/* you can actually call it at any time, anywhere :) */
582void ev_default_fork (void); 610EV_API_DECL void ev_loop_fork (EV_P) EV_THROW;
583 611
584unsigned int ev_backend (EV_PDEF); /* backend in use by loop */ 612EV_API_DECL unsigned int ev_backend (EV_P) EV_THROW; /* backend in use by loop */
585 613
586void ev_now_update (EV_PDEF); /* update event loop time */ 614EV_API_DECL void ev_now_update (EV_P) EV_THROW; /* update event loop time */
587 615
588#if EV_WALK_ENABLE 616#if EV_WALK_ENABLE
589/* walk (almost) all watchers in the loop of a given type, invoking the */ 617/* walk (almost) all watchers in the loop of a given type, invoking the */
590/* callback on every such watcher. The callback might stop the watcher, */ 618/* callback on every such watcher. The callback might stop the watcher, */
591/* but do nothing else with the loop */ 619/* but do nothing else with the loop */
592void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 620EV_API_DECL void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)) EV_THROW;
593#endif 621#endif
594 622
595#endif /* prototypes */ 623#endif /* prototypes */
596 624
597/* ev_run flags values */ 625/* ev_run flags values */
… …
606 EVBREAK_ONE = 1, /* unloop once */ 634 EVBREAK_ONE = 1, /* unloop once */
607 EVBREAK_ALL = 2 /* unloop all loops */ 635 EVBREAK_ALL = 2 /* unloop all loops */
608}; 636};
609 637
610#if EV_PROTOTYPES 638#if EV_PROTOTYPES
611void ev_run (EV_PDEF_ int flags EV_DEFARG (0)); 639EV_API_DECL int ev_run (EV_P_ int flags EV_CPP (= 0));
612void ev_break (EV_PDEF_ int how EV_DEFARG (EVBREAK_ONE)); /* break out of the loop */ 640EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)) EV_THROW; /* break out of the loop */
613 641
614/* 642/*
615 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 643 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
616 * keeps one reference. if you have a long-running watcher you never unregister that 644 * keeps one reference. if you have a long-running watcher you never unregister that
617 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 645 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
618 */ 646 */
619void ev_ref (EV_PDEF); 647EV_API_DECL void ev_ref (EV_P) EV_THROW;
620void ev_unref (EV_PDEF); 648EV_API_DECL void ev_unref (EV_P) EV_THROW;
621 649
622/* 650/*
623 * convenience function, wait for a single event, without registering an event watcher 651 * convenience function, wait for a single event, without registering an event watcher
624 * if timeout is < 0, do wait indefinitely 652 * if timeout is < 0, do wait indefinitely
625 */ 653 */
626void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 654EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg) EV_THROW;
627 655
628# if EV_FEATURE_API 656# if EV_FEATURE_API
629unsigned int ev_iteration (EV_PDEF); /* number of loop iterations */ 657EV_API_DECL unsigned int ev_iteration (EV_P) EV_THROW; /* number of loop iterations */
630unsigned int ev_depth (EV_PDEF); /* #ev_loop enters - #ev_loop leaves */ 658EV_API_DECL unsigned int ev_depth (EV_P) EV_THROW; /* #ev_loop enters - #ev_loop leaves */
631void ev_verify (EV_PDEF); /* abort if loop data corrupted */ 659EV_API_DECL void ev_verify (EV_P) EV_THROW; /* abort if loop data corrupted */
632 660
633void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 661EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval) EV_THROW; /* sleep at least this time, default 0 */
634void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 662EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval) EV_THROW; /* sleep at least this time, default 0 */
635 663
636/* advanced stuff for threading etc. support, see docs */ 664/* advanced stuff for threading etc. support, see docs */
637void ev_set_userdata (EV_P_ void *data); 665EV_API_DECL void ev_set_userdata (EV_P_ void *data) EV_THROW;
638void *ev_userdata (EV_PDEF); 666EV_API_DECL void *ev_userdata (EV_P) EV_THROW;
639void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); 667typedef void (*ev_loop_callback)(EV_P);
668EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ ev_loop_callback invoke_pending_cb) EV_THROW;
669/* C++ doesn't allow the use of the ev_loop_callback typedef here, so we need to spell it out */
640void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); 670EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P) EV_THROW, void (*acquire)(EV_P) EV_THROW) EV_THROW;
641 671
642unsigned int ev_pending_count (EV_PDEF); /* number of pending events, if any */ 672EV_API_DECL unsigned int ev_pending_count (EV_P) EV_THROW; /* number of pending events, if any */
643void ev_invoke_pending (EV_PDEF); /* invoke all pending watchers */ 673EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
644 674
645/* 675/*
646 * stop/start the timer handling. 676 * stop/start the timer handling.
647 */ 677 */
648void ev_suspend (EV_PDEF); 678EV_API_DECL void ev_suspend (EV_P) EV_THROW;
649void ev_resume (EV_PDEF); 679EV_API_DECL void ev_resume (EV_P) EV_THROW;
650#endif 680#endif
651 681
652#endif 682#endif
653 683
654/* these may evaluate ev multiple times, and the other arguments at most once */ 684/* these may evaluate ev multiple times, and the other arguments at most once */
… …
669#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 699#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
670#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 700#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
671#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 701#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
672#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 702#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
673#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 703#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
704#define ev_cleanup_set(ev) /* nop, yes, this is a serious in-joke */
674#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */ 705#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
675 706
676#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 707#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
677#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 708#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
678#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 709#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
… …
682#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 713#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
683#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 714#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
684#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 715#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
685#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 716#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
686#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 717#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
718#define ev_cleanup_init(ev,cb) do { ev_init ((ev), (cb)); ev_cleanup_set ((ev)); } while (0)
687#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) 719#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
688 720
689#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 721#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
690#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 722#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
691 723
692#define ev_cb(ev) (ev)->cb /* rw */ 724#define ev_cb_(ev) (ev)->cb /* rw */
725#define ev_cb(ev) (memmove (&ev_cb_ (ev), &((ev_watcher *)(ev))->cb, sizeof (ev_cb_ (ev))), (ev)->cb)
693 726
694#if EV_MINPRI == EV_MAXPRI 727#if EV_MINPRI == EV_MAXPRI
695# define ev_priority(ev) ((ev), EV_MINPRI) 728# define ev_priority(ev) ((ev), EV_MINPRI)
696# define ev_set_priority(ev,pri) ((ev), (pri)) 729# define ev_set_priority(ev,pri) ((ev), (pri))
697#else 730#else
… …
700#endif 733#endif
701 734
702#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at) 735#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
703 736
704#ifndef ev_set_cb 737#ifndef ev_set_cb
705# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 738# define ev_set_cb(ev,cb_) (ev_cb_ (ev) = (cb_), memmove (&((ev_watcher *)(ev))->cb, &ev_cb_ (ev), sizeof (ev_cb_ (ev))))
706#endif 739#endif
707 740
708/* stopping (enabling, adding) a watcher does nothing if it is already running */ 741/* stopping (enabling, adding) a watcher does nothing if it is already running */
709/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 742/* stopping (disabling, deleting) a watcher does nothing unless it's already running */
710#if EV_PROTOTYPES 743#if EV_PROTOTYPES
711 744
712/* feeds an event into a watcher as if the event actually occured */ 745/* feeds an event into a watcher as if the event actually occurred */
713/* accepts any ev_watcher type */ 746/* accepts any ev_watcher type */
714void ev_feed_event (EV_P_ void *w, int revents); 747EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents) EV_THROW;
715void ev_feed_fd_event (EV_P_ int fd, int revents); 748EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents) EV_THROW;
716#if EV_SIGNAL_ENABLE 749#if EV_SIGNAL_ENABLE
750EV_API_DECL void ev_feed_signal (int signum) EV_THROW;
717void ev_feed_signal_event (EV_P_ int signum); 751EV_API_DECL void ev_feed_signal_event (EV_P_ int signum) EV_THROW;
718#endif 752#endif
719void ev_invoke (EV_P_ void *w, int revents); 753EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
720int ev_clear_pending (EV_P_ void *w); 754EV_API_DECL int ev_clear_pending (EV_P_ void *w) EV_THROW;
721 755
722void ev_io_start (EV_P_ ev_io *w); 756EV_API_DECL void ev_io_start (EV_P_ ev_io *w) EV_THROW;
723void ev_io_stop (EV_P_ ev_io *w); 757EV_API_DECL void ev_io_stop (EV_P_ ev_io *w) EV_THROW;
724 758
725void ev_timer_start (EV_P_ ev_timer *w); 759EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w) EV_THROW;
726void ev_timer_stop (EV_P_ ev_timer *w); 760EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w) EV_THROW;
727/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 761/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
728void ev_timer_again (EV_P_ ev_timer *w); 762EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w) EV_THROW;
729/* return remaining time */ 763/* return remaining time */
730ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); 764EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w) EV_THROW;
731 765
732#if EV_PERIODIC_ENABLE 766#if EV_PERIODIC_ENABLE
733void ev_periodic_start (EV_P_ ev_periodic *w); 767EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w) EV_THROW;
734void ev_periodic_stop (EV_P_ ev_periodic *w); 768EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w) EV_THROW;
735void ev_periodic_again (EV_P_ ev_periodic *w); 769EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w) EV_THROW;
736#endif 770#endif
737 771
738/* only supported in the default loop */ 772/* only supported in the default loop */
739#if EV_SIGNAL_ENABLE 773#if EV_SIGNAL_ENABLE
740void ev_signal_start (EV_P_ ev_signal *w); 774EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w) EV_THROW;
741void ev_signal_stop (EV_P_ ev_signal *w); 775EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w) EV_THROW;
742#endif 776#endif
743 777
744/* only supported in the default loop */ 778/* only supported in the default loop */
745# if EV_CHILD_ENABLE 779# if EV_CHILD_ENABLE
746void ev_child_start (EV_P_ ev_child *w); 780EV_API_DECL void ev_child_start (EV_P_ ev_child *w) EV_THROW;
747void ev_child_stop (EV_P_ ev_child *w); 781EV_API_DECL void ev_child_stop (EV_P_ ev_child *w) EV_THROW;
748# endif 782# endif
749 783
750# if EV_STAT_ENABLE 784# if EV_STAT_ENABLE
751void ev_stat_start (EV_P_ ev_stat *w); 785EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w) EV_THROW;
752void ev_stat_stop (EV_P_ ev_stat *w); 786EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w) EV_THROW;
753void ev_stat_stat (EV_P_ ev_stat *w); 787EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w) EV_THROW;
754# endif 788# endif
755 789
756# if EV_IDLE_ENABLE 790# if EV_IDLE_ENABLE
757void ev_idle_start (EV_P_ ev_idle *w); 791EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w) EV_THROW;
758void ev_idle_stop (EV_P_ ev_idle *w); 792EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w) EV_THROW;
759# endif 793# endif
760 794
761#if EV_PREPARE_ENABLE 795#if EV_PREPARE_ENABLE
762void ev_prepare_start (EV_P_ ev_prepare *w); 796EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w) EV_THROW;
763void ev_prepare_stop (EV_P_ ev_prepare *w); 797EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w) EV_THROW;
764#endif 798#endif
765 799
766#if EV_CHECK_ENABLE 800#if EV_CHECK_ENABLE
767void ev_check_start (EV_P_ ev_check *w); 801EV_API_DECL void ev_check_start (EV_P_ ev_check *w) EV_THROW;
768void ev_check_stop (EV_P_ ev_check *w); 802EV_API_DECL void ev_check_stop (EV_P_ ev_check *w) EV_THROW;
769#endif 803#endif
770 804
771# if EV_FORK_ENABLE 805# if EV_FORK_ENABLE
772void ev_fork_start (EV_P_ ev_fork *w); 806EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w) EV_THROW;
773void ev_fork_stop (EV_P_ ev_fork *w); 807EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w) EV_THROW;
808# endif
809
810# if EV_CLEANUP_ENABLE
811EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w) EV_THROW;
812EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w) EV_THROW;
774# endif 813# endif
775 814
776# if EV_EMBED_ENABLE 815# if EV_EMBED_ENABLE
777/* only supported when loop to be embedded is in fact embeddable */ 816/* only supported when loop to be embedded is in fact embeddable */
778void ev_embed_start (EV_P_ ev_embed *w); 817EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w) EV_THROW;
779void ev_embed_stop (EV_P_ ev_embed *w); 818EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w) EV_THROW;
780void ev_embed_sweep (EV_P_ ev_embed *w); 819EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w) EV_THROW;
781# endif 820# endif
782 821
783# if EV_ASYNC_ENABLE 822# if EV_ASYNC_ENABLE
784void ev_async_start (EV_P_ ev_async *w); 823EV_API_DECL void ev_async_start (EV_P_ ev_async *w) EV_THROW;
785void ev_async_stop (EV_P_ ev_async *w); 824EV_API_DECL void ev_async_stop (EV_P_ ev_async *w) EV_THROW;
786void ev_async_send (EV_P_ ev_async *w); 825EV_API_DECL void ev_async_send (EV_P_ ev_async *w) EV_THROW;
787# endif 826# endif
788 827
789#if EV_COMPAT3 828#if EV_COMPAT3
790 #define EVLOOP_NONBLOCK EVRUN_NOWAIT 829 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
791 #define EVLOOP_ONESHOT EVRUN_ONCE 830 #define EVLOOP_ONESHOT EVRUN_ONCE
… …
793 #define EVUNLOOP_ONE EVBREAK_ONE 832 #define EVUNLOOP_ONE EVBREAK_ONE
794 #define EVUNLOOP_ALL EVBREAK_ALL 833 #define EVUNLOOP_ALL EVBREAK_ALL
795 #if EV_PROTOTYPES 834 #if EV_PROTOTYPES
796 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); } 835 EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
797 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); } 836 EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
837 EV_INLINE void ev_default_destroy (void) { ev_loop_destroy (EV_DEFAULT); }
838 EV_INLINE void ev_default_fork (void) { ev_loop_fork (EV_DEFAULT); }
798 #if EV_FEATURE_API 839 #if EV_FEATURE_API
799 EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); } 840 EV_INLINE unsigned int ev_loop_count (EV_P) { return ev_iteration (EV_A); }
800 EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); } 841 EV_INLINE unsigned int ev_loop_depth (EV_P) { return ev_depth (EV_A); }
801 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); } 842 EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
802 #endif 843 #endif
803 #endif 844 #endif
804#else 845#else
805 typedef struct ev_loop ev_loop; 846 typedef struct ev_loop ev_loop;
806#endif 847#endif
807 848
808#endif 849#endif
809 850
810#ifdef __cplusplus 851EV_CPP(})
811}
812#endif
813 852
814#endif 853#endif
815 854

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines