Interface for a connection that receives data. More...
Inheritance diagram for Erebot\Interfaces\ReceivingConnection:
Public Member Functions | |
| process () | |
| read () | |
| 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 receives data.
Definition at line 27 of file ReceivingConnection.php.
Member Function Documentation
| Erebot\Interfaces\ReceivingConnection::process | ( | ) |
Processes all lines in the incoming FIFO. This method will dispatch the proper events for each line in the FIFO.
Implemented in Erebot\IrcConnection, Erebot\Prompt, Erebot\Identd\Server, and Erebot\Identd\Worker.
| Erebot\Interfaces\ReceivingConnection::read | ( | ) |
Processes data from the incoming buffer.
Once this method has been called, all lines awaiting processing in the incoming buffer have been transferred to the incoming FIFO. You must call Erebot::Connection::processQueuedData() after that in order to process the lines in the 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, Erebot\Prompt, Erebot\Identd\Server, and Erebot\Identd\Worker.
The documentation for this interface was generated from the following file:
- vendor/erebot/api/src/Interfaces/ReceivingConnection.php
