mxmbsocket/lib/Ratchet/Application/ApplicationInterface.php
Chris Boden f3c7dd4d7f Socket Proxy
Replaced passing SocketInterface everywhere with a proxy object
2011-11-14 15:56:30 -05:00

44 lines
1.7 KiB
PHP

<?php
namespace Ratchet\Application;
//use Ratchet\ObserverInterface;
use Ratchet\Resource\Connection;
interface ApplicationInterface /*extends ObserverInterface*/ {
/**
* Decorator pattern
* @param Ratchet\ObserverInterface Application to wrap in protocol
* @throws UnexpectedValueException
*/
public function __construct(ApplicationInterface $app = null);
/**
* When a new connection is opened it will be passed to this method
* @param SocketInterface The socket/connection that just connected to your application
* @return Ratchet\Resource\Command\CommandInterface|null
*/
function onOpen(Connection $conn);
/**
* Triggered when a client sends data through the socket
* @param SocketInterface The socket/connection that sent the message to your application
* @param string The message received
* @return Ratchet\Resource\Command\CommandInterface|null
*/
function onRecv(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 SocketInterface The socket/connection that is closing/closed
* @return Ratchet\Resource\Command\CommandInterface|null
*/
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 SocketInterface
* @param \Exception
* @return Ratchet\Resource\Command\CommandInterface|null
*/
function onError(Connection $conn, \Exception $e);
}