Erebot  latest
A modular IRC bot for PHP 7.0+
Erebot\Identd\Server Class Reference

A server compatible with the Identification Protocol (RFC 1413). More...

+ Inheritance diagram for Erebot\Identd\Server:

Public Member Functions

 __construct (\Erebot\Interfaces\Core $bot, $connector= '0.0.0.0:113', $workerCls= '\\Erebot\\Identd\\Worker')
 
 __destruct ()
 Destructor.
 
 connect ()
 
 disconnect ($quitMessage=null)
 
 emptyReadQueue ()
 
 getBot ()
 
 getConfig ($chan)
 
 getIO ()
 
 getSocket ()
 
 isConnected ()
 
 process ()
 Processes commands queued in the input buffer.
 
 read ()
 

Protected Attributes

 $bot
 A bot object implementing the Erebot::Interfaces::Core interface.
 
 $socket
 The underlying socket, represented as a stream.
 
 $workerCls
 Class to use to process IdentD requests.
 

Detailed Description

A server compatible with the Identification Protocol (RFC 1413).

See Also
http://www.ietf.org/rfc/rfc1413.txt

Definition at line 30 of file Server.php.

Constructor & Destructor Documentation

Erebot\Identd\Server::__construct ( \Erebot\Interfaces\Core  $bot,
  $connector = '0.0.0.0:113',
  $workerCls = '\\Erebot\\Identd\\Worker' 
)

Create a new instance of the IdentD server.

Parameters
Erebot::Interfaces::Core$botInstance of the bot to operate on.
string$connector(optional) A string of the form "address:port" describing the IP address and port the server should listen on. The default is to listen on port 113 (as per RFC 1413) on all available interfaces (ie. "0.0.0.0:113").
string$workerCls(optional) Instances of this class will be created to handle identification requests. The default is "Erebot::Identd::Worker".
See Also
http://www.ietf.org/rfc/rfc1413.txt for information on the identification protocol.

Definition at line 63 of file Server.php.

References Erebot\Identd\Server\$bot, and Erebot\Identd\Server\$workerCls.


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