PHP Class Thruway\Role\Dealer

Inheritance: implements Thruway\Module\RealmModuleInterface
Show file Open project: voryx/thruway Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor
getCallByRequestId ( integer $requestId ) : Call | boolean Get Call by requestID
getFeatures ( ) : stdClass
getProcedures ( ) : Procedure[]
getRegistrationById ( $id ) : boolean | Registration
getSubscribedRealmEvents ( ) : array
handleCallMessage ( MessageEvent $event )
handleCancelMessage ( MessageEvent $event )
handleErrorMessage ( MessageEvent $event )
handleLeaveRealm ( LeaveRealmEvent $event )
handleRegisterMessage ( MessageEvent $event )
handleSendWelcomeMessage ( MessageEvent $event )
handleUnregisterMessage ( MessageEvent $event )
handleYieldMessage ( MessageEvent $event )
handlesMessage ( Thruway\Message\Message $msg ) : boolean Returns true if this role handles this message.
leave ( Session $session ) process leave session
managerGetRegistrations ( ) : array Get list registrations

Protected Methods

Method Description
removeCall ( Call $call ) This removes all references to calls so they can be GCed

Private Methods

Method Description
processCall ( Session $session, Thruway\Message\CallMessage $msg ) : boolean Process call
processCancel ( Session $session, Thruway\Message\CancelMessage $msg )
processError ( Session $session, Thruway\Message\ErrorMessage $msg ) process ErrorMessage
processInterruptError ( Session $session, Thruway\Message\ErrorMessage $msg )
processInvocationError ( Session $session, Thruway\Message\ErrorMessage $msg ) Process InvocationError
processQueue ( Session $session )
processRegister ( Session $session, Thruway\Message\RegisterMessage $msg ) process RegisterMessage
processUnregister ( Session $session, Thruway\Message\UnregisterMessage $msg ) process UnregisterMessage
processYield ( Session $session, Thruway\Message\YieldMessage $msg ) process YieldMessage

Method Details

__construct() public method

Constructor
public __construct ( )

getCallByRequestId() public method

Get Call by requestID
public getCallByRequestId ( integer $requestId ) : Call | boolean
$requestId integer
return Thruway\Call | boolean

getFeatures() public method

public getFeatures ( ) : stdClass
return stdClass

getProcedures() public method

public getProcedures ( ) : Procedure[]
return Thruway\Procedure[]

getRegistrationById() public method

public getRegistrationById ( $id ) : boolean | Registration
$id
return boolean | Thruway\Registration

getSubscribedRealmEvents() public method

public getSubscribedRealmEvents ( ) : array
return array

handleCallMessage() public method

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

handleCancelMessage() public method

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

handleErrorMessage() public method

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

handleLeaveRealm() public method

public handleLeaveRealm ( LeaveRealmEvent $event )
$event Thruway\Event\LeaveRealmEvent

handleRegisterMessage() public method

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

handleSendWelcomeMessage() public method

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

handleUnregisterMessage() public method

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

handleYieldMessage() public method

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

handlesMessage() public method

Returns true if this role handles this message.
public handlesMessage ( Thruway\Message\Message $msg ) : boolean
$msg Thruway\Message\Message
return boolean

leave() public method

process leave session
public leave ( Session $session )
$session Thruway\Session

managerGetRegistrations() public method

todo: this may be used by testing
public managerGetRegistrations ( ) : array
return array

removeCall() protected method

This removes all references to calls so they can be GCed
protected removeCall ( Call $call )
$call Thruway\Call