Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\Interfaces\SendingConnection Interface Reference

Interface for a connection that sends data. More...

+ Inheritance diagram for Erebot\Interfaces\SendingConnection:

Public Member Functions

 write ()
 
- Public Member Functions inherited from Erebot\Interfaces\Connection
 connect ()
 
 disconnect ($quitMessage=null)
 
 getBot ()
 
 getConfig ($chan)
 
 getIO ()
 
 getSocket ()
 
 isConnected ()
 

Detailed Description

Interface for a connection that sends data.

Definition at line 27 of file SendingConnection.php.

Member Function Documentation

Erebot\Interfaces\SendingConnection::write ( )

Sends a single line of data from the outgoing FIFO to the underlying socket.

This method is misnamed, because it acts on a FIFO rather than on raw data. This method can be called multiple times (such as in a loop) to send all lines in the outgoing FIFO. This is done so that a throttling policy may be put in place if needed (eg. for an anti-flood system).

Implemented in Erebot\IrcConnection, and Erebot\Identd\Worker.


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