52 lines
1.9 KiB
PHP
52 lines
1.9 KiB
PHP
<?php
|
|
namespace Ratchet\RFC6455\Handshake;
|
|
use Ratchet\MessageInterface;
|
|
use Ratchet\ConnectionInterface;
|
|
use Guzzle\Http\Message\RequestInterface;
|
|
|
|
/**
|
|
* A standard interface for interacting with the various version of the WebSocket protocol
|
|
* @todo Look in to extension support
|
|
*/
|
|
interface NegotiatorInterface {
|
|
const GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
|
|
|
|
/**
|
|
* Given an HTTP header, determine if this version should handle the protocol
|
|
* @param \Guzzle\Http\Message\RequestInterface $request
|
|
* @return bool
|
|
* @throws \UnderflowException If the protocol thinks the headers are still fragmented
|
|
*/
|
|
function isProtocol(RequestInterface $request);
|
|
|
|
/**
|
|
* Although the version has a name associated with it the integer returned is the proper identification
|
|
* @return int
|
|
*/
|
|
function getVersionNumber();
|
|
|
|
/**
|
|
* Perform the handshake and return the response headers
|
|
* @param \Guzzle\Http\Message\RequestInterface $request
|
|
* @return \Guzzle\Http\Message\Response
|
|
* @throws \UnderflowException If the message hasn't finished buffering (not yet implemented, theoretically will only happen with Hixie version)
|
|
*/
|
|
function handshake(RequestInterface $request);
|
|
|
|
/**
|
|
* Add supported protocols. If the request has any matching the response will include one
|
|
* @param string $id
|
|
*/
|
|
function addSupportedSubProtocol($id);
|
|
|
|
/**
|
|
* If enabled and support for a subprotocol has been added handshake
|
|
* will not upgrade if a match between request and supported subprotocols
|
|
* @param boolean $enable
|
|
* @todo Consider extending this interface and moving this there.
|
|
* The spec does says the server can fail for this reason, but
|
|
it is not a requirement. This is an implementation detail.
|
|
*/
|
|
function setStrictSubProtocolCheck($enable);
|
|
}
|