ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/README
(Generate patch)

Comparing AnyEvent/README (file contents):
Revision 1.73 by root, Fri Sep 5 22:24:12 2014 UTC vs.
Revision 1.77 by root, Sat Sep 17 02:33:54 2016 UTC

812 $bool = $cv->ready 812 $bool = $cv->ready
813 Returns true when the condition is "true", i.e. whether "send" or 813 Returns true when the condition is "true", i.e. whether "send" or
814 "croak" have been called. 814 "croak" have been called.
815 815
816 $cb = $cv->cb ($cb->($cv)) 816 $cb = $cv->cb ($cb->($cv))
817 This is a mutator function that returns the callback set and 817 This is a mutator function that returns the callback set (or "undef"
818 optionally replaces it before doing so. 818 if not) and optionally replaces it before doing so.
819 819
820 The callback will be called when the condition becomes "true", i.e. 820 The callback will be called when the condition becomes "true", i.e.
821 when "send" or "croak" are called, with the only argument being the 821 when "send" or "croak" are called, with the only argument being the
822 condition variable itself. If the condition is already true, the 822 condition variable itself. If the condition is already true, the
823 callback is called immediately when it is set. Calling "recv" inside 823 callback is called immediately when it is set. Calling "recv" inside
824 the callback or at any later time is guaranteed not to block. 824 the callback or at any later time is guaranteed not to block.
825
826 Additionally, when the callback is invoked, it is also removed from
827 the condvar (reset to "undef"), so the condvar does not keep a
828 reference to the callback after invocation.
825 829
826SUPPORTED EVENT LOOPS/BACKENDS 830SUPPORTED EVENT LOOPS/BACKENDS
827 The available backend classes are (every class has its own manpage): 831 The available backend classes are (every class has its own manpage):
828 832
829 Backends that are autoprobed when no other event loop can be found. 833 Backends that are autoprobed when no other event loop can be found.
1030 If you want to sprinkle loads of logging calls around your code, 1034 If you want to sprinkle loads of logging calls around your code,
1031 consider creating a logger callback with the "AnyEvent::Log::logger" 1035 consider creating a logger callback with the "AnyEvent::Log::logger"
1032 function, which can reduce typing, codesize and can reduce the 1036 function, which can reduce typing, codesize and can reduce the
1033 logging overhead enourmously. 1037 logging overhead enourmously.
1034 1038
1039 AnyEvent::fh_block $filehandle
1040 AnyEvent::fh_unblock $filehandle
1041 Sets blocking or non-blocking behaviour for the given filehandle.
1042
1035WHAT TO DO IN A MODULE 1043WHAT TO DO IN A MODULE
1036 As a module author, you should "use AnyEvent" and call AnyEvent methods 1044 As a module author, you should "use AnyEvent" and call AnyEvent methods
1037 freely, but you should not load a specific event module or rely on it. 1045 freely, but you should not load a specific event module or rely on it.
1038 1046
1039 Be careful when you create watchers in the module body - AnyEvent will 1047 Be careful when you create watchers in the module body - AnyEvent will
1604 my $txn = shift; 1612 my $txn = shift;
1605 my $data = $txn->result; 1613 my $data = $txn->result;
1606 ... 1614 ...
1607 }); 1615 });
1608 1616
1609 EV::loop; 1617 EV::run;
1610 1618
1611 3b. The module user could use AnyEvent, too: 1619 3b. The module user could use AnyEvent, too:
1612 1620
1613 use AnyEvent; 1621 use AnyEvent;
1614 1622
2121 2129
2122 Development/Debugging: AnyEvent::Strict (stricter checking), 2130 Development/Debugging: AnyEvent::Strict (stricter checking),
2123 AnyEvent::Debug (interactive shell, watcher tracing). 2131 AnyEvent::Debug (interactive shell, watcher tracing).
2124 2132
2125 Supported event modules: AnyEvent::Loop, EV, EV::Glib, Glib::EV, Event, 2133 Supported event modules: AnyEvent::Loop, EV, EV::Glib, Glib::EV, Event,
2126 Glib::Event, Glib, Tk, Event::Lib, Qt, POE, FLTK. 2134 Glib::Event, Glib, Tk, Event::Lib, Qt, POE, FLTK, Cocoa::EventLoop, UV.
2127 2135
2128 Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event, 2136 Implementations: AnyEvent::Impl::EV, AnyEvent::Impl::Event,
2129 AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl, 2137 AnyEvent::Impl::Glib, AnyEvent::Impl::Tk, AnyEvent::Impl::Perl,
2130 AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE, 2138 AnyEvent::Impl::EventLib, AnyEvent::Impl::Qt, AnyEvent::Impl::POE,
2131 AnyEvent::Impl::IOAsync, Anyevent::Impl::Irssi, AnyEvent::Impl::FLTK. 2139 AnyEvent::Impl::IOAsync, AnyEvent::Impl::Irssi, AnyEvent::Impl::FLTK,
2140 AnyEvent::Impl::Cocoa, AnyEvent::Impl::UV.
2132 2141
2133 Non-blocking handles, pipes, stream sockets, TCP clients and servers: 2142 Non-blocking handles, pipes, stream sockets, TCP clients and servers:
2134 AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS. 2143 AnyEvent::Handle, AnyEvent::Socket, AnyEvent::TLS.
2135 2144
2136 Asynchronous File I/O: AnyEvent::IO. 2145 Asynchronous File I/O: AnyEvent::IO.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines