Module_PingReply  latest
Erebot module to respond to PING messages
Erebot\Module\PingReply Class Reference

A basic module that sends replies to PING queries it receives. More...

+ Inheritance diagram for Erebot\Module\PingReply:

Public Member Functions

 getHelp (\Erebot\Interfaces\Event\Base\TextMessage $event,\Erebot\Interfaces\TextWrapper $words)
 
 handlePing (\Erebot\Interfaces\EventHandler $handler,\Erebot\Interfaces\Event\Ping $event)
 
 reload ($flags)
 

Detailed Description

A basic module that sends replies to PING queries it receives.

Note
This module is required for the bot to run correctly (without being disconnected every few minutes with a "Ping timeout" quit message).

Definition at line 30 of file PingReply.php.

Member Function Documentation

Erebot\Module\PingReply::handlePing ( \Erebot\Interfaces\EventHandler  $handler,
\Erebot\Interfaces\Event\Ping  $event 
)

Responds to PING requests.

Parameters
Erebot::Interfaces::EventHandler$handlerHandler that triggered this event.
Erebot::Interfaces::Event::Ping$eventPING request to respond to.

(PHPMD.UnusedFormalParameter)

Definition at line 88 of file PingReply.php.

Erebot\Module\PingReply::reload (   $flags)

This method is called whenever the module is (re)loaded.

Parameters
int$flagsA bitwise OR of the Erebot_Module_Base::RELOAD_* constants. Your method should take proper actions depending on the value of those flags.
Note
See the documentation on individual RELOAD_* constants for a list of possible values.

Definition at line 44 of file PingReply.php.


The documentation for this class was generated from the following file: