• Home
• Phergie
• Irc
• Client
• React
• Client

PHP Class Phergie\Irc\Client\React\Client

Show file Open project: phergie/phergie-irc-client-react Class Usage Examples

Protected Properties

Property	Type	Description
$activeConnections	SplObjectStorage	Contains all connection instances associated with an active socket stream
$dnsServer	string
$logger	Psr\Log\LoggerInterface	Logging stream
$loop	React\EventLoop\LoopInterface	Event loop
$resolver	React\Dns\Resolver\Resolver
$secureConnector	React\SocketClient\SecureConnector	Connector used to establish SSL connections
$tickInterval	float	Interval in seconds between irc.tick events

Public Methods

Method	Description
addConnection ( Phergie\Irc\ConnectionInterface $connection )	Initializes an IRC connection.
addPeriodicTimer ( numeric $interval, callable $callback ) : React\Event\Timer\TimerInterface	Adds a recurring callback to execute on a specified interval. Proxies to addPeriodTimer() implementation of the event loop implementation returned by getLoop().
addTimer ( numeric $interval, callable $callback ) : React\Event\Timer\TimerInterface	Adds a one-time callback to execute after a specified amount of time has passed. Proxies to addTimer() implementation of the event loop implementation returned by getLoop().
cancelTimer ( React\EventLoop\Timer\TimerInterface $timer )	Cancels a specified timer created using addTimer() or addPeriodicTimer(). Proxies to the cancelTimer() implementation of the event loop implementation returned by getLoop().
getActiveConnections ( ) : Phergie\Irc\ConnectionInterface[]	Gets an array of all connections associated with an active socket stream.
getDnsServer ( ) : string	Returns the configured DNS server
getLogger ( ) : Psr\Log\LoggerInterface	Returns a stream instance for logging data on the socket connection.
getLoop ( ) : React\EventLoop\LoopInterface	Returns the event loop dependency, initializing it if needed.
getResolver ( ) : React\Dns\Resolver\Resolver	Get the DNS Resolver, if one isn't set in instance will be created.
getTickInterval ( ) : float	Returns the interval in seconds between irc.tick events.
isTimerActive ( React\EventLoop\Timer\TimerInterface $timer ) : boolean	Checks if a timer created using addTimer() or addPeriodicTimer() is active. Proxies to the isTimerActive() implementation of the event loop implementation returned by getLoop().
run ( Phergie\Irc\ConnectionInterface | Phergie\Irc\ConnectionInterface[] $connections, boolean $autorun = true )	Executes the event loop, which continues running until no active connections remain.
setDnsServer ( string $dnsServer = '8.8.8.8' )	Set the DNS server to use when looking up IP's
setLogger ( Psr\Log\LoggerInterface $logger )	Sets a logger for logging data on the socket connection.
setLoop ( React\EventLoop\LoopInterface $loop )	Sets the event loop dependency.
setResolver ( React\Dns\Resolver\Resolver $resolver = null )	Sets the DNS Resolver.
setTickInterval ( float $tickInterval )	Sets the interval in seconds between irc.tick events.

Protected Methods

Method	Description
addActiveConnection ( Phergie\Irc\ConnectionInterface $connection )	Add a connection instance to the active connection store
addLogging ( Evenement\EventEmitter $emitter, Phergie\Irc\ConnectionInterface $connection )	Adds an event listener to log data emitted by a stream.
addSecureConnection ( Phergie\Irc\ConnectionInterface $connection )	Initializes a secured connection.
addUnsecuredConnection ( Phergie\Irc\ConnectionInterface $connection )	Initializes an unsecured connection.
configureStreams ( Phergie\Irc\ConnectionInterface $connection, React\Stream\DuplexStreamInterface $stream, Phergie\Irc\Client\React\WriteStream $write )	Configure streams to handle messages received from and sent to the server.
emitConnectionError ( Phergie\Irc\Client\React\Exception $exception, Phergie\Irc\ConnectionInterface $connection )	Emits a connection error event.
getContext ( Phergie\Irc\ConnectionInterface $connection ) : array	Derives a set of socket context options for a given connection.
getEndCallback ( Phergie\Irc\Client\React\ReadStream $read, Phergie\Irc\Client\React\WriteStream $write, Phergie\Irc\ConnectionInterface $connection, React\EventLoop\Timer\TimerInterface $timer ) : callable	Returns a callback for when a connection is terminated, whether explicitly by the bot or server or as a result of loss of connectivity.
getErrorCallback ( Phergie\Irc\ConnectionInterface $connection ) : callable	Returns a callback for proxying connection error events to listeners of the client.
getForceIpv4Flag ( Phergie\Irc\ConnectionInterface $connection ) : boolean	Extracts the value of the force-ipv4 option from a given connection.
getOutputLogCallback ( Phergie\Irc\ConnectionInterface $connection, string $level, string $prefix = null ) : callable	Generates a closure for stream output logging.
getReadCallback ( Phergie\Irc\Client\React\WriteStream $write, Phergie\Irc\ConnectionInterface $connection ) : callable	Returns a callback for proxying IRC events from the read stream to IRC listeners of the client.
getReadStream ( Phergie\Irc\ConnectionInterface $connection ) : Phergie\Irc\Client\React\ReadStream	Returns a stream instance for parsing messages from the server and emitting them as events.
getRemote ( Phergie\Irc\ConnectionInterface $connection ) : string	Derives a remote for a given connection.
getSecureConnector ( ) : React\SocketClient\SecureConnector	Returns a connector for establishing SSL connections.
getSocket ( string $remote, array $context ) : resource	Returns a socket configured for a specified remote.
getStream ( resource $socket ) : React\Stream\DuplexStreamInterface	Returns a stream for a socket connection.
getTickCallback ( Phergie\Irc\Client\React\WriteStream $write, Phergie\Irc\ConnectionInterface $connection )	Returns a callback executed periodically to allow events to be sent asynchronously versus in response to received or sent events.
getTransport ( Phergie\Irc\ConnectionInterface $connection ) : string	Derives the transport for a given connection.
getWriteCallback ( Phergie\Irc\Client\React\WriteStream $write, Phergie\Irc\ConnectionInterface $connection ) : callable	Returns a callback for proxying events from the write stream to IRC listeners of the client.
getWriteStream ( Phergie\Irc\ConnectionInterface $connection ) : Phergie\Irc\Client\React\WriteStream	Returns a stream instance for sending events to the server.
identifyUser ( Phergie\Irc\ConnectionInterface $connection, Phergie\Irc\Client\React\WriteStream $writeStream )	Identifies the user to a server.
initializeConnection ( string $remote, Phergie\Irc\ConnectionInterface $connection )	Initializes an added connection.
initializeStream ( React\Stream\DuplexStreamInterface $stream, Phergie\Irc\ConnectionInterface $connection )	Configures an established stream for a given connection.
processInput ( array $message, Phergie\Irc\Client\React\WriteStream $write, Phergie\Irc\ConnectionInterface $connection )	There are certain incoming events that the client processes internally.
removeActiveConnection ( Phergie\Irc\ConnectionInterface $connection )	Remove a connection instance from the active connections store

Method Details

Property Details