aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorZoffix Znet <cpan@zoffix.com>2016-07-28 23:14:23 -0400
committerZoffix Znet <cpan@zoffix.com>2016-07-28 23:14:23 -0400
commit311095fd68090ed82e9fff9f71003bc5247a108b (patch)
tree0586746065b1e974a08d4289ae532cc6fba54efe /docs
parentc19961745015bf5f9c2ef242895aa3778f8ec8ef (diff)
Document irc-started caveats
Diffstat (limited to 'docs')
-rw-r--r--docs/01-basics.md2
-rw-r--r--docs/02-event-reference.md12
2 files changed, 13 insertions, 1 deletions
diff --git a/docs/01-basics.md b/docs/01-basics.md
index 36ae32f..bbbdcd0 100644
--- a/docs/01-basics.md
+++ b/docs/01-basics.md
@@ -104,7 +104,7 @@ the `$.irc` attribute:
use IRC::Client;
class AlarmBot does IRC::Client::Plugin {
- method irc-connected ($) {
+ method irc-started {
react {
whenever Supply.interval(3) {
$.irc.send: :where<#perl6> :text<Three seconds passed!>;
diff --git a/docs/02-event-reference.md b/docs/02-event-reference.md
index f2bed7b..d990307 100644
--- a/docs/02-event-reference.md
+++ b/docs/02-event-reference.md
@@ -55,6 +55,18 @@ irc-addressed ▶ irc-to-me ▶ irc-notice-channel ▶ irc-notice
irc-started
```
+**Note:** `irc-started` is a special event that's exempt from the rules
+applicable to all other events and their event handlers:
+
+* It's called just once per call of `IRC::Client`'s `.run` method, regardless
+of how many times the client reconnects
+* When it's called, there's no guarantee the connections to servers have
+been fully established yet or channels joined yet.
+* Unless all other event handlers, this one does not take any arguments
+* Return values from handlers are ignored and the event is propagated to all of
+the plugins
+* This event does not trigger `irc-all` event
+
## Up Next
Read [the method reference](03-method-reference.md) next.