d37237c274
Removed the construct AppInterface requirement in the construct to let applications branch out easier. Each application can now specify its own dependancies rather than trying to rabbit hole apps.
44 lines
1.8 KiB
PHP
44 lines
1.8 KiB
PHP
<?php
|
|
namespace Ratchet\Application;
|
|
use Ratchet\Resource\Connection;
|
|
|
|
/**
|
|
* This is the interface to build a Ratchet application with
|
|
* It impelemtns the decorator and command pattern to build an application stack
|
|
*/
|
|
interface ApplicationInterface {
|
|
/**
|
|
* When a new connection is opened it will be passed to this method
|
|
* @param Ratchet\Resource\Connection The socket/connection that just connected to your application
|
|
* @return Ratchet\Resource\Command\CommandInterface|null
|
|
* @throws Exception
|
|
*/
|
|
function onOpen(Connection $conn);
|
|
|
|
/**
|
|
* Triggered when a client sends data through the socket
|
|
* @param Ratchet\Resource\Connection The socket/connection that sent the message to your application
|
|
* @param string The message received
|
|
* @return Ratchet\Resource\Command\CommandInterface|null
|
|
* @throws Exception
|
|
*/
|
|
function onMessage(Connection $from, $msg);
|
|
|
|
/**
|
|
* This is called before or after a socket is closed (depends on how it's closed). SendMessage to $conn will not result in an error if it has already been closed.
|
|
* @param Ratchet\Resource\Connection The socket/connection that is closing/closed
|
|
* @return Ratchet\Resource\Command\CommandInterface|null
|
|
* @throws Exception
|
|
*/
|
|
function onClose(Connection $conn);
|
|
|
|
/**
|
|
* If there is an error with one of the sockets, or somewhere in the application where an Exception is thrown,
|
|
* the Exception is sent back down the stack, handled by the Server and bubbled back up the application through this method
|
|
* @param Ratchet\Resource\Connection
|
|
* @param \Exception
|
|
* @return Ratchet\Resource\Command\CommandInterface|null
|
|
* @throws Exception
|
|
*/
|
|
function onError(Connection $conn, \Exception $e);
|
|
} |