Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\Proxy\Base Class Reference

Base class for a proxy client. More...

+ Inheritance diagram for Erebot\Proxy\Base:

Public Member Functions

 __construct ($socket)
 
 proxify (\Erebot\URIInterface $proxyURI,\Erebot\URIInterface $nextURI)
 

Protected Attributes

 $logger
 A logger for this proxy client.
 
 $socket
 A socket on which to operate.
 

Detailed Description

Base class for a proxy client.

Definition at line 27 of file Base.php.

Constructor & Destructor Documentation

Erebot\Proxy\Base::__construct (   $socket)

Create the base for a proxy client.

Parameters
stream$socketA socket which will be used to tunnel data.

Definition at line 41 of file Base.php.

References Erebot\Proxy\Base\$socket, and Erebot\Proxy\Base\proxify().

Member Function Documentation

Erebot\Proxy\Base::proxify ( \Erebot\URIInterface  $proxyURI,
\Erebot\URIInterface  $nextURI 
)
abstract

Main method which will do all the work of making the proxy tunnel.

Parameters
Erebot::URIInterface$proxyURIURI used to designate the proxy.
Erebot::URIInterface$nextURIURI used to designate the next element in the proxy chain. The next URI may point to either another proxy (chaining), or the final end point of the chain.

Referenced by Erebot\Proxy\Base\__construct().


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