PHP Class Thruway\Session

Inheritance: extends AbstractSession

Show file Open project: voryx/thruway Class Usage Examples

Public Properties

Property	Type	Description
$dispatcher	Thruway\Event\EventDispatcher

Public Methods

Method	Description
__construct ( Thruway\Transport\TransportInterface $transport )	Constructor
decPendingCallCount ( ) : integer
dispatchMessage ( Thruway\Message\Message $message, string $eventNamePrefix = "" )
getAuthenticationDetails ( ) : AuthenticationDetails	Get authentication details
getHelloMessage ( ) : Thruway\Message\HelloMessage
getLastInboundActivity ( ) : float
getLastOutboundActivity ( ) : float
getMessagesReceived ( ) : integer
getMessagesSent ( ) : integer	Get number sent messages
getMetaInfo ( ) : array	Get meta info
getPendingCallCount ( ) : integer
getRoleFeatures ( ) : null \| stdClass
getSessionStart ( ) : DateTime	Get time session start at
getSubscribedRealmEvents ( ) : array	Events that we'll be listening on
handleSendMessage ( MessageEvent $event )
incPendingCallCount ( ) : integer
onClose ( )	Handle close session
sendMessage ( Thruway\Message\Message $msg ) : mixed \| void	Send message
setAuthenticated ( boolean $authenticated )	Set authenticated state
setAuthenticationDetails ( AuthenticationDetails $authenticationDetails )	Set authentication details
setHelloMessage ( Thruway\Message\HelloMessage $helloMessage )
setPendingCallCount ( integer $pendingCallCount )
setRoleFeatures ( null \| stdClass $roleFeatures )

Private Methods

Method	Description
sendMessageToTransport ( Thruway\Message\Message $msg )

Method Details

__construct() public method

Constructor

public __construct ( Thruway\Transport\TransportInterface $transport )
$transport	Thruway\Transport\TransportInterface

decPendingCallCount() public method

public decPendingCallCount ( ) : integer
return	integer

dispatchMessage() public method

public dispatchMessage ( Thruway\Message\Message $message, string $eventNamePrefix = "" )
$message	Thruway\Message\Message
$eventNamePrefix	string

getAuthenticationDetails() public method

Get authentication details

public getAuthenticationDetails ( ) : AuthenticationDetails
return	Thruway\Authentication\AuthenticationDetails

getHelloMessage() public method

public getHelloMessage ( ) : Thruway\Message\HelloMessage
return	Thruway\Message\HelloMessage

getLastInboundActivity() public method

public getLastInboundActivity ( ) : float
return	float

getLastOutboundActivity() public method

public getLastOutboundActivity ( ) : float
return	float

getMessagesReceived() public method

public getMessagesReceived ( ) : integer
return	integer

getMessagesSent() public method

Get number sent messages

public getMessagesSent ( ) : integer
return	integer

getMetaInfo() public method

Get meta info

public getMetaInfo ( ) : array
return	array

getPendingCallCount() public method

public getPendingCallCount ( ) : integer
return	integer

getRoleFeatures() public method

public getRoleFeatures ( ) : null \| stdClass
return	null \| stdClass

getSessionStart() public method

Get time session start at

public getSessionStart ( ) : DateTime
return	DateTime

getSubscribedRealmEvents() public method

Events that we'll be listening on

public getSubscribedRealmEvents ( ) : array
return	array

handleSendMessage() public method

public handleSendMessage ( MessageEvent $event )
$event	Thruway\Event\MessageEvent

incPendingCallCount() public method

public incPendingCallCount ( ) : integer
return	integer

onClose() public method

Handle close session

public onClose ( )

sendMessage() public method

Send message

public sendMessage ( Thruway\Message\Message $msg ) : mixed \| void
$msg	Thruway\Message\Message
return	mixed \| void

setAuthenticated() public method

Set authenticated state

public setAuthenticated ( boolean $authenticated )
$authenticated	boolean

setAuthenticationDetails() public method

Set authentication details

public setAuthenticationDetails ( AuthenticationDetails $authenticationDetails )
$authenticationDetails	Thruway\Authentication\AuthenticationDetails

setHelloMessage() public method

public setHelloMessage ( Thruway\Message\HelloMessage $helloMessage )
$helloMessage	Thruway\Message\HelloMessage

setPendingCallCount() public method

public setPendingCallCount ( integer $pendingCallCount )
$pendingCallCount	integer

setRoleFeatures() public method

public setRoleFeatures ( null \| stdClass $roleFeatures )
$roleFeatures	null \| stdClass

Property Details

$dispatcher public property

public EventDispatcher,Thruway\Event $dispatcher
return	Thruway\Event\EventDispatcher