PhabricatorBaseProtocolAdapter.php
431e2bee6e7cmaster

PhabricatorBaseProtocolAdapter.php
View Options

			<?php

			/**
			* Defines the api for protocol adapters for @{class:PhabricatorBot}
			*/
			abstract class PhabricatorBaseProtocolAdapter {
			protected $config;

			public function setConfig($config) {
			$this->config = $config;
			return $this;
			}

			/**
			* Performs any connection logic necessary for the protocol
			*/
			abstract public function connect();

			/**
			* 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.
			*
			* @param Int $poll_frequency The number of seconds between polls
			*/
			abstract public function getNextMessages($poll_frequency);

			/**
			* This is the output mechanism for the protocol.
			*
			* @param PhabricatorBotMessage $message The message to write
			*/
			abstract public function writeMessage(PhabricatorBotMessage $message);
			}