1 | /* |
1 | /* |
2 | * libev native API header |
2 | * libev native API header |
3 | * |
3 | * |
4 | * Copyright (c) 2007,2008 Marc Alexander Lehmann <libev@schmorp.de> |
4 | * Copyright (c) 2007,2008,2009 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 | * |
… | |
… | |
80 | |
80 | |
81 | #ifndef EV_ASYNC_ENABLE |
81 | #ifndef EV_ASYNC_ENABLE |
82 | # define EV_ASYNC_ENABLE 1 |
82 | # define EV_ASYNC_ENABLE 1 |
83 | #endif |
83 | #endif |
84 | |
84 | |
|
|
85 | #ifndef EV_WALK_ENABLE |
|
|
86 | # define EV_WALK_ENABLE 0 /* not yet */ |
|
|
87 | #endif |
|
|
88 | |
85 | #ifndef EV_ATOMIC_T |
89 | #ifndef EV_ATOMIC_T |
86 | # include <signal.h> |
90 | # include <signal.h> |
87 | # define EV_ATOMIC_T sig_atomic_t volatile |
91 | # define EV_ATOMIC_T sig_atomic_t volatile |
88 | #endif |
92 | #endif |
89 | |
93 | |
… | |
… | |
131 | /* eventmask, revents, events... */ |
135 | /* eventmask, revents, events... */ |
132 | #define EV_UNDEF -1 /* guaranteed to be invalid */ |
136 | #define EV_UNDEF -1 /* guaranteed to be invalid */ |
133 | #define EV_NONE 0x00 /* no events */ |
137 | #define EV_NONE 0x00 /* no events */ |
134 | #define EV_READ 0x01 /* ev_io detected read will not block */ |
138 | #define EV_READ 0x01 /* ev_io detected read will not block */ |
135 | #define EV_WRITE 0x02 /* ev_io detected write will not block */ |
139 | #define EV_WRITE 0x02 /* ev_io detected write will not block */ |
136 | #define EV_IOFDSET 0x80 /* internal use only */ |
140 | #define EV__IOFDSET 0x80 /* internal use only */ |
|
|
141 | #define EV_IO EV_READ /* alias for type-detection */ |
137 | #define EV_TIMEOUT 0x00000100 /* timer timed out */ |
142 | #define EV_TIMEOUT 0x00000100 /* timer timed out */ |
|
|
143 | #define EV_TIMER EV_TIMEOUT /* alias for type-detection */ |
138 | #define EV_PERIODIC 0x00000200 /* periodic timer timed out */ |
144 | #define EV_PERIODIC 0x00000200 /* periodic timer timed out */ |
139 | #define EV_SIGNAL 0x00000400 /* signal was received */ |
145 | #define EV_SIGNAL 0x00000400 /* signal was received */ |
140 | #define EV_CHILD 0x00000800 /* child/pid had status change */ |
146 | #define EV_CHILD 0x00000800 /* child/pid had status change */ |
141 | #define EV_STAT 0x00001000 /* stat data changed */ |
147 | #define EV_STAT 0x00001000 /* stat data changed */ |
142 | #define EV_IDLE 0x00002000 /* event loop is idling */ |
148 | #define EV_IDLE 0x00002000 /* event loop is idling */ |
143 | #define EV_PREPARE 0x00004000 /* event loop about to poll */ |
149 | #define EV_PREPARE 0x00004000 /* event loop about to poll */ |
144 | #define EV_CHECK 0x00008000 /* event loop finished poll */ |
150 | #define EV_CHECK 0x00008000 /* event loop finished poll */ |
145 | #define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ |
151 | #define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ |
146 | #define EV_FORK 0x00020000 /* event loop resumed in child */ |
152 | #define EV_FORK 0x00020000 /* event loop resumed in child */ |
147 | #define EV_ASYNC 0x00040000 /* async intra-loop signal */ |
153 | #define EV_ASYNC 0x00040000 /* async intra-loop signal */ |
|
|
154 | #define EV_CUSTOM 0x01000000 /* for use by user code */ |
148 | #define EV_ERROR 0x80000000 /* sent when an error occurs */ |
155 | #define EV_ERROR 0x80000000 /* sent when an error occurs */ |
149 | |
156 | |
150 | /* can be used to add custom fields to all watchers, while losing binary compatibility */ |
157 | /* can be used to add custom fields to all watchers, while losing binary compatibility */ |
151 | #ifndef EV_COMMON |
158 | #ifndef EV_COMMON |
152 | # define EV_COMMON void *data; |
159 | # define EV_COMMON void *data; |
… | |
… | |
165 | # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) |
172 | # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) |
166 | #endif |
173 | #endif |
167 | |
174 | |
168 | /* |
175 | /* |
169 | * struct member types: |
176 | * struct member types: |
170 | * private: you can look at them, but not change them, and they might not mean anything to you. |
177 | * private: you may look at them, but not change them, |
|
|
178 | * and they might not mean anything to you. |
171 | * ro: can be read anytime, but only changed when the watcher isn't active |
179 | * ro: can be read anytime, but only changed when the watcher isn't active. |
172 | * rw: can be read and modified anytime, even when the watcher is active |
180 | * rw: can be read and modified anytime, even when the watcher is active. |
173 | * |
181 | * |
174 | * some internal details that might be helpful for debugging: |
182 | * some internal details that might be helpful for debugging: |
175 | * |
183 | * |
176 | * active is either 0, which means the watcher is not active, |
184 | * active is either 0, which means the watcher is not active, |
177 | * or the array index of the watcher (periodics, timers) |
185 | * or the array index of the watcher (periodics, timers) |
178 | * or the array index + 1 (most other watchers) |
186 | * or the array index + 1 (most other watchers) |
179 | * or simply 1 for watchers that aren't in some array. |
187 | * or simply 1 for watchers that aren't in some array. |
180 | * pending is either 0, in which case the watcher isn't, |
188 | * pending is either 0, in which case the watcher isn't, |
181 | * or the array index + 1 in the pendings array. |
189 | * or the array index + 1 in the pendings array. |
182 | */ |
190 | */ |
|
|
191 | |
|
|
192 | #if EV_MINPRI == EV_MAXPRI |
|
|
193 | # define EV_DECL_PRIORITY |
|
|
194 | #else |
|
|
195 | # define EV_DECL_PRIORITY int priority; |
|
|
196 | #endif |
183 | |
197 | |
184 | /* shared by all watchers */ |
198 | /* shared by all watchers */ |
185 | #define EV_WATCHER(type) \ |
199 | #define EV_WATCHER(type) \ |
186 | int active; /* private */ \ |
200 | int active; /* private */ \ |
187 | int pending; /* private */ \ |
201 | int pending; /* private */ \ |
188 | int priority; /* private */ \ |
202 | EV_DECL_PRIORITY /* private */ \ |
189 | EV_COMMON /* rw */ \ |
203 | EV_COMMON /* rw */ \ |
190 | EV_CB_DECLARE (type) /* private */ |
204 | EV_CB_DECLARE (type) /* private */ |
191 | |
205 | |
192 | #define EV_WATCHER_LIST(type) \ |
206 | #define EV_WATCHER_LIST(type) \ |
193 | EV_WATCHER (type) \ |
207 | EV_WATCHER (type) \ |
… | |
… | |
451 | |
465 | |
452 | /* create and destroy alternative loops that don't handle signals */ |
466 | /* create and destroy alternative loops that don't handle signals */ |
453 | struct ev_loop *ev_loop_new (unsigned int flags); |
467 | struct ev_loop *ev_loop_new (unsigned int flags); |
454 | void ev_loop_destroy (EV_P); |
468 | void ev_loop_destroy (EV_P); |
455 | void ev_loop_fork (EV_P); |
469 | void ev_loop_fork (EV_P); |
456 | void ev_loop_verify (EV_P); |
|
|
457 | |
470 | |
458 | ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ |
471 | ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ |
459 | void ev_now_update (EV_P); |
|
|
460 | |
472 | |
461 | #else |
473 | #else |
462 | |
474 | |
463 | int ev_default_loop (unsigned int flags); /* returns true when successful */ |
475 | int ev_default_loop (unsigned int flags); /* returns true when successful */ |
464 | |
476 | |
… | |
… | |
488 | /* if you create alternative loops you have to call ev_loop_fork on them */ |
500 | /* if you create alternative loops you have to call ev_loop_fork on them */ |
489 | /* you can call it in either the parent or the child */ |
501 | /* you can call it in either the parent or the child */ |
490 | /* you can actually call it at any time, anywhere :) */ |
502 | /* you can actually call it at any time, anywhere :) */ |
491 | void ev_default_fork (void); |
503 | void ev_default_fork (void); |
492 | |
504 | |
493 | unsigned int ev_backend (EV_P); /* backend in use by loop */ |
505 | unsigned int ev_backend (EV_P); /* backend in use by loop */ |
494 | unsigned int ev_loop_count (EV_P); /* number of loop iterations */ |
506 | |
|
|
507 | void ev_now_update (EV_P); /* update event loop time */ |
|
|
508 | |
|
|
509 | #if EV_WALK_ENABLE |
|
|
510 | /* walk (almost) all watchers in the loop of a given type, invoking the */ |
|
|
511 | /* callback on every such watcher. The callback might stop the watcher, */ |
|
|
512 | /* but do nothing else with the loop */ |
|
|
513 | void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); |
|
|
514 | #endif |
|
|
515 | |
495 | #endif /* prototypes */ |
516 | #endif /* prototypes */ |
496 | |
517 | |
497 | #define EVLOOP_NONBLOCK 1 /* do not block/wait */ |
518 | #define EVLOOP_NONBLOCK 1 /* do not block/wait */ |
498 | #define EVLOOP_ONESHOT 2 /* block *once* only */ |
519 | #define EVLOOP_ONESHOT 2 /* block *once* only */ |
499 | #define EVUNLOOP_CANCEL 0 /* undo unloop */ |
520 | #define EVUNLOOP_CANCEL 0 /* undo unloop */ |
… | |
… | |
502 | |
523 | |
503 | #if EV_PROTOTYPES |
524 | #if EV_PROTOTYPES |
504 | void ev_loop (EV_P_ int flags); |
525 | void ev_loop (EV_P_ int flags); |
505 | void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ |
526 | void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ |
506 | |
527 | |
507 | void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ |
|
|
508 | void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ |
|
|
509 | |
|
|
510 | /* |
528 | /* |
511 | * ref/unref can be used to add or remove a refcount on the mainloop. every watcher |
529 | * ref/unref can be used to add or remove a refcount on the mainloop. every watcher |
512 | * keeps one reference. if you have a long-runing watcher you never unregister that |
530 | * keeps one reference. if you have a long-running watcher you never unregister that |
513 | * should not keep ev_loop from running, unref() after starting, and ref() before stopping. |
531 | * should not keep ev_loop from running, unref() after starting, and ref() before stopping. |
514 | */ |
532 | */ |
515 | void ev_ref (EV_P); |
533 | void ev_ref (EV_P); |
516 | void ev_unref (EV_P); |
534 | void ev_unref (EV_P); |
517 | |
535 | |
|
|
536 | /* |
518 | /* convinience function, wait for a single event, without registering an event watcher */ |
537 | * convenience function, wait for a single event, without registering an event watcher |
519 | /* if timeout is < 0, do wait indefinitely */ |
538 | * if timeout is < 0, do wait indefinitely |
|
|
539 | */ |
520 | void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
540 | void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
|
|
541 | |
|
|
542 | # if EV_MINIMAL < 2 |
|
|
543 | unsigned int ev_loop_count (EV_P); /* number of loop iterations */ |
|
|
544 | unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ |
|
|
545 | void ev_loop_verify (EV_P); /* abort if loop data corrupted */ |
|
|
546 | |
|
|
547 | void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ |
|
|
548 | void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ |
|
|
549 | |
|
|
550 | /* advanced stuff for threading etc. support, see docs */ |
|
|
551 | void ev_set_userdata (EV_P_ void *data); |
|
|
552 | void *ev_userdata (EV_P); |
|
|
553 | void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); |
|
|
554 | void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); |
|
|
555 | |
|
|
556 | void ev_invoke_pending (EV_P); /* invoke all pending watchers */ |
|
|
557 | |
|
|
558 | /* |
|
|
559 | * stop/start the timer handling. |
|
|
560 | */ |
|
|
561 | void ev_suspend (EV_P); |
|
|
562 | void ev_resume (EV_P); |
|
|
563 | #endif |
|
|
564 | |
521 | #endif |
565 | #endif |
522 | |
566 | |
523 | /* these may evaluate ev multiple times, and the other arguments at most once */ |
567 | /* these may evaluate ev multiple times, and the other arguments at most once */ |
524 | /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ |
568 | /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ |
525 | #define ev_init(ev,cb_) do { \ |
569 | #define ev_init(ev,cb_) do { \ |
526 | ((ev_watcher *)(void *)(ev))->active = \ |
570 | ((ev_watcher *)(void *)(ev))->active = \ |
527 | ((ev_watcher *)(void *)(ev))->pending = \ |
571 | ((ev_watcher *)(void *)(ev))->pending = 0; \ |
528 | ((ev_watcher *)(void *)(ev))->priority = 0; \ |
572 | ev_set_priority ((ev), 0); \ |
529 | ev_set_cb ((ev), cb_); \ |
573 | ev_set_cb ((ev), cb_); \ |
530 | } while (0) |
574 | } while (0) |
531 | |
575 | |
532 | #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) |
576 | #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV__IOFDSET; } while (0) |
533 | #define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) |
577 | #define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0) |
534 | #define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) |
578 | #define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0) |
535 | #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) |
579 | #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) |
536 | #define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) |
580 | #define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0) |
537 | #define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) |
581 | #define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) |
538 | #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ |
582 | #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ |
539 | #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ |
583 | #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ |
540 | #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ |
584 | #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ |
541 | #define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) |
585 | #define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) |
542 | #define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ |
586 | #define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ |
543 | #define ev_async_set(ev) do { (ev)->sent = 0; } while (0) |
587 | #define ev_async_set(ev) do { (ev)->sent = 0; } while (0) |
544 | |
588 | |
545 | #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) |
589 | #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) |
546 | #define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) |
590 | #define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) |
547 | #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) |
591 | #define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) |
548 | #define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) |
592 | #define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) |
549 | #define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0) |
593 | #define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0) |
550 | #define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0) |
594 | #define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0) |
551 | #define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) |
595 | #define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) |
552 | #define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) |
596 | #define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) |
553 | #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) |
597 | #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) |
554 | #define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) |
598 | #define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) |
555 | #define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) |
599 | #define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) |
556 | #define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) |
600 | #define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) |
557 | |
601 | |
558 | #define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ |
602 | #define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ |
559 | #define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ |
603 | #define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ |
560 | |
604 | |
|
|
605 | #define ev_cb(ev) (ev)->cb /* rw */ |
|
|
606 | |
|
|
607 | #if EV_MINPRI == EV_MAXPRI |
|
|
608 | # define ev_priority(ev) ((ev), EV_MINPRI) |
|
|
609 | # define ev_set_priority(ev,pri) ((ev), (pri)) |
|
|
610 | #else |
561 | #define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) |
611 | # define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) |
562 | #define ev_cb(ev) (ev)->cb /* rw */ |
|
|
563 | #define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) |
612 | # define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri) |
|
|
613 | #endif |
564 | |
614 | |
565 | #define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) |
615 | #define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) |
566 | |
616 | |
567 | #ifndef ev_set_cb |
617 | #ifndef ev_set_cb |
568 | # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) |
618 | # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) |
569 | #endif |
619 | #endif |
570 | |
620 | |
571 | /* stopping (enabling, adding) a watcher does nothing if it is already running */ |
621 | /* stopping (enabling, adding) a watcher does nothing if it is already running */ |
572 | /* stopping (disabling, deleting) a watcher does nothing unless its already running */ |
622 | /* stopping (disabling, deleting) a watcher does nothing unless its already running */ |
573 | #if EV_PROTOTYPES |
623 | #if EV_PROTOTYPES |