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

Comparing libev/ev.h (file contents):
Revision 1.119 by root, Fri Jul 10 00:36:21 2009 UTC vs.
Revision 1.135 by root, Tue Mar 16 00:26:41 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
129typedef double ev_tstamp;
88 130
89#ifndef EV_ATOMIC_T 131#ifndef EV_ATOMIC_T
90# include <signal.h> 132# include <signal.h>
91# define EV_ATOMIC_T sig_atomic_t volatile 133# define EV_ATOMIC_T sig_atomic_t volatile
92#endif 134#endif
93
94/*****************************************************************************/
95 135
96#if EV_STAT_ENABLE 136#if EV_STAT_ENABLE
97# ifdef _WIN32 137# ifdef _WIN32
98# include <time.h> 138# include <time.h>
99# include <sys/types.h> 139# include <sys/types.h>
… …
161#ifndef EV_PROTOTYPES 201#ifndef EV_PROTOTYPES
162# define EV_PROTOTYPES 1 202# define EV_PROTOTYPES 1
163#endif 203#endif
164 204
165#define EV_VERSION_MAJOR 3 205#define EV_VERSION_MAJOR 3
166#define EV_VERSION_MINOR 0 206#define EV_VERSION_MINOR 9
167 207
168#ifndef EV_CB_DECLARE 208#ifndef EV_CB_DECLARE
169# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 209# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
170#endif 210#endif
171#ifndef EV_CB_INVOKE 211#ifndef EV_CB_INVOKE
… …
363 EV_WATCHER (ev_async) 403 EV_WATCHER (ev_async)
364 404
365 EV_ATOMIC_T sent; /* private */ 405 EV_ATOMIC_T sent; /* private */
366} ev_async; 406} ev_async;
367 407
368# define ev_async_pending(w) ((w)->sent + 0) 408# define ev_async_pending(w) (+(w)->sent)
369#endif 409#endif
370 410
371/* the presence of this union forces similar struct layout */ 411/* the presence of this union forces similar struct layout */
372union ev_any_watcher 412union ev_any_watcher
373{ 413{
… …
402/* the default */ 442/* the default */
403#define EVFLAG_AUTO 0x00000000U /* not quite a mask */ 443#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
404/* flag bits */ 444/* flag bits */
405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 445#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
406#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 446#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
447/* debugging/feature disable */
448#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
449#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */
450#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */
407/* method bits to be ored together */ 451/* method bits to be ored together */
408#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 452#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
409#define EVBACKEND_POLL 0x00000002U /* !win */ 453#define EVBACKEND_POLL 0x00000002U /* !win */
410#define EVBACKEND_EPOLL 0x00000004U /* linux */ 454#define EVBACKEND_EPOLL 0x00000004U /* linux */
411#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 455#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
412#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 456#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
413#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 457#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
458#define EVBACKEND_ALL 0x0000003FU
414 459
415#if EV_PROTOTYPES 460#if EV_PROTOTYPES
416int ev_version_major (void); 461int ev_version_major (void);
417int ev_version_minor (void); 462int ev_version_minor (void);
418 463
… …
537 * convenience function, wait for a single event, without registering an event watcher 582 * convenience function, wait for a single event, without registering an event watcher
538 * if timeout is < 0, do wait indefinitely 583 * if timeout is < 0, do wait indefinitely
539 */ 584 */
540void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 585void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
541 586
542# if EV_MINIMAL < 2 587# if EV_FEATURE_API
543unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 588unsigned int ev_loop_count (EV_P); /* number of loop iterations */
544unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 589unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
545void ev_loop_verify (EV_P); /* abort if loop data corrupted */ 590void ev_loop_verify (EV_P); /* abort if loop data corrupted */
546 591
547void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 592void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
548void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 593void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
549 594
550/* 595/* advanced stuff for threading etc. support, see docs */
551 * a single void * can be attached to each loop. this is intended
552 * to aid the invoke_pending/blocking callbacks.
553 */
554void ev_set_userdata (EV_P_ void *data); 596void ev_set_userdata (EV_P_ void *data);
555void *ev_userdata (EV_P); 597void *ev_userdata (EV_P);
556
557/*
558 * hooks to overide how and when libev invokes callbacks,
559 * and hooks that wrap the actual eventloop blocking call.
560 */
561void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); 598void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
562void ev_set_blocking_cb (EV_P_ void (*suspend_cb_)(EV_P), void (*resume_cb_)(EV_P)); 599void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
563 600
601unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
564void ev_invoke_pending (EV_P); /* invoke all pending watchers */ 602void ev_invoke_pending (EV_P); /* invoke all pending watchers */
565 603
566/* 604/*
567 * stop/start the timer handling. 605 * stop/start the timer handling.
568 */ 606 */
… …
614 652
615#if EV_MINPRI == EV_MAXPRI 653#if EV_MINPRI == EV_MAXPRI
616# define ev_priority(ev) ((ev), EV_MINPRI) 654# define ev_priority(ev) ((ev), EV_MINPRI)
617# define ev_set_priority(ev,pri) ((ev), (pri)) 655# define ev_set_priority(ev,pri) ((ev), (pri))
618#else 656#else
619# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 657# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
620# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri) 658# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
621#endif 659#endif
622 660
623#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 661#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
624 662
625#ifndef ev_set_cb 663#ifndef ev_set_cb
626# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 664# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
627#endif 665#endif
628 666
… …
632 670
633/* feeds an event into a watcher as if the event actually occured */ 671/* feeds an event into a watcher as if the event actually occured */
634/* accepts any ev_watcher type */ 672/* accepts any ev_watcher type */
635void ev_feed_event (EV_P_ void *w, int revents); 673void ev_feed_event (EV_P_ void *w, int revents);
636void ev_feed_fd_event (EV_P_ int fd, int revents); 674void ev_feed_fd_event (EV_P_ int fd, int revents);
675#if EV_SIGNAL_ENABLE
637void ev_feed_signal_event (EV_P_ int signum); 676void ev_feed_signal_event (EV_P_ int signum);
677#endif
638void ev_invoke (EV_P_ void *w, int revents); 678void ev_invoke (EV_P_ void *w, int revents);
639int ev_clear_pending (EV_P_ void *w); 679int ev_clear_pending (EV_P_ void *w);
640 680
641void ev_io_start (EV_P_ ev_io *w); 681void ev_io_start (EV_P_ ev_io *w);
642void ev_io_stop (EV_P_ ev_io *w); 682void ev_io_stop (EV_P_ ev_io *w);
643 683
644void ev_timer_start (EV_P_ ev_timer *w); 684void ev_timer_start (EV_P_ ev_timer *w);
645void ev_timer_stop (EV_P_ ev_timer *w); 685void ev_timer_stop (EV_P_ ev_timer *w);
646/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 686/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
647void ev_timer_again (EV_P_ ev_timer *w); 687void ev_timer_again (EV_P_ ev_timer *w);
688/* return remaining time */
689ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
648 690
649#if EV_PERIODIC_ENABLE 691#if EV_PERIODIC_ENABLE
650void ev_periodic_start (EV_P_ ev_periodic *w); 692void ev_periodic_start (EV_P_ ev_periodic *w);
651void ev_periodic_stop (EV_P_ ev_periodic *w); 693void ev_periodic_stop (EV_P_ ev_periodic *w);
652void ev_periodic_again (EV_P_ ev_periodic *w); 694void ev_periodic_again (EV_P_ ev_periodic *w);
653#endif 695#endif
654 696
655/* only supported in the default loop */ 697/* only supported in the default loop */
698#if EV_SIGNAL_ENABLE
656void ev_signal_start (EV_P_ ev_signal *w); 699void ev_signal_start (EV_P_ ev_signal *w);
657void ev_signal_stop (EV_P_ ev_signal *w); 700void ev_signal_stop (EV_P_ ev_signal *w);
701#endif
658 702
659/* only supported in the default loop */ 703/* only supported in the default loop */
704# if EV_CHILD_ENABLE
660void ev_child_start (EV_P_ ev_child *w); 705void ev_child_start (EV_P_ ev_child *w);
661void ev_child_stop (EV_P_ ev_child *w); 706void ev_child_stop (EV_P_ ev_child *w);
707# endif
662 708
663# if EV_STAT_ENABLE 709# if EV_STAT_ENABLE
664void ev_stat_start (EV_P_ ev_stat *w); 710void ev_stat_start (EV_P_ ev_stat *w);
665void ev_stat_stop (EV_P_ ev_stat *w); 711void ev_stat_stop (EV_P_ ev_stat *w);
666void ev_stat_stat (EV_P_ ev_stat *w); 712void ev_stat_stat (EV_P_ ev_stat *w);
… …
669# if EV_IDLE_ENABLE 715# if EV_IDLE_ENABLE
670void ev_idle_start (EV_P_ ev_idle *w); 716void ev_idle_start (EV_P_ ev_idle *w);
671void ev_idle_stop (EV_P_ ev_idle *w); 717void ev_idle_stop (EV_P_ ev_idle *w);
672# endif 718# endif
673 719
720#if EV_PREPARE_ENABLE
674void ev_prepare_start (EV_P_ ev_prepare *w); 721void ev_prepare_start (EV_P_ ev_prepare *w);
675void ev_prepare_stop (EV_P_ ev_prepare *w); 722void ev_prepare_stop (EV_P_ ev_prepare *w);
723#endif
676 724
725#if EV_CHECK_ENABLE
677void ev_check_start (EV_P_ ev_check *w); 726void ev_check_start (EV_P_ ev_check *w);
678void ev_check_stop (EV_P_ ev_check *w); 727void ev_check_stop (EV_P_ ev_check *w);
728#endif
679 729
680# if EV_FORK_ENABLE 730# if EV_FORK_ENABLE
681void ev_fork_start (EV_P_ ev_fork *w); 731void ev_fork_start (EV_P_ ev_fork *w);
682void ev_fork_stop (EV_P_ ev_fork *w); 732void ev_fork_stop (EV_P_ ev_fork *w);
683# endif 733# endif

Diff Legend

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