PHP Class Thruway\AbstractSession

Afficher le fichier Open project: voryx/thruway Class Usage Examples

Protected Properties

Свойство	Type	Description
$authenticated	boolean
$loop	React\EventLoop\LoopInterface
$pingRequests	array
$realm	Realm
$sessionId	integer
$state	integer
$transport	Thruway\Transport\TransportInterface

Méthodes publiques

Méthode	Description
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

Method Details

abort() public méthode

process abort request

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

getAuthenticated() public méthode

Get authentication state (authenticated or not)

public getAuthenticated ( ) : boolean
Résultat	boolean

getLoop() public méthode

Get loop

public getLoop ( ) : React\EventLoop\LoopInterface
Résultat	React\EventLoop\LoopInterface

getRealm() public méthode

Get realm

public getRealm ( ) : Realm
Résultat	Realm

getSessionId() public méthode

Get session ID

public getSessionId ( ) : integer
Résultat	integer

getState() public méthode

Get client state

public getState ( ) : integer
Résultat	integer

getTransport() public méthode

Get transport

public getTransport ( ) : Thruway\Transport\TransportInterface
Résultat	Thruway\Transport\TransportInterface

isAuthenticated() public méthode

check is authenticated

public isAuthenticated ( ) : boolean
Résultat	boolean

isGoodbyeSent() public méthode

Check sent Goodbye message

public isGoodbyeSent ( ) : boolean
Résultat	boolean

ping() public méthode

Ping

public ping ( integer $timeout = 5 ) : Promise
$timeout	integer
Résultat	React\Promise\Promise

sendMessage() abstract public méthode

Send message

abstract public sendMessage ( Thruway\Message\Message $msg ) : mixed
$msg	Thruway\Message\Message
Résultat	mixed

setAuthenticated() public méthode

Set athentication state (authenticated or not)

public setAuthenticated ( boolean $authenticated )
$authenticated	boolean

setGoodbyeSent() public méthode

Set state sent goodbye message ?

public setGoodbyeSent ( boolean $goodbyeSent )
$goodbyeSent	boolean

setLoop() public méthode

Set loop

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

setRealm() public méthode

Set realm

public setRealm ( Realm $realm )
$realm	Realm

setState() public méthode

Set client state

public setState ( integer $state )
$state	integer

shutdown() public méthode

Process Shutdown session

public shutdown ( )

Property Details

$authenticated protected_oe property

protected bool $authenticated
Résultat	boolean

$loop protected_oe property

protected LoopInterface,React\EventLoop $loop
Résultat	React\EventLoop\LoopInterface

$pingRequests protected_oe property

protected array $pingRequests
Résultat	array

$realm protected_oe property

protected Realm,Thruway $realm
Résultat	Realm

$sessionId protected_oe property

protected int $sessionId
Résultat	integer

$state protected_oe property

protected int $state
Résultat	integer

$transport protected_oe property

protected TransportInterface,Thruway\Transport $transport
Résultat	Thruway\Transport\TransportInterface