Network.IRC.Client.Handlers

The default event handlers. Handlers are invoked concurrently when matching events are received from the server.

Event handlers

defaultEventHandlers :: [EventHandler s]

The default event handlers, the following are included:

• respond to server PING messages with a PONG;
• respond to CTCP PING requests with a CTCP PONG;
• respond to CTCP VERSION requests with the version string;
• respond to CTCP TIME requests with the system time;
• update the nick upon receiving the welcome message, in case the server modifies it;
• mangle the nick if the server reports a collision;
• update the channel list on JOIN and KICK.

These event handlers are all exposed through the Network.IRC.Client.Handlers module, so you can use them directly if you are building up your InstanceConfig from scratch.

If you are building a bot, you may want to write an event handler to process messages representing commands.

pingHandler :: UnicodeEvent -> StatefulIRC s ()

Respond to server PING messages with a PONG.

ctcpPingHandler :: UnicodeEvent -> StatefulIRC s ()

Respond to CTCP PING requests with a CTCP PONG.

ctcpVersionHandler :: UnicodeEvent -> StatefulIRC s ()

Respond to CTCP VERSION requests with the version string.

ctcpTimeHandler :: UnicodeEvent -> StatefulIRC s ()

Respond to CTCP TIME requests with the system time.

welcomeNick :: UnicodeEvent -> StatefulIRC s ()

Update the nick upon welcome (numeric reply 001), as it may not be what we requested (eg, in the case of a nick too long).

joinOnWelcome :: UnicodeEvent -> StatefulIRC s ()

Join default channels upon welcome (numeric reply 001). If sent earlier, the server might reject the JOIN attempts.

nickMangler :: UnicodeEvent -> StatefulIRC s ()

Mangle the nick if there's a collision (numeric replies 432, 433, and 436) when we set it

Special handlers

defaultOnConnect :: StatefulIRC s ()

The default connect handler: set the nick.

defaultOnDisconnect :: StatefulIRC s ()

The default disconnect handler: do nothing. You might want to override this with one which reconnects.