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

Comparing libev/ev.h (file contents):
Revision 1.160 by root, Wed Feb 16 08:07:25 2011 UTC vs.
Revision 1.164 by root, Sat Feb 4 18:55:50 2012 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009,2010,2011 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010,2011,2012 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 *
… …
183# define EV_INLINE static inline 183# define EV_INLINE static inline
184#else 184#else
185# define EV_INLINE static 185# define EV_INLINE static
186#endif 186#endif
187 187
188#ifdef EV_API_STATIC
189# define EV_API_DECL static
190#else
191# define EV_API_DECL extern
192#endif
193
188/* EV_PROTOTYPES can be used to switch of prototype declarations */ 194/* EV_PROTOTYPES can be used to switch of prototype declarations */
189#ifndef EV_PROTOTYPES 195#ifndef EV_PROTOTYPES
190# define EV_PROTOTYPES 1 196# define EV_PROTOTYPES 1
191#endif 197#endif
192 198
193/*****************************************************************************/ 199/*****************************************************************************/
194 200
195#define EV_VERSION_MAJOR 4 201#define EV_VERSION_MAJOR 4
196#define EV_VERSION_MINOR 4 202#define EV_VERSION_MINOR 11
197 203
198/* eventmask, revents, events... */ 204/* eventmask, revents, events... */
199enum { 205enum {
200 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */ 206 EV_UNDEF = 0xFFFFFFFF, /* guaranteed to be invalid */
201 EV_NONE = 0x00, /* no events */ 207 EV_NONE = 0x00, /* no events */
… …
506 EVBACKEND_ALL = 0x0000003FU, /* all known backends */ 512 EVBACKEND_ALL = 0x0000003FU, /* all known backends */
507 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */ 513 EVBACKEND_MASK = 0x0000FFFFU /* all future backends */
508}; 514};
509 515
510#if EV_PROTOTYPES 516#if EV_PROTOTYPES
511int ev_version_major (void); 517EV_API_DECL int ev_version_major (void);
512int ev_version_minor (void); 518EV_API_DECL int ev_version_minor (void);
513 519
514unsigned int ev_supported_backends (void); 520EV_API_DECL unsigned int ev_supported_backends (void);
515unsigned int ev_recommended_backends (void); 521EV_API_DECL unsigned int ev_recommended_backends (void);
516unsigned int ev_embeddable_backends (void); 522EV_API_DECL unsigned int ev_embeddable_backends (void);
517 523
518ev_tstamp ev_time (void); 524EV_API_DECL ev_tstamp ev_time (void);
519void ev_sleep (ev_tstamp delay); /* sleep for a while */ 525EV_API_DECL void ev_sleep (ev_tstamp delay); /* sleep for a while */
520 526
521/* Sets the allocation function to use, works like realloc. 527/* Sets the allocation function to use, works like realloc.
522 * It is used to allocate and free memory. 528 * It is used to allocate and free memory.
523 * If it returns zero when memory needs to be allocated, the library might abort 529 * If it returns zero when memory needs to be allocated, the library might abort
524 * or take some potentially destructive action. 530 * or take some potentially destructive action.
525 * The default is your system realloc function. 531 * The default is your system realloc function.
526 */ 532 */
527void ev_set_allocator (void *(*cb)(void *ptr, long size)); 533EV_API_DECL void ev_set_allocator (void *(*cb)(void *ptr, long size));
528 534
529/* set the callback function to call on a 535/* set the callback function to call on a
530 * retryable syscall error 536 * retryable syscall error
531 * (such as failed select, poll, epoll_wait) 537 * (such as failed select, poll, epoll_wait)
532 */ 538 */
533void ev_set_syserr_cb (void (*cb)(const char *msg)); 539EV_API_DECL void ev_set_syserr_cb (void (*cb)(const char *msg));
534 540
535#if EV_MULTIPLICITY 541#if EV_MULTIPLICITY
536 542
537/* the default loop is the only one that handles signals and child watchers */ 543/* the default loop is the only one that handles signals and child watchers */
538/* you can call this as often as you like */ 544/* you can call this as often as you like */
539struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0)); 545EV_API_DECL struct ev_loop *ev_default_loop (unsigned int flags EV_CPP (= 0));
546
547#ifdef EV_API_STATIC
548EV_API_DECL struct ev_loop *ev_default_loop_ptr;
549#endif
540 550
541EV_INLINE struct ev_loop * 551EV_INLINE struct ev_loop *
542ev_default_loop_uc_ (void) 552ev_default_loop_uc_ (void)
543{ 553{
544 extern struct ev_loop *ev_default_loop_ptr; 554 extern struct ev_loop *ev_default_loop_ptr;
… …
551{ 561{
552 return EV_A == EV_DEFAULT_UC; 562 return EV_A == EV_DEFAULT_UC;
553} 563}
554 564
555/* create and destroy alternative loops that don't handle signals */ 565/* create and destroy alternative loops that don't handle signals */
556struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0)); 566EV_API_DECL struct ev_loop *ev_loop_new (unsigned int flags EV_CPP (= 0));
557 567
558ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */ 568EV_API_DECL ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
559 569
560#else 570#else
561 571
562int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */ 572EV_API_DECL int ev_default_loop (unsigned int flags EV_CPP (= 0)); /* returns true when successful */
573
574EV_API_DECL ev_tstamp ev_rt_now;
563 575
564EV_INLINE ev_tstamp 576EV_INLINE ev_tstamp
565ev_now (void) 577ev_now (void)
566{ 578{
567 extern ev_tstamp ev_rt_now;
568
569 return ev_rt_now; 579 return ev_rt_now;
570} 580}
571 581
572/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */ 582/* looks weird, but ev_is_default_loop (EV_A) still works if this exists */
573EV_INLINE int 583EV_INLINE int
… …
577} 587}
578 588
579#endif /* multiplicity */ 589#endif /* multiplicity */
580 590
581/* destroy event loops, also works for the default loop */ 591/* destroy event loops, also works for the default loop */
582void ev_loop_destroy (EV_P); 592EV_API_DECL void ev_loop_destroy (EV_P);
583 593
584/* this needs to be called after fork, to duplicate the loop */ 594/* this needs to be called after fork, to duplicate the loop */
585/* when you want to re-use it in the child */ 595/* when you want to re-use it in the child */
586/* you can call it in either the parent or the child */ 596/* you can call it in either the parent or the child */
587/* you can actually call it at any time, anywhere :) */ 597/* you can actually call it at any time, anywhere :) */
588void ev_loop_fork (EV_P); 598EV_API_DECL void ev_loop_fork (EV_P);
589 599
590unsigned int ev_backend (EV_P); /* backend in use by loop */ 600EV_API_DECL unsigned int ev_backend (EV_P); /* backend in use by loop */
591 601
592void ev_now_update (EV_P); /* update event loop time */ 602EV_API_DECL void ev_now_update (EV_P); /* update event loop time */
593 603
594#if EV_WALK_ENABLE 604#if EV_WALK_ENABLE
595/* walk (almost) all watchers in the loop of a given type, invoking the */ 605/* walk (almost) all watchers in the loop of a given type, invoking the */
596/* callback on every such watcher. The callback might stop the watcher, */ 606/* callback on every such watcher. The callback might stop the watcher, */
597/* but do nothing else with the loop */ 607/* but do nothing else with the loop */
598void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w)); 608EV_API_DECL void ev_walk (EV_P_ int types, void (*cb)(EV_P_ int type, void *w));
599#endif 609#endif
600 610
601#endif /* prototypes */ 611#endif /* prototypes */
602 612
603/* ev_run flags values */ 613/* ev_run flags values */
… …
612 EVBREAK_ONE = 1, /* unloop once */ 622 EVBREAK_ONE = 1, /* unloop once */
613 EVBREAK_ALL = 2 /* unloop all loops */ 623 EVBREAK_ALL = 2 /* unloop all loops */
614}; 624};
615 625
616#if EV_PROTOTYPES 626#if EV_PROTOTYPES
617void ev_run (EV_P_ int flags EV_CPP (= 0)); 627EV_API_DECL void ev_run (EV_P_ int flags EV_CPP (= 0));
618void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */ 628EV_API_DECL void ev_break (EV_P_ int how EV_CPP (= EVBREAK_ONE)); /* break out of the loop */
619 629
620/* 630/*
621 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 631 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
622 * keeps one reference. if you have a long-running watcher you never unregister that 632 * keeps one reference. if you have a long-running watcher you never unregister that
623 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 633 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
624 */ 634 */
625void ev_ref (EV_P); 635EV_API_DECL void ev_ref (EV_P);
626void ev_unref (EV_P); 636EV_API_DECL void ev_unref (EV_P);
627 637
628/* 638/*
629 * convenience function, wait for a single event, without registering an event watcher 639 * convenience function, wait for a single event, without registering an event watcher
630 * if timeout is < 0, do wait indefinitely 640 * if timeout is < 0, do wait indefinitely
631 */ 641 */
632void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 642EV_API_DECL void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
633 643
634# if EV_FEATURE_API 644# if EV_FEATURE_API
635unsigned int ev_iteration (EV_P); /* number of loop iterations */ 645EV_API_DECL unsigned int ev_iteration (EV_P); /* number of loop iterations */
636unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 646EV_API_DECL unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
637void ev_verify (EV_P); /* abort if loop data corrupted */ 647EV_API_DECL void ev_verify (EV_P); /* abort if loop data corrupted */
638 648
639void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 649EV_API_DECL void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
640void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 650EV_API_DECL void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
641 651
642/* advanced stuff for threading etc. support, see docs */ 652/* advanced stuff for threading etc. support, see docs */
643void ev_set_userdata (EV_P_ void *data); 653EV_API_DECL void ev_set_userdata (EV_P_ void *data);
644void *ev_userdata (EV_P); 654EV_API_DECL void *ev_userdata (EV_P);
645void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P)); 655EV_API_DECL void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
646void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P)); 656EV_API_DECL void ev_set_loop_release_cb (EV_P_ void (*release)(EV_P), void (*acquire)(EV_P));
647 657
648unsigned int ev_pending_count (EV_P); /* number of pending events, if any */ 658EV_API_DECL unsigned int ev_pending_count (EV_P); /* number of pending events, if any */
649void ev_invoke_pending (EV_P); /* invoke all pending watchers */ 659EV_API_DECL void ev_invoke_pending (EV_P); /* invoke all pending watchers */
650 660
651/* 661/*
652 * stop/start the timer handling. 662 * stop/start the timer handling.
653 */ 663 */
654void ev_suspend (EV_P); 664EV_API_DECL void ev_suspend (EV_P);
655void ev_resume (EV_P); 665EV_API_DECL void ev_resume (EV_P);
656#endif 666#endif
657 667
658#endif 668#endif
659 669
660/* these may evaluate ev multiple times, and the other arguments at most once */ 670/* these may evaluate ev multiple times, and the other arguments at most once */
… …
715 725
716/* stopping (enabling, adding) a watcher does nothing if it is already running */ 726/* stopping (enabling, adding) a watcher does nothing if it is already running */
717/* stopping (disabling, deleting) a watcher does nothing unless its already running */ 727/* stopping (disabling, deleting) a watcher does nothing unless its already running */
718#if EV_PROTOTYPES 728#if EV_PROTOTYPES
719 729
720/* feeds an event into a watcher as if the event actually occured */ 730/* feeds an event into a watcher as if the event actually occurred */
721/* accepts any ev_watcher type */ 731/* accepts any ev_watcher type */
722void ev_feed_event (EV_P_ void *w, int revents); 732EV_API_DECL void ev_feed_event (EV_P_ void *w, int revents);
723void ev_feed_fd_event (EV_P_ int fd, int revents); 733EV_API_DECL void ev_feed_fd_event (EV_P_ int fd, int revents);
724#if EV_SIGNAL_ENABLE 734#if EV_SIGNAL_ENABLE
725void ev_feed_signal (int signum); 735EV_API_DECL void ev_feed_signal (int signum);
726void ev_feed_signal_event (EV_P_ int signum); 736EV_API_DECL void ev_feed_signal_event (EV_P_ int signum);
727#endif 737#endif
728void ev_invoke (EV_P_ void *w, int revents); 738EV_API_DECL void ev_invoke (EV_P_ void *w, int revents);
729int ev_clear_pending (EV_P_ void *w); 739EV_API_DECL int ev_clear_pending (EV_P_ void *w);
730 740
731void ev_io_start (EV_P_ ev_io *w); 741EV_API_DECL void ev_io_start (EV_P_ ev_io *w);
732void ev_io_stop (EV_P_ ev_io *w); 742EV_API_DECL void ev_io_stop (EV_P_ ev_io *w);
733 743
734void ev_timer_start (EV_P_ ev_timer *w); 744EV_API_DECL void ev_timer_start (EV_P_ ev_timer *w);
735void ev_timer_stop (EV_P_ ev_timer *w); 745EV_API_DECL void ev_timer_stop (EV_P_ ev_timer *w);
736/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */ 746/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
737void ev_timer_again (EV_P_ ev_timer *w); 747EV_API_DECL void ev_timer_again (EV_P_ ev_timer *w);
738/* return remaining time */ 748/* return remaining time */
739ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w); 749EV_API_DECL ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
740 750
741#if EV_PERIODIC_ENABLE 751#if EV_PERIODIC_ENABLE
742void ev_periodic_start (EV_P_ ev_periodic *w); 752EV_API_DECL void ev_periodic_start (EV_P_ ev_periodic *w);
743void ev_periodic_stop (EV_P_ ev_periodic *w); 753EV_API_DECL void ev_periodic_stop (EV_P_ ev_periodic *w);
744void ev_periodic_again (EV_P_ ev_periodic *w); 754EV_API_DECL void ev_periodic_again (EV_P_ ev_periodic *w);
745#endif 755#endif
746 756
747/* only supported in the default loop */ 757/* only supported in the default loop */
748#if EV_SIGNAL_ENABLE 758#if EV_SIGNAL_ENABLE
749void ev_signal_start (EV_P_ ev_signal *w); 759EV_API_DECL void ev_signal_start (EV_P_ ev_signal *w);
750void ev_signal_stop (EV_P_ ev_signal *w); 760EV_API_DECL void ev_signal_stop (EV_P_ ev_signal *w);
751#endif 761#endif
752 762
753/* only supported in the default loop */ 763/* only supported in the default loop */
754# if EV_CHILD_ENABLE 764# if EV_CHILD_ENABLE
755void ev_child_start (EV_P_ ev_child *w); 765EV_API_DECL void ev_child_start (EV_P_ ev_child *w);
756void ev_child_stop (EV_P_ ev_child *w); 766EV_API_DECL void ev_child_stop (EV_P_ ev_child *w);
757# endif 767# endif
758 768
759# if EV_STAT_ENABLE 769# if EV_STAT_ENABLE
760void ev_stat_start (EV_P_ ev_stat *w); 770EV_API_DECL void ev_stat_start (EV_P_ ev_stat *w);
761void ev_stat_stop (EV_P_ ev_stat *w); 771EV_API_DECL void ev_stat_stop (EV_P_ ev_stat *w);
762void ev_stat_stat (EV_P_ ev_stat *w); 772EV_API_DECL void ev_stat_stat (EV_P_ ev_stat *w);
763# endif 773# endif
764 774
765# if EV_IDLE_ENABLE 775# if EV_IDLE_ENABLE
766void ev_idle_start (EV_P_ ev_idle *w); 776EV_API_DECL void ev_idle_start (EV_P_ ev_idle *w);
767void ev_idle_stop (EV_P_ ev_idle *w); 777EV_API_DECL void ev_idle_stop (EV_P_ ev_idle *w);
768# endif 778# endif
769 779
770#if EV_PREPARE_ENABLE 780#if EV_PREPARE_ENABLE
771void ev_prepare_start (EV_P_ ev_prepare *w); 781EV_API_DECL void ev_prepare_start (EV_P_ ev_prepare *w);
772void ev_prepare_stop (EV_P_ ev_prepare *w); 782EV_API_DECL void ev_prepare_stop (EV_P_ ev_prepare *w);
773#endif 783#endif
774 784
775#if EV_CHECK_ENABLE 785#if EV_CHECK_ENABLE
776void ev_check_start (EV_P_ ev_check *w); 786EV_API_DECL void ev_check_start (EV_P_ ev_check *w);
777void ev_check_stop (EV_P_ ev_check *w); 787EV_API_DECL void ev_check_stop (EV_P_ ev_check *w);
778#endif 788#endif
779 789
780# if EV_FORK_ENABLE 790# if EV_FORK_ENABLE
781void ev_fork_start (EV_P_ ev_fork *w); 791EV_API_DECL void ev_fork_start (EV_P_ ev_fork *w);
782void ev_fork_stop (EV_P_ ev_fork *w); 792EV_API_DECL void ev_fork_stop (EV_P_ ev_fork *w);
783# endif 793# endif
784 794
785# if EV_CLEANUP_ENABLE 795# if EV_CLEANUP_ENABLE
786void ev_cleanup_start (EV_P_ ev_cleanup *w); 796EV_API_DECL void ev_cleanup_start (EV_P_ ev_cleanup *w);
787void ev_cleanup_stop (EV_P_ ev_cleanup *w); 797EV_API_DECL void ev_cleanup_stop (EV_P_ ev_cleanup *w);
788# endif 798# endif
789 799
790# if EV_EMBED_ENABLE 800# if EV_EMBED_ENABLE
791/* only supported when loop to be embedded is in fact embeddable */ 801/* only supported when loop to be embedded is in fact embeddable */
792void ev_embed_start (EV_P_ ev_embed *w); 802EV_API_DECL void ev_embed_start (EV_P_ ev_embed *w);
793void ev_embed_stop (EV_P_ ev_embed *w); 803EV_API_DECL void ev_embed_stop (EV_P_ ev_embed *w);
794void ev_embed_sweep (EV_P_ ev_embed *w); 804EV_API_DECL void ev_embed_sweep (EV_P_ ev_embed *w);
795# endif 805# endif
796 806
797# if EV_ASYNC_ENABLE 807# if EV_ASYNC_ENABLE
798void ev_async_start (EV_P_ ev_async *w); 808EV_API_DECL void ev_async_start (EV_P_ ev_async *w);
799void ev_async_stop (EV_P_ ev_async *w); 809EV_API_DECL void ev_async_stop (EV_P_ ev_async *w);
800void ev_async_send (EV_P_ ev_async *w); 810EV_API_DECL void ev_async_send (EV_P_ ev_async *w);
801# endif 811# endif
802 812
803#if EV_COMPAT3 813#if EV_COMPAT3
804 #define EVLOOP_NONBLOCK EVRUN_NOWAIT 814 #define EVLOOP_NONBLOCK EVRUN_NOWAIT
805 #define EVLOOP_ONESHOT EVRUN_ONCE 815 #define EVLOOP_ONESHOT EVRUN_ONCE

Diff Legend

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