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

Comparing libev/ev.h (file contents):
Revision 1.118 by root, Thu Jul 9 09:11:20 2009 UTC vs.
Revision 1.134 by root, Tue Mar 16 00:20:17 2010 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010 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 *
… …
35 * and other provisions required by the GPL. If you do not delete the 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 36 * provisions above, a recipient may use your version of this file under
37 * either the BSD or the GPL. 37 * either the BSD or the GPL.
38 */ 38 */
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" { 44extern "C" {
45#endif 45#endif
46 46
47typedef double ev_tstamp; 47/*****************************************************************************/
48
49#ifndef EV_FEATURES
50# define EV_FEATURES 0x3f
51#endif
52
53#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
54#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
55#define EV_FEATURE_API ((EV_FEATURES) & 4)
56#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 8)
57#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 16)
58#define EV_FEATURE_OS ((EV_FEATURES) & 32)
48 59
49/* these priorities are inclusive, higher priorities will be called earlier */ 60/* these priorities are inclusive, higher priorities will be called earlier */
50#ifndef EV_MINPRI 61#ifndef EV_MINPRI
51# define EV_MINPRI -2 62# define EV_MINPRI (EV_FEATURE_API ? -2 : 0)
52#endif 63#endif
53#ifndef EV_MAXPRI 64#ifndef EV_MAXPRI
54# define EV_MAXPRI +2 65# define EV_MAXPRI (EV_FEATURE_API ? +2 : 0)
55#endif 66#endif
56 67
57#ifndef EV_MULTIPLICITY 68#ifndef EV_MULTIPLICITY
58# define EV_MULTIPLICITY 1 69# define EV_MULTIPLICITY EV_FEATURE_API
59#endif 70#endif
60 71
61#ifndef EV_PERIODIC_ENABLE 72#ifndef EV_PERIODIC_ENABLE
62# define EV_PERIODIC_ENABLE 1 73# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
63#endif 74#endif
64 75
65#ifndef EV_STAT_ENABLE 76#ifndef EV_STAT_ENABLE
66# define EV_STAT_ENABLE 1 77# define EV_STAT_ENABLE EV_FEATURE_WATCHERS
78#endif
79
80#ifndef EV_PREPARE_ENABLE
81# define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
82#endif
83
84#ifndef EV_CHECK_ENABLE
85# define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
67#endif 86#endif
68 87
69#ifndef EV_IDLE_ENABLE 88#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1 89# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
71#endif 90#endif
72 91
73#ifndef EV_FORK_ENABLE 92#ifndef EV_FORK_ENABLE
93# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
94#endif
95
96#ifndef EV_SIGNAL_ENABLE
97# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
98#endif
99
100#ifndef EV_CHILD_ENABLE
101# ifdef _WIN32
74# define EV_FORK_ENABLE 1 102# define EV_CHILD_ENABLE 0
103# else
104# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
105#endif
106#endif
107
108#ifndef EV_ASYNC_ENABLE
109# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
75#endif 110#endif
76 111
77#ifndef EV_EMBED_ENABLE 112#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1 113# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
79#endif
80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif 114#endif
84 115
85#ifndef EV_WALK_ENABLE 116#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */ 117# define EV_WALK_ENABLE 0 /* not yet */
87#endif 118#endif
119
120/*****************************************************************************/
121
122#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
123# undef EV_SIGNAL_ENABLE
124# define EV_SIGNAL_ENABLE 1
125#endif
126
127/*****************************************************************************/
128
129#if !EV_FEATURE_CODE && !defined (NDEBUG)
130# define NDEBUG 1
131# include <assert.h>
132#endif
133
134typedef double ev_tstamp;
88 135
89#ifndef EV_ATOMIC_T 136#ifndef EV_ATOMIC_T
90# include <signal.h> 137# include <signal.h>
91# define EV_ATOMIC_T sig_atomic_t volatile 138# define EV_ATOMIC_T sig_atomic_t volatile
92#endif 139#endif
93
94/*****************************************************************************/
95 140
96#if EV_STAT_ENABLE 141#if EV_STAT_ENABLE
97# ifdef _WIN32 142# ifdef _WIN32
98# include <time.h> 143# include <time.h>
99# include <sys/types.h> 144# include <sys/types.h>
… …
161#ifndef EV_PROTOTYPES 206#ifndef EV_PROTOTYPES
162# define EV_PROTOTYPES 1 207# define EV_PROTOTYPES 1
163#endif 208#endif
164 209
165#define EV_VERSION_MAJOR 3 210#define EV_VERSION_MAJOR 3
166#define EV_VERSION_MINOR 0 211#define EV_VERSION_MINOR 9
167 212
168#ifndef EV_CB_DECLARE 213#ifndef EV_CB_DECLARE
169# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 214# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
170#endif 215#endif
171#ifndef EV_CB_INVOKE 216#ifndef EV_CB_INVOKE
… …
363 EV_WATCHER (ev_async) 408 EV_WATCHER (ev_async)
364 409
365 EV_ATOMIC_T sent; /* private */ 410 EV_ATOMIC_T sent; /* private */
366} ev_async; 411} ev_async;
367 412
368# define ev_async_pending(w) ((w)->sent + 0) 413# define ev_async_pending(w) (+(w)->sent)
369#endif 414#endif
370 415
371/* the presence of this union forces similar struct layout */ 416/* the presence of this union forces similar struct layout */
372union ev_any_watcher 417union ev_any_watcher
373{ 418{
… …
402/* the default */ 447/* the default */
403#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 448#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
404/* flag bits */ 449/* flag bits */
405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 450#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
406#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 451#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
452/* debugging/feature disable */
453#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
454#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */
455#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */
407/* method bits to be ored together */ 456/* method bits to be ored together */
408#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 457#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
409#define EVBACKEND_POLL 0x00000002U /* !win */ 458#define EVBACKEND_POLL 0x00000002U /* !win */
410#define EVBACKEND_EPOLL 0x00000004U /* linux */ 459#define EVBACKEND_EPOLL 0x00000004U /* linux */
411#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 460#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
412#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 461#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
413#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 462#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
463#define EVBACKEND_ALL 0x0000003FU
414 464
415#if EV_PROTOTYPES 465#if EV_PROTOTYPES
416int ev_version_major (void); 466int ev_version_major (void);
417int ev_version_minor (void); 467int ev_version_minor (void);
418 468
… …
500/* if you create alternative loops you have to call ev_loop_fork on them */ 550/* if you create alternative loops you have to call ev_loop_fork on them */
501/* you can call it in either the parent or the child */ 551/* you can call it in either the parent or the child */
502/* you can actually call it at any time, anywhere :) */ 552/* you can actually call it at any time, anywhere :) */
503void ev_default_fork (void); 553void ev_default_fork (void);
504 554
505unsigned int ev_backend (EV_P); /* backend in use by loop */ 555unsigned int ev_backend (EV_P); /* backend in use by loop */
506unsigned int ev_loop_count (EV_P); /* number of loop iterations */
507unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
508void ev_loop_verify (EV_P); /* abort if loop data corrupted */
509 556
510void ev_now_update (EV_P); /* update event loop time */ 557void ev_now_update (EV_P); /* update event loop time */
511void ev_invoke_pending (EV_P); /* invoke all pending watchers */
512 558
513#if EV_WALK_ENABLE 559#if EV_WALK_ENABLE
514/* walk (almost) all watchers in the loop of a given type, invoking the */ 560/* walk (almost) all watchers in the loop of a given type, invoking the */
515/* callback on every such watcher. The callback might stop the watcher, */ 561/* callback on every such watcher. The callback might stop the watcher, */
516/* but do nothing else with the loop */ 562/* but do nothing else with the loop */
… …
527 573
528#if EV_PROTOTYPES 574#if EV_PROTOTYPES
529void ev_loop (EV_P_ int flags); 575void ev_loop (EV_P_ int flags);
530void 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 */ 576void 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 */
531 577
532void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
533void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
534
535/* 578/*
536 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 579 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
537 * keeps one reference. if you have a long-runing watcher you never unregister that 580 * keeps one reference. if you have a long-running watcher you never unregister that
538 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 581 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
539 */ 582 */
540void ev_ref (EV_P); 583void ev_ref (EV_P);
541void ev_unref (EV_P); 584void ev_unref (EV_P);
585
586/*
587 * convenience function, wait for a single event, without registering an event watcher
588 * if timeout is < 0, do wait indefinitely
589 */
590void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
591
592# if EV_FEATURE_API
593unsigned int ev_loop_count (EV_P); /* number of loop iterations */
594unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
595void ev_loop_verify (EV_P); /* abort if loop data corrupted */
596
597void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
598void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
599
600/* advanced stuff for threading etc. support, see docs */
601void ev_set_userdata (EV_P_ void *data);
602void *ev_userdata (EV_P);
603void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
604void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
605
606unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
607void ev_invoke_pending (EV_P); /* invoke all pending watchers */
542 608
543/* 609/*
544 * stop/start the timer handling. 610 * stop/start the timer handling.
545 */ 611 */
546void ev_suspend (EV_P); 612void ev_suspend (EV_P);
547void ev_resume (EV_P); 613void ev_resume (EV_P);
614#endif
548 615
549/*
550 * convenience function, wait for a single event, without registering an event watcher
551 * if timeout is < 0, do wait indefinitely
552 */
553void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
554#endif 616#endif
555 617
556/* these may evaluate ev multiple times, and the other arguments at most once */ 618/* these may evaluate ev multiple times, and the other arguments at most once */
557/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 619/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
558#define ev_init(ev,cb_) do { \ 620#define ev_init(ev,cb_) do { \
… …
595 657
596#if EV_MINPRI == EV_MAXPRI 658#if EV_MINPRI == EV_MAXPRI
597# define ev_priority(ev) ((ev), EV_MINPRI) 659# define ev_priority(ev) ((ev), EV_MINPRI)
598# define ev_set_priority(ev,pri) ((ev), (pri)) 660# define ev_set_priority(ev,pri) ((ev), (pri))
599#else 661#else
600# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 662# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
601# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri) 663# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
602#endif 664#endif
603 665
604#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 666#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
605 667
606#ifndef ev_set_cb 668#ifndef ev_set_cb
607# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 669# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
608#endif 670#endif
609 671
… …
613 675
614/* feeds an event into a watcher as if the event actually occured */ 676/* feeds an event into a watcher as if the event actually occured */
615/* accepts any ev_watcher type */ 677/* accepts any ev_watcher type */
616void ev_feed_event (EV_P_ void *w, int revents); 678void ev_feed_event (EV_P_ void *w, int revents);
617void ev_feed_fd_event (EV_P_ int fd, int revents); 679void ev_feed_fd_event (EV_P_ int fd, int revents);
680#if EV_SIGNAL_ENABLE
618void ev_feed_signal_event (EV_P_ int signum); 681void ev_feed_signal_event (EV_P_ int signum);
682#endif
619void ev_invoke (EV_P_ void *w, int revents); 683void ev_invoke (EV_P_ void *w, int revents);
620int ev_clear_pending (EV_P_ void *w); 684int ev_clear_pending (EV_P_ void *w);
621 685
622void ev_io_start (EV_P_ ev_io *w); 686void ev_io_start (EV_P_ ev_io *w);
623void ev_io_stop (EV_P_ ev_io *w); 687void ev_io_stop (EV_P_ ev_io *w);
624 688
625void ev_timer_start (EV_P_ ev_timer *w); 689void ev_timer_start (EV_P_ ev_timer *w);
626void ev_timer_stop (EV_P_ ev_timer *w); 690void ev_timer_stop (EV_P_ ev_timer *w);
627/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 691/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
628void ev_timer_again (EV_P_ ev_timer *w); 692void ev_timer_again (EV_P_ ev_timer *w);
693/* return remaining time */
694ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
629 695
630#if EV_PERIODIC_ENABLE 696#if EV_PERIODIC_ENABLE
631void ev_periodic_start (EV_P_ ev_periodic *w); 697void ev_periodic_start (EV_P_ ev_periodic *w);
632void ev_periodic_stop (EV_P_ ev_periodic *w); 698void ev_periodic_stop (EV_P_ ev_periodic *w);
633void ev_periodic_again (EV_P_ ev_periodic *w); 699void ev_periodic_again (EV_P_ ev_periodic *w);
634#endif 700#endif
635 701
636/* only supported in the default loop */ 702/* only supported in the default loop */
703#if EV_SIGNAL_ENABLE
637void ev_signal_start (EV_P_ ev_signal *w); 704void ev_signal_start (EV_P_ ev_signal *w);
638void ev_signal_stop (EV_P_ ev_signal *w); 705void ev_signal_stop (EV_P_ ev_signal *w);
706#endif
639 707
640/* only supported in the default loop */ 708/* only supported in the default loop */
709# if EV_CHILD_ENABLE
641void ev_child_start (EV_P_ ev_child *w); 710void ev_child_start (EV_P_ ev_child *w);
642void ev_child_stop (EV_P_ ev_child *w); 711void ev_child_stop (EV_P_ ev_child *w);
712# endif
643 713
644# if EV_STAT_ENABLE 714# if EV_STAT_ENABLE
645void ev_stat_start (EV_P_ ev_stat *w); 715void ev_stat_start (EV_P_ ev_stat *w);
646void ev_stat_stop (EV_P_ ev_stat *w); 716void ev_stat_stop (EV_P_ ev_stat *w);
647void ev_stat_stat (EV_P_ ev_stat *w); 717void ev_stat_stat (EV_P_ ev_stat *w);
… …
650# if EV_IDLE_ENABLE 720# if EV_IDLE_ENABLE
651void ev_idle_start (EV_P_ ev_idle *w); 721void ev_idle_start (EV_P_ ev_idle *w);
652void ev_idle_stop (EV_P_ ev_idle *w); 722void ev_idle_stop (EV_P_ ev_idle *w);
653# endif 723# endif
654 724
725#if EV_PREPARE_ENABLE
655void ev_prepare_start (EV_P_ ev_prepare *w); 726void ev_prepare_start (EV_P_ ev_prepare *w);
656void ev_prepare_stop (EV_P_ ev_prepare *w); 727void ev_prepare_stop (EV_P_ ev_prepare *w);
728#endif
657 729
730#if EV_CHECK_ENABLE
658void ev_check_start (EV_P_ ev_check *w); 731void ev_check_start (EV_P_ ev_check *w);
659void ev_check_stop (EV_P_ ev_check *w); 732void ev_check_stop (EV_P_ ev_check *w);
733#endif
660 734
661# if EV_FORK_ENABLE 735# if EV_FORK_ENABLE
662void ev_fork_start (EV_P_ ev_fork *w); 736void ev_fork_start (EV_P_ ev_fork *w);
663void ev_fork_stop (EV_P_ ev_fork *w); 737void ev_fork_stop (EV_P_ ev_fork *w);
664# endif 738# endif

Diff Legend

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