mxmbsocket/src/Ratchet/ComponentInterface.php
Chris Boden 55243550af [WebSocket] Refactoring
Updated deps; React Socket notify client of shutdown
Separated core interfaces into many
Removed initial version support out of handshake negotiator
Moved message parser responsibility to each version
Removed __toString method from MessageInterface as to not confuse message from payload
Support for RFC control frames
Support message concatenation
[BCB] (temporary) WsConnection hard coded to RFC version
Handshake checks for \r\n\r\n anywhere, not just at end of string
2012-06-09 19:38:44 -04:00

31 lines
1.2 KiB
PHP

<?php
namespace Ratchet;
/**
* This is the interface to build a Ratchet application with
* It impelemtns the decorator and command pattern to build an application stack
*/
interface ComponentInterface {
/**
* When a new connection is opened it will be passed to this method
* @param Ratchet\Connection The socket/connection that just connected to your application
* @throws Exception
*/
function onOpen(ConnectionInterface $conn);
/**
* 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\Connection The socket/connection that is closing/closed
* @throws Exception
*/
function onClose(ConnectionInterface $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\Connection
* @param \Exception
* @throws Exception
*/
function onError(ConnectionInterface $conn, \Exception $e);
}