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 | * |
… | |
… | |
131 | /* eventmask, revents, events... */ |
131 | /* eventmask, revents, events... */ |
132 | #define EV_UNDEF -1 /* guaranteed to be invalid */ |
132 | #define EV_UNDEF -1 /* guaranteed to be invalid */ |
133 | #define EV_NONE 0x00 /* no events */ |
133 | #define EV_NONE 0x00 /* no events */ |
134 | #define EV_READ 0x01 /* ev_io detected read will not block */ |
134 | #define EV_READ 0x01 /* ev_io detected read will not block */ |
135 | #define EV_WRITE 0x02 /* ev_io detected write will not block */ |
135 | #define EV_WRITE 0x02 /* ev_io detected write will not block */ |
136 | #define EV_IOFDSET 0x80 /* internal use only */ |
136 | #define EV__IOFDSET 0x80 /* internal use only */ |
|
|
137 | #define EV_IO EV_READ /* alias for type-detection */ |
137 | #define EV_TIMEOUT 0x00000100 /* timer timed out */ |
138 | #define EV_TIMEOUT 0x00000100 /* timer timed out */ |
|
|
139 | #define EV_TIMER EV_TIMEOUT /* alias for type-detection */ |
138 | #define EV_PERIODIC 0x00000200 /* periodic timer timed out */ |
140 | #define EV_PERIODIC 0x00000200 /* periodic timer timed out */ |
139 | #define EV_SIGNAL 0x00000400 /* signal was received */ |
141 | #define EV_SIGNAL 0x00000400 /* signal was received */ |
140 | #define EV_CHILD 0x00000800 /* child/pid had status change */ |
142 | #define EV_CHILD 0x00000800 /* child/pid had status change */ |
141 | #define EV_STAT 0x00001000 /* stat data changed */ |
143 | #define EV_STAT 0x00001000 /* stat data changed */ |
142 | #define EV_IDLE 0x00002000 /* event loop is idling */ |
144 | #define EV_IDLE 0x00002000 /* event loop is idling */ |
143 | #define EV_PREPARE 0x00004000 /* event loop about to poll */ |
145 | #define EV_PREPARE 0x00004000 /* event loop about to poll */ |
144 | #define EV_CHECK 0x00008000 /* event loop finished poll */ |
146 | #define EV_CHECK 0x00008000 /* event loop finished poll */ |
145 | #define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ |
147 | #define EV_EMBED 0x00010000 /* embedded event loop needs sweep */ |
146 | #define EV_FORK 0x00020000 /* event loop resumed in child */ |
148 | #define EV_FORK 0x00020000 /* event loop resumed in child */ |
147 | #define EV_ASYNC 0x00040000 /* async intra-loop signal */ |
149 | #define EV_ASYNC 0x00040000 /* async intra-loop signal */ |
|
|
150 | #define EV_CUSTOM 0x01000000 /* for use by user code */ |
148 | #define EV_ERROR 0x80000000 /* sent when an error occurs */ |
151 | #define EV_ERROR 0x80000000 /* sent when an error occurs */ |
149 | |
152 | |
150 | /* can be used to add custom fields to all watchers, while losing binary compatibility */ |
153 | /* can be used to add custom fields to all watchers, while losing binary compatibility */ |
151 | #ifndef EV_COMMON |
154 | #ifndef EV_COMMON |
152 | # define EV_COMMON void *data; |
155 | # define EV_COMMON void *data; |
… | |
… | |
165 | # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) |
168 | # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) |
166 | #endif |
169 | #endif |
167 | |
170 | |
168 | /* |
171 | /* |
169 | * struct member types: |
172 | * struct member types: |
170 | * private: you can look at them, but not change them, and they might not mean anything to you. |
173 | * private: you may look at them, but not change them, |
|
|
174 | * and they might not mean anything to you. |
171 | * ro: can be read anytime, but only changed when the watcher isn't active |
175 | * 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 |
176 | * rw: can be read and modified anytime, even when the watcher is active. |
173 | * |
177 | * |
174 | * some internal details that might be helpful for debugging: |
178 | * some internal details that might be helpful for debugging: |
175 | * |
179 | * |
176 | * active is either 0, which means the watcher is not active, |
180 | * active is either 0, which means the watcher is not active, |
177 | * or the array index of the watcher (periodics, timers) |
181 | * or the array index of the watcher (periodics, timers) |
178 | * or the array index + 1 (most other watchers) |
182 | * or the array index + 1 (most other watchers) |
179 | * or simply 1 for watchers that aren't in some array. |
183 | * or simply 1 for watchers that aren't in some array. |
180 | * pending is either 0, in which case the watcher isn't, |
184 | * pending is either 0, in which case the watcher isn't, |
181 | * or the array index + 1 in the pendings array. |
185 | * or the array index + 1 in the pendings array. |
182 | */ |
186 | */ |
183 | |
187 | |
184 | /* shared by all watchers */ |
188 | /* shared by all watchers */ |
185 | #define EV_WATCHER(type) \ |
189 | #define EV_WATCHER(type) \ |
186 | int active; /* private */ \ |
190 | int active; /* private */ \ |
… | |
… | |
488 | /* if you create alternative loops you have to call ev_loop_fork on them */ |
492 | /* 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 */ |
493 | /* you can call it in either the parent or the child */ |
490 | /* you can actually call it at any time, anywhere :) */ |
494 | /* you can actually call it at any time, anywhere :) */ |
491 | void ev_default_fork (void); |
495 | void ev_default_fork (void); |
492 | |
496 | |
|
|
497 | #if 0 |
|
|
498 | /* walk (almost) all watchers in the loop of a given type, invoking the */ |
|
|
499 | /* callback on every such watcher. The callback might stop the watcher, */ |
|
|
500 | /* but do nothing else with the loop */ |
|
|
501 | void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); |
|
|
502 | #endif |
|
|
503 | |
493 | unsigned int ev_backend (EV_P); /* backend in use by loop */ |
504 | unsigned int ev_backend (EV_P); /* backend in use by loop */ |
494 | unsigned int ev_loop_count (EV_P); /* number of loop iterations */ |
505 | unsigned int ev_loop_count (EV_P); /* number of loop iterations */ |
495 | #endif /* prototypes */ |
506 | #endif /* prototypes */ |
496 | |
507 | |
497 | #define EVLOOP_NONBLOCK 1 /* do not block/wait */ |
508 | #define EVLOOP_NONBLOCK 1 /* do not block/wait */ |
… | |
… | |
513 | * should not keep ev_loop from running, unref() after starting, and ref() before stopping. |
524 | * should not keep ev_loop from running, unref() after starting, and ref() before stopping. |
514 | */ |
525 | */ |
515 | void ev_ref (EV_P); |
526 | void ev_ref (EV_P); |
516 | void ev_unref (EV_P); |
527 | void ev_unref (EV_P); |
517 | |
528 | |
|
|
529 | /* |
|
|
530 | * stop/start the timer handling. |
|
|
531 | */ |
|
|
532 | void ev_suspend (EV_P); |
|
|
533 | void ev_resume (EV_P); |
|
|
534 | |
|
|
535 | /* |
518 | /* convinience function, wait for a single event, without registering an event watcher */ |
536 | * convenience function, wait for a single event, without registering an event watcher |
519 | /* if timeout is < 0, do wait indefinitely */ |
537 | * if timeout is < 0, do wait indefinitely |
|
|
538 | */ |
520 | void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
539 | void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); |
521 | #endif |
540 | #endif |
522 | |
541 | |
523 | /* these may evaluate ev multiple times, and the other arguments at most once */ |
542 | /* 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 */ |
543 | /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ |
… | |
… | |
527 | ((ev_watcher *)(void *)(ev))->pending = \ |
546 | ((ev_watcher *)(void *)(ev))->pending = \ |
528 | ((ev_watcher *)(void *)(ev))->priority = 0; \ |
547 | ((ev_watcher *)(void *)(ev))->priority = 0; \ |
529 | ev_set_cb ((ev), cb_); \ |
548 | ev_set_cb ((ev), cb_); \ |
530 | } while (0) |
549 | } while (0) |
531 | |
550 | |
532 | #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) |
551 | #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) |
552 | #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) |
553 | #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) |
554 | #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) |
555 | #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) |
556 | #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 */ |
557 | #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 */ |
558 | #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 */ |
559 | #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) |
560 | #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 */ |
561 | #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) |
562 | #define ev_async_set(ev) do { (ev)->sent = 0; } while (0) |
544 | |
563 | |
545 | #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) |
564 | #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) |
565 | #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) |
566 | #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) |
567 | #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) |
568 | #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) |
569 | #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) |
570 | #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) |
571 | #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) |
572 | #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) |
573 | #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) |
574 | #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) |
575 | #define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0) |
557 | |
576 | |
558 | #define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ |
577 | #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 */ |
578 | #define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ |
560 | |
579 | |
561 | #define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) |
580 | #define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) |
562 | #define ev_cb(ev) (ev)->cb /* rw */ |
581 | #define ev_cb(ev) (ev)->cb /* rw */ |
563 | #define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) |
582 | #define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) |
564 | |
583 | |
565 | #define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) |
584 | #define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) |
566 | |
585 | |
567 | #ifndef ev_set_cb |
586 | #ifndef ev_set_cb |
568 | # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) |
587 | # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) |
569 | #endif |
588 | #endif |
570 | |
589 | |
571 | /* stopping (enabling, adding) a watcher does nothing if it is already running */ |
590 | /* stopping (enabling, adding) a watcher does nothing if it is already running */ |
572 | /* stopping (disabling, deleting) a watcher does nothing unless its already running */ |
591 | /* stopping (disabling, deleting) a watcher does nothing unless its already running */ |
573 | #if EV_PROTOTYPES |
592 | #if EV_PROTOTYPES |