Page MenuHomePhabricator
Diviner Phabricator Tech Docs PhabricatorStreamingProtocolAdapter

abstract class PhabricatorStreamingProtocolAdapter
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

PhabricatorStreamingProtocolAdapter
This method is not documented.
Return
wild

public function disconnect()
Inherited

PhabricatorProtocolAdapter

Disconnect from the service.

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.

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

abstract public function writeMessage($message)
Inherited

PhabricatorProtocolAdapter

This is the output mechanism for the protocol.

Parameters
PhabricatorBotMessage$messageThe message to write
Return
wild

abstract public function getServiceType()
Inherited

PhabricatorProtocolAdapter

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

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.

PhabricatorStreamingProtocolAdapter
This method is not documented.
Return
wild

protected function joinRoom($room_id)

This method is not documented.
Parameters
$room_id
Return
wild

private function read($ch, $data)

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

private function blockingMultiExec()

This method is not documented.
Return
wild

private function processReadBuffer()

This method is not documented.
Return
wild

protected function performPost($endpoint, $data)

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

protected function getAuthorizationHeader()

This method is not documented.
Return
wild

protected function getEncodedAuthToken()

This method is not documented.
Return
wild

abstract protected function buildStreamingUrl($channel)

This method is not documented.
Parameters
$channel
Return
wild

abstract protected function processMessage($raw_object)

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