ircbot/SocketFramework/Classes/Client/ClientDispatcherInterface.php

74 lines
1.5 KiB
PHP

<?php
namespace JPT\SocketFramework\Client;
/**
* Interface that includes the real must-have stuff.
*
* @author jpt
* @interface
* @package Client
*/
interface ClientDispatcherInterface {
/**
* Forwards incoming data to the ProtocolHandler
* Let's the ProtocolHandler do all the work and forward its results to the Clients.
* Return resulting raw data.
*
* @param string $rawData
* @return string
*/
public function processRawData($rawData);
/**
* This function will load the given config.
*
* @param array $config
* @return void
*/
public function loadConfig($config);
/**
* Will reset the connectionStatus of the client.
* Implementation is optional and depends on the client.
* Should be used to reset internal variables.
*
* @return void
*/
public function resetConnectionStatus();
/**
* This function gets called every time, the connection is established.
* This allows the client to send initial data.
*
* @return void
*/
public function initializeConnection();
/**
* Sets the ID.
*
* @param int $id
* @return void
*/
public function setID($id);
/**
* Sets the group.
*
* @param string $group
* @return void
*/
public function setGroup($group);
/**
* Injects ClientManager.
*
* @param \JPT\SocketFramework\Client\ClientManager $clientManager
* @return void
* @throws \JPT\SocketFramework\Exception\WrongDatatypeException
*/
public function injectClientManager($clientManager);
}
?>