PHP Класс Thruway\AbstractSession

Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$authenticated boolean
$loop React\EventLoop\LoopInterface
$pingRequests array
$realm Realm
$sessionId integer
$state integer
$transport Thruway\Transport\TransportInterface

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

Метод Описание
abort ( mixed $details = null, mixed $responseURI = null ) process abort request
getAuthenticated ( ) : boolean Get authentication state (authenticated or not)
getLoop ( ) : React\EventLoop\LoopInterface Get loop
getRealm ( ) : Realm Get realm
getSessionId ( ) : integer Get session ID
getState ( ) : integer Get client state
getTransport ( ) : Thruway\Transport\TransportInterface Get transport
isAuthenticated ( ) : boolean check is authenticated
isGoodbyeSent ( ) : boolean Check sent Goodbye message
ping ( integer $timeout = 5 ) : Promise Ping
sendMessage ( Thruway\Message\Message $msg ) : mixed Send message
setAuthenticated ( boolean $authenticated ) Set athentication state (authenticated or not)
setGoodbyeSent ( boolean $goodbyeSent ) Set state sent goodbye message ?
setLoop ( React\EventLoop\LoopInterface $loop ) Set loop
setRealm ( Realm $realm ) Set realm
setState ( integer $state ) Set client state
shutdown ( ) Process Shutdown session

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

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

process abort request
public abort ( mixed $details = null, mixed $responseURI = null )
$details mixed
$responseURI mixed

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

Get authentication state (authenticated or not)
public getAuthenticated ( ) : boolean
Результат boolean

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

Get loop
public getLoop ( ) : React\EventLoop\LoopInterface
Результат React\EventLoop\LoopInterface

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

Get realm
public getRealm ( ) : Realm
Результат Realm

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

Get session ID
public getSessionId ( ) : integer
Результат integer

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

Get client state
public getState ( ) : integer
Результат integer

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

Get transport
public getTransport ( ) : Thruway\Transport\TransportInterface
Результат Thruway\Transport\TransportInterface

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

check is authenticated
public isAuthenticated ( ) : boolean
Результат boolean

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

Check sent Goodbye message
public isGoodbyeSent ( ) : boolean
Результат boolean

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

Ping
public ping ( integer $timeout = 5 ) : Promise
$timeout integer
Результат React\Promise\Promise

sendMessage() абстрактный публичный Метод

Send message
abstract public sendMessage ( Thruway\Message\Message $msg ) : mixed
$msg Thruway\Message\Message
Результат mixed

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

Set athentication state (authenticated or not)
public setAuthenticated ( boolean $authenticated )
$authenticated boolean

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

Set state sent goodbye message ?
public setGoodbyeSent ( boolean $goodbyeSent )
$goodbyeSent boolean

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

Set loop
public setLoop ( React\EventLoop\LoopInterface $loop )
$loop React\EventLoop\LoopInterface

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

Set realm
public setRealm ( Realm $realm )
$realm Realm

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

Set client state
public setState ( integer $state )
$state integer

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

Process Shutdown session
public shutdown ( )

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

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

protected bool $authenticated
Результат boolean

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

protected LoopInterface,React\EventLoop $loop
Результат React\EventLoop\LoopInterface

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

protected array $pingRequests
Результат array

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

protected Realm,Thruway $realm
Результат Realm

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

protected int $sessionId
Результат integer

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

protected int $state
Результат integer

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

protected TransportInterface,Thruway\Transport $transport
Результат Thruway\Transport\TransportInterface