Page MenuHomePhabricator
Diviner Phabricator Tech Docs PhabricatorIRCProtocolAdapter

final class PhabricatorIRCProtocolAdapter
Phabricator Technical Documentation (Daemons)

This class is not documented.

Methods

public function setConfig($config)
Inherited

This method is not documented.
Parameters
$config
Return
wild

public function getConfig($key, $default)
Inherited

This method is not documented.
Parameters
$key
$default
Return
wild

public function connect()

PhabricatorProtocolAdapter

Performs any connection logic necessary for the protocol

PhabricatorIRCProtocolAdapter
This method is not documented.
Return
wild

public function disconnect()

PhabricatorProtocolAdapter

Disconnect from the service.

PhabricatorIRCProtocolAdapter
This method is not documented.
Return
wild

public function getNextMessages($poll_frequency)

PhabricatorProtocolAdapter

This is the spout for messages coming in from the protocol. This will be called in the main event loop of the bot daemon So if if doesn't implement some sort of blocking timeout (e.g. select-based socket polling), it should at least sleep for some period of time in order to not overwhelm the processor.

PhabricatorIRCProtocolAdapter
This method is not documented.
Parameters
Int$poll_frequencyThe number of seconds between polls
Return
wild

public function writeMessage($message)

PhabricatorProtocolAdapter

This is the output mechanism for the protocol.

PhabricatorIRCProtocolAdapter
This method is not documented.
Parameters
PhabricatorBotMessage$messageThe message to write
Return
wild

public function getServiceType()

PhabricatorProtocolAdapter

String identifying the service type the adapter provides access to, like "irc", "campfire", "flowdock", "hipchat", etc.

PhabricatorIRCProtocolAdapter
This method is not documented.
Return
wild

public function getServiceName()

PhabricatorProtocolAdapter

String identifying the service name the adapter is connecting to. This is used to distinguish between instances of a service. For example, for IRC, this should return the IRC network the client is connecting to.

PhabricatorIRCProtocolAdapter
This method is not documented.
Return
wild

private function write($message)

This method is not documented.
Parameters
$message
Return
wild

private function processReadBuffer()

This method is not documented.
Return
wild

private function handleIRCProtocol($matches)

This method is not documented.
Parameters
array$matches
Return
wild

private function getBotCommand($irc_command)

This method is not documented.
Parameters
$irc_command
Return
wild

private function parseMessageData($command, $data)

This method is not documented.
Parameters
$command
$data
Return
wild