PHP Class Aerys\Websocket\Handshake

Inheritance: implements Aerys\Response
Show file Open project: amphp/aerys

Public Methods

Method Description
__construct ( Aerys\Response $response, string $acceptKey )
addHeader ( string $field, string $value ) : Aerys\Response {@inheritDoc}
end ( string $finalBodyChunk = null ) {@inheritDoc}
flush ( ) {@inheritDoc}
push ( string $url, array $headers = null ) : Aerys\Response {@inheritDoc}
setCookie ( string $name, string $value, array $flags = [] ) : Aerys\Response {@inheritDoc}
setHeader ( string $field, string $value ) : Aerys\Response {@inheritDoc}
setReason ( string $phrase ) : Aerys\Response {@inheritDoc}
setStatus ( integer $code ) : Aerys\Response {@inheritDoc}
state ( ) : integer {@inheritDoc}
stream ( string $partialBodyChunk ) : Amp\Promise {@inheritDoc}

Private Methods

Method Description
handshake ( )

Method Details

__construct() public method

public __construct ( Aerys\Response $response, string $acceptKey )
$response Aerys\Response The server Response to wrap for the handshake
$acceptKey string The client request's SEC-WEBSOCKET-KEY header value

addHeader() public method

{@inheritDoc}
public addHeader ( string $field, string $value ) : Aerys\Response
$field string
$value string
return Aerys\Response

end() public method

{@inheritDoc}
public end ( string $finalBodyChunk = null )
$finalBodyChunk string

flush() public method

{@inheritDoc}
public flush ( )

push() public method

{@inheritDoc}
public push ( string $url, array $headers = null ) : Aerys\Response
$url string
$headers array
return Aerys\Response

setCookie() public method

{@inheritDoc}
public setCookie ( string $name, string $value, array $flags = [] ) : Aerys\Response
$name string
$value string
$flags array
return Aerys\Response

setHeader() public method

{@inheritDoc}
public setHeader ( string $field, string $value ) : Aerys\Response
$field string
$value string
return Aerys\Response

setReason() public method

{@inheritDoc}
public setReason ( string $phrase ) : Aerys\Response
$phrase string
return Aerys\Response

setStatus() public method

{@inheritDoc}
public setStatus ( integer $code ) : Aerys\Response
$code integer
return Aerys\Response

state() public method

{@inheritDoc}
public state ( ) : integer
return integer

stream() public method

{@inheritDoc}
public stream ( string $partialBodyChunk ) : Amp\Promise
$partialBodyChunk string
return Amp\Promise