… | |
… | |
1005 | if $some_error_condition; |
1005 | if $some_error_condition; |
1006 | |
1006 | |
1007 | AnyEvent::log $level, $msg[, @args] |
1007 | AnyEvent::log $level, $msg[, @args] |
1008 | Log the given $msg at the given $level. |
1008 | Log the given $msg at the given $level. |
1009 | |
1009 | |
|
|
1010 | If AnyEvent::Log is not loaded then this function makes a simple |
|
|
1011 | test to see whether the message will be logged. If the test succeeds |
1010 | Loads AnyEvent::Log on first use and calls "AnyEvent::Log::log" - |
1012 | it will load AnyEvent::Log and call "AnyEvent::Log::log" - |
1011 | consequently, look at the AnyEvent::Log documentation for details. |
1013 | consequently, look at the AnyEvent::Log documentation for details. |
|
|
1014 | |
|
|
1015 | If the test fails it will simply return. |
1012 | |
1016 | |
1013 | If you want to sprinkle loads of logging calls around your code, |
1017 | If you want to sprinkle loads of logging calls around your code, |
1014 | consider creating a logger callback with the "AnyEvent::Log::logger" |
1018 | consider creating a logger callback with the "AnyEvent::Log::logger" |
1015 | function. |
1019 | function, which can reduce typing, codesize and can reduce the |
|
|
1020 | logging overhead enourmously. |
1016 | |
1021 | |
1017 | WHAT TO DO IN A MODULE |
1022 | WHAT TO DO IN A MODULE |
1018 | As a module author, you should "use AnyEvent" and call AnyEvent methods |
1023 | As a module author, you should "use AnyEvent" and call AnyEvent methods |
1019 | freely, but you should not load a specific event module or rely on it. |
1024 | freely, but you should not load a specific event module or rely on it. |
1020 | |
1025 | |
… | |
… | |
1103 | AnyEvent::IGS, AnyEvent::FCP |
1108 | AnyEvent::IGS, AnyEvent::FCP |
1104 | Implement event-based interfaces to the protocols of the same name |
1109 | Implement event-based interfaces to the protocols of the same name |
1105 | (for the curious, IGS is the International Go Server and FCP is the |
1110 | (for the curious, IGS is the International Go Server and FCP is the |
1106 | Freenet Client Protocol). |
1111 | Freenet Client Protocol). |
1107 | |
1112 | |
1108 | AnyEvent::Handle::UDP |
|
|
1109 | Here be danger! |
|
|
1110 | |
|
|
1111 | As Pauli would put it, "Not only is it not right, it's not even |
|
|
1112 | wrong!" - there are so many things wrong with AnyEvent::Handle::UDP, |
|
|
1113 | most notably its use of a stream-based API with a protocol that |
|
|
1114 | isn't streamable, that the only way to improve it is to delete it. |
|
|
1115 | |
|
|
1116 | It features data corruption (but typically only under load) and |
|
|
1117 | general confusion. On top, the author is not only clueless about UDP |
|
|
1118 | but also fact-resistant - some gems of his understanding: "connect |
|
|
1119 | doesn't work with UDP", "UDP packets are not IP packets", "UDP only |
|
|
1120 | has datagrams, not packets", "I don't need to implement proper error |
|
|
1121 | checking as UDP doesn't support error checking" and so on - he |
|
|
1122 | doesn't even understand what's wrong with his module when it is |
|
|
1123 | explained to him. |
|
|
1124 | |
|
|
1125 | AnyEvent::DBI |
|
|
1126 | Executes DBI requests asynchronously in a proxy process for you, |
|
|
1127 | notifying you in an event-based way when the operation is finished. |
|
|
1128 | |
|
|
1129 | AnyEvent::AIO |
1113 | AnyEvent::AIO |
1130 | Truly asynchronous (as opposed to non-blocking) I/O, should be in |
1114 | Truly asynchronous (as opposed to non-blocking) I/O, should be in |
1131 | the toolbox of every event programmer. AnyEvent::AIO transparently |
1115 | the toolbox of every event programmer. AnyEvent::AIO transparently |
1132 | fuses IO::AIO and AnyEvent together, giving AnyEvent access to |
1116 | fuses IO::AIO and AnyEvent together, giving AnyEvent access to |
1133 | event-based file I/O, and much more. |
1117 | event-based file I/O, and much more. |
1134 | |
1118 | |
|
|
1119 | AnyEvent::Filesys::Notify |
|
|
1120 | AnyEvent is good for non-blocking stuff, but it can't detect file or |
|
|
1121 | path changes (e.g. "watch this directory for new files", "watch this |
|
|
1122 | file for changes"). The AnyEvent::Filesys::Notify module promises to |
|
|
1123 | do just that in a portbale fashion, supporting inotify on GNU/Linux |
|
|
1124 | and some weird, without doubt broken, stuff on OS X to monitor |
|
|
1125 | files. It can fall back to blocking scans at regular intervals |
|
|
1126 | transparently on other platforms, so it's about as portable as it |
|
|
1127 | gets. |
|
|
1128 | |
|
|
1129 | (I haven't used it myself, but I haven't heard anybody complaining |
|
|
1130 | about it yet). |
|
|
1131 | |
|
|
1132 | AnyEvent::DBI |
|
|
1133 | Executes DBI requests asynchronously in a proxy process for you, |
|
|
1134 | notifying you in an event-based way when the operation is finished. |
|
|
1135 | |
1135 | AnyEvent::HTTPD |
1136 | AnyEvent::HTTPD |
1136 | A simple embedded webserver. |
1137 | A simple embedded webserver. |
1137 | |
1138 | |
1138 | AnyEvent::FastPing |
1139 | AnyEvent::FastPing |
1139 | The fastest ping in the west. |
1140 | The fastest ping in the west. |
1140 | |
1141 | |
1141 | Coro |
1142 | Coro |
1142 | Has special support for AnyEvent via Coro::AnyEvent. |
1143 | Has special support for AnyEvent via Coro::AnyEvent, which allows |
|
|
1144 | you to simply invert the flow control - don't call us, we will call |
|
|
1145 | you: |
|
|
1146 | |
|
|
1147 | async { |
|
|
1148 | Coro::AnyEvent::sleep 5; # creates a 5s timer and waits for it |
|
|
1149 | print "5 seconds later!\n"; |
|
|
1150 | |
|
|
1151 | Coro::AnyEvent::readable *STDIN; # uses an I/O watcher |
|
|
1152 | my $line = <STDIN>; # works for ttys |
|
|
1153 | |
|
|
1154 | AnyEvent::HTTP::http_get "url", Coro::rouse_cb; |
|
|
1155 | my ($body, $hdr) = Coro::rouse_wait; |
|
|
1156 | }; |
1143 | |
1157 | |
1144 | SIMPLIFIED AE API |
1158 | SIMPLIFIED AE API |
1145 | Starting with version 5.0, AnyEvent officially supports a second, much |
1159 | Starting with version 5.0, AnyEvent officially supports a second, much |
1146 | simpler, API that is designed to reduce the calling, typing and memory |
1160 | simpler, API that is designed to reduce the calling, typing and memory |
1147 | overhead by using function call syntax and a fixed number of parameters. |
1161 | overhead by using function call syntax and a fixed number of parameters. |
… | |
… | |
1163 | The pure perl event loop simply re-throws the exception (usually within |
1177 | The pure perl event loop simply re-throws the exception (usually within |
1164 | "condvar->recv"), the Event and EV modules call "$Event/EV::DIED->()", |
1178 | "condvar->recv"), the Event and EV modules call "$Event/EV::DIED->()", |
1165 | Glib uses "install_exception_handler" and so on. |
1179 | Glib uses "install_exception_handler" and so on. |
1166 | |
1180 | |
1167 | ENVIRONMENT VARIABLES |
1181 | ENVIRONMENT VARIABLES |
1168 | The following environment variables are used by this module or its |
1182 | AnyEvent supports a number of environment variables that tune the |
1169 | submodules. |
1183 | runtime behaviour. They are usually evaluated when AnyEvent is loaded, |
|
|
1184 | initialised, or a submodule that uses them is loaded. Many of them also |
|
|
1185 | cause AnyEvent to load additional modules - for example, |
|
|
1186 | "PERL_ANYEVENT_DEBUG_WRAP" causes the AnyEvent::Debug module to be |
|
|
1187 | loaded. |
1170 | |
1188 | |
1171 | Note that AnyEvent will remove *all* environment variables starting with |
1189 | All the environment variables documented here start with |
1172 | "PERL_ANYEVENT_" from %ENV when it is loaded while taint mode is |
1190 | "PERL_ANYEVENT_", which is what AnyEvent considers its own namespace. |
1173 | enabled. |
1191 | Other modules are encouraged (but by no means required) to use |
|
|
1192 | "PERL_ANYEVENT_SUBMODULE" if they have registered the |
|
|
1193 | AnyEvent::Submodule namespace on CPAN, for any submodule. For example, |
|
|
1194 | AnyEvent::HTTP could be expected to use "PERL_ANYEVENT_HTTP_PROXY" (it |
|
|
1195 | should not access env variables starting with "AE_", see below). |
|
|
1196 | |
|
|
1197 | All variables can also be set via the "AE_" prefix, that is, instead of |
|
|
1198 | setting "PERL_ANYEVENT_VERBOSE" you can also set "AE_VERBOSE". In case |
|
|
1199 | there is a clash btween anyevent and another program that uses |
|
|
1200 | "AE_something" you can set the corresponding "PERL_ANYEVENT_something" |
|
|
1201 | variable to the empty string, as those variables take precedence. |
|
|
1202 | |
|
|
1203 | When AnyEvent is first loaded, it copies all "AE_xxx" env variables to |
|
|
1204 | their "PERL_ANYEVENT_xxx" counterpart unless that variable already |
|
|
1205 | exists. If taint mode is on, then AnyEvent will remove *all* environment |
|
|
1206 | variables starting with "PERL_ANYEVENT_" from %ENV (or replace them with |
|
|
1207 | "undef" or the empty string, if the corresaponding "AE_" variable is |
|
|
1208 | set). |
|
|
1209 | |
|
|
1210 | The exact algorithm is currently: |
|
|
1211 | |
|
|
1212 | 1. if taint mode enabled, delete all PERL_ANYEVENT_xyz variables from %ENV |
|
|
1213 | 2. copy over AE_xyz to PERL_ANYEVENT_xyz unless the latter alraedy exists |
|
|
1214 | 3. if taint mode enabled, set all PERL_ANYEVENT_xyz variables to undef. |
|
|
1215 | |
|
|
1216 | This ensures that child processes will not see the "AE_" variables. |
|
|
1217 | |
|
|
1218 | The following environment variables are currently known to AnyEvent: |
1174 | |
1219 | |
1175 | "PERL_ANYEVENT_VERBOSE" |
1220 | "PERL_ANYEVENT_VERBOSE" |
1176 | By default, AnyEvent will be completely silent except in fatal |
1221 | By default, AnyEvent will be completely silent except in fatal |
1177 | conditions. You can set this environment variable to make AnyEvent |
1222 | conditions. You can set this environment variable to make AnyEvent |
1178 | more talkative. |
1223 | more talkative. If you want to do more than just set the global |
|
|
1224 | logging level you should have a look at "PERL_ANYEVENT_LOG", which |
|
|
1225 | allows much more complex specifications. |
1179 | |
1226 | |
1180 | When set to 5 or higher, causes AnyEvent to warn about unexpected |
1227 | When set to 5 or higher (warn), causes AnyEvent to warn about |
1181 | conditions, such as not being able to load the event model specified |
1228 | unexpected conditions, such as not being able to load the event |
1182 | by "PERL_ANYEVENT_MODEL". |
1229 | model specified by "PERL_ANYEVENT_MODEL", or a guard callback |
|
|
1230 | throwing an exception - this is the minimum recommended level. |
1183 | |
1231 | |
1184 | When set to 7 or higher, cause AnyEvent to report to STDERR which |
1232 | When set to 7 or higher (info), cause AnyEvent to report which event |
1185 | event model it chooses. |
1233 | model it chooses. |
1186 | |
1234 | |
1187 | When set to 8 or higher, then AnyEvent will report extra information |
1235 | When set to 8 or higher (debug), then AnyEvent will report extra |
1188 | on which optional modules it loads and how it implements certain |
1236 | information on which optional modules it loads and how it implements |
1189 | features. |
1237 | certain features. |
|
|
1238 | |
|
|
1239 | "PERL_ANYEVENT_LOG" |
|
|
1240 | Accepts rather complex logging specifications. For example, you |
|
|
1241 | could log all "debug" messages of some module to stderr, warnings |
|
|
1242 | and above to stderr, and errors and above to syslog, with: |
|
|
1243 | |
|
|
1244 | PERL_ANYEVENT_LOG=Some::Module=debug,+log:filter=warn,+%syslog:%syslog=error,syslog |
|
|
1245 | |
|
|
1246 | For the rather extensive details, see AnyEvent::Log. |
|
|
1247 | |
|
|
1248 | This variable is evaluated when AnyEvent (or AnyEvent::Log) is |
|
|
1249 | loaded, so will take effect even before AnyEvent has initialised |
|
|
1250 | itself. |
|
|
1251 | |
|
|
1252 | Note that specifying this environment variable causes the |
|
|
1253 | AnyEvent::Log module to be loaded, while "PERL_ANYEVENT_VERBOSE" |
|
|
1254 | does not, so only using the latter saves a few hundred kB of memory |
|
|
1255 | until the first message is being logged. |
1190 | |
1256 | |
1191 | "PERL_ANYEVENT_STRICT" |
1257 | "PERL_ANYEVENT_STRICT" |
1192 | AnyEvent does not do much argument checking by default, as thorough |
1258 | AnyEvent does not do much argument checking by default, as thorough |
1193 | argument checking is very costly. Setting this variable to a true |
1259 | argument checking is very costly. Setting this variable to a true |
1194 | value will cause AnyEvent to load "AnyEvent::Strict" and then to |
1260 | value will cause AnyEvent to load "AnyEvent::Strict" and then to |
… | |
… | |
1207 | by "AnyEvent::Socket::parse_hostport" (after replacing every |
1273 | by "AnyEvent::Socket::parse_hostport" (after replacing every |
1208 | occurance of $$ by the process pid) and an "AnyEvent::Debug::shell" |
1274 | occurance of $$ by the process pid) and an "AnyEvent::Debug::shell" |
1209 | is bound on that port. The shell object is saved in |
1275 | is bound on that port. The shell object is saved in |
1210 | $AnyEvent::Debug::SHELL. |
1276 | $AnyEvent::Debug::SHELL. |
1211 | |
1277 | |
1212 | This takes place when the first watcher is created. |
1278 | This happens when the first watcher is created. |
1213 | |
1279 | |
1214 | For example, to bind a debug shell on a unix domain socket in |
1280 | For example, to bind a debug shell on a unix domain socket in |
1215 | /tmp/debug<pid>.sock, you could use this: |
1281 | /tmp/debug<pid>.sock, you could use this: |
1216 | |
1282 | |
1217 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
1283 | PERL_ANYEVENT_DEBUG_SHELL=/tmp/debug\$\$.sock perlprog |
… | |
… | |
1263 | "PERL_ANYEVENT_PROTOCOLS=ipv4" - only support IPv4, never try to |
1329 | "PERL_ANYEVENT_PROTOCOLS=ipv4" - only support IPv4, never try to |
1264 | resolve or contact IPv6 addresses. |
1330 | resolve or contact IPv6 addresses. |
1265 | "PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4" support either IPv4 or IPv6, but |
1331 | "PERL_ANYEVENT_PROTOCOLS=ipv6,ipv4" support either IPv4 or IPv6, but |
1266 | prefer IPv6 over IPv4. |
1332 | prefer IPv6 over IPv4. |
1267 | |
1333 | |
|
|
1334 | "PERL_ANYEVENT_HOSTS" |
|
|
1335 | This variable, if specified, overrides the /etc/hosts file used by |
|
|
1336 | AnyEvent::Socket"::resolve_sockaddr", i.e. hosts aliases will be |
|
|
1337 | read from that file instead. |
|
|
1338 | |
1268 | "PERL_ANYEVENT_EDNS0" |
1339 | "PERL_ANYEVENT_EDNS0" |
1269 | Used by AnyEvent::DNS to decide whether to use the EDNS0 extension |
1340 | Used by AnyEvent::DNS to decide whether to use the EDNS0 extension |
1270 | for DNS. This extension is generally useful to reduce DNS traffic, |
1341 | for DNS. This extension is generally useful to reduce DNS traffic, |
1271 | but some (broken) firewalls drop such DNS packets, which is why it |
1342 | especially when DNSSEC is involved, but some (broken) firewalls drop |
1272 | is off by default. |
1343 | such DNS packets, which is why it is off by default. |
1273 | |
1344 | |
1274 | Setting this variable to 1 will cause AnyEvent::DNS to announce |
1345 | Setting this variable to 1 will cause AnyEvent::DNS to announce |
1275 | EDNS0 in its DNS requests. |
1346 | EDNS0 in its DNS requests. |
1276 | |
1347 | |
1277 | "PERL_ANYEVENT_MAX_FORKS" |
1348 | "PERL_ANYEVENT_MAX_FORKS" |
… | |
… | |
1282 | The default value for the "max_outstanding" parameter for the |
1353 | The default value for the "max_outstanding" parameter for the |
1283 | default DNS resolver - this is the maximum number of parallel DNS |
1354 | default DNS resolver - this is the maximum number of parallel DNS |
1284 | requests that are sent to the DNS server. |
1355 | requests that are sent to the DNS server. |
1285 | |
1356 | |
1286 | "PERL_ANYEVENT_RESOLV_CONF" |
1357 | "PERL_ANYEVENT_RESOLV_CONF" |
1287 | The file to use instead of /etc/resolv.conf (or OS-specific |
1358 | The absolute path to a resolv.conf-style file to use instead of |
1288 | configuration) in the default resolver. When set to the empty |
1359 | /etc/resolv.conf (or the OS-specific configuration) in the default |
1289 | string, no default config will be used. |
1360 | resolver, or the empty string to select the default configuration. |
1290 | |
1361 | |
1291 | "PERL_ANYEVENT_CA_FILE", "PERL_ANYEVENT_CA_PATH". |
1362 | "PERL_ANYEVENT_CA_FILE", "PERL_ANYEVENT_CA_PATH". |
1292 | When neither "ca_file" nor "ca_path" was specified during |
1363 | When neither "ca_file" nor "ca_path" was specified during |
1293 | AnyEvent::TLS context creation, and either of these environment |
1364 | AnyEvent::TLS context creation, and either of these environment |
1294 | variables exist, they will be used to specify CA certificate |
1365 | variables are nonempty, they will be used to specify CA certificate |
1295 | locations instead of a system-dependent default. |
1366 | locations instead of a system-dependent default. |
1296 | |
1367 | |
1297 | "PERL_ANYEVENT_AVOID_GUARD" and "PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT" |
1368 | "PERL_ANYEVENT_AVOID_GUARD" and "PERL_ANYEVENT_AVOID_ASYNC_INTERRUPT" |
1298 | When these are set to 1, then the respective modules are not loaded. |
1369 | When these are set to 1, then the respective modules are not loaded. |
1299 | Mostly good for testing AnyEvent itself. |
1370 | Mostly good for testing AnyEvent itself. |