\Phergie\Irc\Client\ReactClientInterface

Interface for an IRC client implementation.

Summary

Methods
Constants
on()
once()
removeListener()
removeAllListeners()
listeners()
emit()
addConnection()
run()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

on()

on( $event, callable $listener)

Parameters

$event
callable $listener

once()

once( $event, callable $listener)

Parameters

$event
callable $listener

removeListener()

removeListener( $event, callable $listener)

Parameters

$event
callable $listener

removeAllListeners()

removeAllListeners( $event)

Parameters

$event

listeners()

listeners( $event)

Parameters

$event

emit()

emit( $event, array $arguments)

Parameters

$event
array $arguments

addConnection()

addConnection(\Phergie\Irc\ConnectionInterface $connection)

Initializes an IRC connection.

Parameters

\Phergie\Irc\ConnectionInterface $connection

Metadata for connection to establish

Throws

\Phergie\Irc\Client\React\Exception

if unable to establish the connection

run()

run(\Phergie\Irc\ConnectionInterface|\Phergie\Irc\ConnectionInterface[] $connections)

Executes the event loop, which continues running until no active connections remain.

Parameters

\Phergie\Irc\ConnectionInterface|\Phergie\Irc\ConnectionInterface[] $connections