PHP Class Thruway\Role\Subscriber

Inheritance: extends AbstractRole

Mostra file Open project: voryx/thruway

Public Methods

Method	Description
__construct ( )	Constructor
getFeatures ( ) : stdClass	Return supported features
handlesMessage ( Thruway\Message\Message $msg ) : boolean	Returns true if this role handles this message.
onMessage ( AbstractSession $session, Thruway\Message\Message $msg ) : void	Handle on recieved message
subscribe ( ClientSession $session, string $topicName, callable $callback, $options = null ) : Promise	process subscribe

Protected Methods

Method	Description
processError ( AbstractSession $session, Thruway\Message\ErrorMessage $msg )	Process error
processEvent ( ClientSession $session, Thruway\Message\EventMessage $msg )	Process event
processSubscribeError ( AbstractSession $session, Thruway\Message\ErrorMessage $msg )	Process subscribe error
processSubscribed ( ClientSession $session, Thruway\Message\SubscribedMessage $msg )	process subscribed
processUnsubscribed ( ClientSession $session, Thruway\Message\UnsubscribedMessage $msg )	process unsubscribed

Method Details

__construct() public method

Constructor

public __construct ( )

getFeatures() public method

Return supported features

public getFeatures ( ) : stdClass
return	stdClass

handlesMessage() public method

Returns true if this role handles this message.

public handlesMessage ( Thruway\Message\Message $msg ) : boolean
$msg	Thruway\Message\Message
return	boolean

onMessage() public method

Handle on recieved message

public onMessage ( AbstractSession $session, Thruway\Message\Message $msg ) : void
$session	Thruway\AbstractSession
$msg	Thruway\Message\Message
return	void

processError() protected method

Process error

protected processError ( AbstractSession $session, Thruway\Message\ErrorMessage $msg )
$session	Thruway\AbstractSession
$msg	Thruway\Message\ErrorMessage

processEvent() protected method

Process event

protected processEvent ( ClientSession $session, Thruway\Message\EventMessage $msg )
$session	Thruway\ClientSession
$msg	Thruway\Message\EventMessage

processSubscribeError() protected method

Process subscribe error

protected processSubscribeError ( AbstractSession $session, Thruway\Message\ErrorMessage $msg )
$session	Thruway\AbstractSession
$msg	Thruway\Message\ErrorMessage

processSubscribed() protected method

process subscribed

protected processSubscribed ( ClientSession $session, Thruway\Message\SubscribedMessage $msg )
$session	Thruway\ClientSession
$msg	Thruway\Message\SubscribedMessage

processUnsubscribed() protected method

process unsubscribed

protected processUnsubscribed ( ClientSession $session, Thruway\Message\UnsubscribedMessage $msg )
$session	Thruway\ClientSession
$msg	Thruway\Message\UnsubscribedMessage