… | |
… | |
736 | =item bool ev_is_pending (ev_TYPE *watcher) |
736 | =item bool ev_is_pending (ev_TYPE *watcher) |
737 | |
737 | |
738 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
738 | Returns a true value iff the watcher is pending, (i.e. it has outstanding |
739 | events but its callback has not yet been invoked). As long as a watcher |
739 | events but its callback has not yet been invoked). As long as a watcher |
740 | is pending (but not active) you must not call an init function on it (but |
740 | is pending (but not active) you must not call an init function on it (but |
741 | C<ev_TYPE_set> is safe) and you must make sure the watcher is available to |
741 | C<ev_TYPE_set> is safe), you must not change its priority, and you must |
742 | libev (e.g. you cnanot C<free ()> it). |
742 | make sure the watcher is available to libev (e.g. you cannot C<free ()> |
|
|
743 | it). |
743 | |
744 | |
744 | =item callback ev_cb (ev_TYPE *watcher) |
745 | =item callback ev_cb (ev_TYPE *watcher) |
745 | |
746 | |
746 | Returns the callback currently set on the watcher. |
747 | Returns the callback currently set on the watcher. |
747 | |
748 | |
… | |
… | |
766 | watchers on the same event and make sure one is called first. |
767 | watchers on the same event and make sure one is called first. |
767 | |
768 | |
768 | If you need to suppress invocation when higher priority events are pending |
769 | If you need to suppress invocation when higher priority events are pending |
769 | you need to look at C<ev_idle> watchers, which provide this functionality. |
770 | you need to look at C<ev_idle> watchers, which provide this functionality. |
770 | |
771 | |
|
|
772 | You I<must not> change the priority of a watcher as long as it is active or |
|
|
773 | pending. |
|
|
774 | |
771 | The default priority used by watchers when no priority has been set is |
775 | The default priority used by watchers when no priority has been set is |
772 | always C<0>, which is supposed to not be too high and not be too low :). |
776 | always C<0>, which is supposed to not be too high and not be too low :). |
773 | |
777 | |
774 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
778 | Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is |
775 | fine, as long as you do not mind that the priority value you query might |
779 | fine, as long as you do not mind that the priority value you query might |
776 | or might not have been adjusted to be within valid range. |
780 | or might not have been adjusted to be within valid range. |
|
|
781 | |
|
|
782 | =item ev_invoke (loop, ev_TYPE *watcher, int revents) |
|
|
783 | |
|
|
784 | Invoke the C<watcher> with the given C<loop> and C<revents>. Neither |
|
|
785 | C<loop> nor C<revents> need to be valid as long as the watcher callback |
|
|
786 | can deal with that fact. |
|
|
787 | |
|
|
788 | =item int ev_clear_pending (loop, ev_TYPE *watcher) |
|
|
789 | |
|
|
790 | If the watcher is pending, this function returns clears its pending status |
|
|
791 | and returns its C<revents> bitset (as if its callback was invoked). If the |
|
|
792 | watcher isn't pending it does nothing and returns C<0>. |
777 | |
793 | |
778 | =back |
794 | =back |
779 | |
795 | |
780 | |
796 | |
781 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
797 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |