PHP Класс PHPDaemon\WebSocket\Route

Автор: Vasily Zorin ([email protected])
Наследование: implements PHPDaemon\WebSocket\RouteInterface, use trait PHPDaemon\Traits\StaticObjectWatchdog, use trait PHPDaemon\Traits\Sessions, use trait PHPDaemon\Traits\DeferredEventHandlers
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$appInstance PHPDaemon\Core\AppInstance
$attrs
$client PHPDaemon\Servers\WebSocket\Connection

Защищенные свойства (Protected)

Свойство Тип Описание
$running

Открытые методы

Метод Описание
__construct ( Connection $client, AppInstance $appInstance = null ) Called when client connected.
gracefulShutdown ( ) : boolean Called when the worker is going to shutdown.
handleException ( $e ) : boolean Uncaught exception handler
onFinish ( ) : void Called when session finished.
onFrame ( string $data, integer $type ) : void Called when new frame is received
onHandshake ( ) : void Called when the connection is handshaked.
onSleep ( ) : void Called when the request starts sleep
onWakeup ( ) : void Called when the request wakes up
setcookie ( string $name, string $value = '', integer $maxage, string $path = '', string $domain = '', boolean $secure = false, boolean $HTTPOnly = false ) : void Set the cookie

Защищенные методы

Метод Описание
getCookieStr ( string $name ) : string Get cookie by name
getSessionState ( ) : mixed Get session state
setSessionState ( mixed $var ) : void Set session state

Описание методов

__construct() публичный Метод

Called when client connected.
public __construct ( Connection $client, AppInstance $appInstance = null )
$client PHPDaemon\Servers\WebSocket\Connection Remote client
$appInstance PHPDaemon\Core\AppInstance

getCookieStr() защищенный Метод

Get cookie by name
protected getCookieStr ( string $name ) : string
$name string Name of cookie
Результат string Contents

getSessionState() защищенный Метод

Get session state
protected getSessionState ( ) : mixed
Результат mixed

gracefulShutdown() публичный Метод

Called when the worker is going to shutdown.
public gracefulShutdown ( ) : boolean
Результат boolean Ready to shutdown?

handleException() публичный Метод

Uncaught exception handler
public handleException ( $e ) : boolean
$e
Результат boolean Handled?

onFinish() публичный Метод

Called when session finished.
public onFinish ( ) : void
Результат void

onFrame() публичный Метод

Called when new frame is received
public onFrame ( string $data, integer $type ) : void
$data string Frame's contents
$type integer Frame's type
Результат void

onHandshake() публичный Метод

Called when the connection is handshaked.
public onHandshake ( ) : void
Результат void

onSleep() публичный Метод

Called when the request starts sleep
public onSleep ( ) : void
Результат void

onWakeup() публичный Метод

Called when the request wakes up
public onWakeup ( ) : void
Результат void

setSessionState() защищенный Метод

Set session state
protected setSessionState ( mixed $var ) : void
$var mixed
Результат void

setcookie() публичный Метод

Set the cookie
public setcookie ( string $name, string $value = '', integer $maxage, string $path = '', string $domain = '', boolean $secure = false, boolean $HTTPOnly = false ) : void
$name string Name of cookie
$value string Value
$maxage integer Optional. Max-Age. Default is 0.
$path string Optional. Path. Default is empty string.
$domain string Optional. Domain. Default is empty string.
$secure boolean Optional. Secure. Default is false.
$HTTPOnly boolean Optional. HTTPOnly. Default is false.
Результат void

Описание свойств

$appInstance публичное свойство

public AppInstance,PHPDaemon\Core $appInstance
Результат PHPDaemon\Core\AppInstance

$attrs публичное свойство

public $attrs

$client публичное свойство

public Connection,PHPDaemon\Servers\WebSocket $client
Результат PHPDaemon\Servers\WebSocket\Connection

$running защищенное свойство

protected $running