PHP Class Thruway\Procedure

The Procedure class is used by the Dealer to keep track of registered procedures.
Datei anzeigen Open project: voryx/thruway Class Usage Examples

Public Methods

Method Description
__construct ( string $procedureName ) Constructor
getAllowMultipleRegistrations ( ) : boolean
getCallByRequestId ( integer $requestId ) : Call | boolean Get call by request ID
getDiscloseCaller ( ) : boolean
getInvokeType ( ) : string
getProcedureName ( ) : string
getRegistrationById ( $registrationId ) : boolean | Registration Get registration by ID
getRegistrations ( ) : array
isAllowMultipleRegistrations ( ) : boolean
isDiscloseCaller ( ) : boolean
leave ( Session $session ) process session leave
managerGetRegistrations ( ) todo: This was part of the manager stuff - but may be used by some tests
processCall ( Session $session, Call $call ) : boolean | Call Process call
processQueue ( ) Process the Queue
processRegister ( Session $session, Thruway\Message\RegisterMessage $msg ) : boolean Process register
processUnregister ( Session $session, Thruway\Message\UnregisterMessage $msg ) : boolean process unregister
removeCall ( Call $call ) Remove all references to Call to it can be GCed
setAllowMultipleRegistrations ( boolean $allowMultipleRegistrations )
setDiscloseCaller ( boolean $discloseCaller )
setInvokeType ( $invoketype )

Private Methods

Method Description
addRegistration ( Registration $registration, Thruway\Message\RegisterMessage $msg ) : boolean Add registration
getNextFirstRegistration ( )
getNextLastRegistration ( )
getNextRandomRegistration ( )
getNextRoundRobinRegistration ( )
getNextThruwayRegistration ( )
setProcedureName ( string $procedureName )

Method Details

__construct() public method

Constructor
public __construct ( string $procedureName )
$procedureName string

getAllowMultipleRegistrations() public method

public getAllowMultipleRegistrations ( ) : boolean
return boolean

getCallByRequestId() public method

Get call by request ID
public getCallByRequestId ( integer $requestId ) : Call | boolean
$requestId integer
return Call | boolean

getDiscloseCaller() public method

public getDiscloseCaller ( ) : boolean
return boolean

getInvokeType() public method

public getInvokeType ( ) : string
return string

getProcedureName() public method

public getProcedureName ( ) : string
return string

getRegistrationById() public method

Get registration by ID
public getRegistrationById ( $registrationId ) : boolean | Registration
$registrationId
return boolean | Registration

getRegistrations() public method

public getRegistrations ( ) : array
return array

isAllowMultipleRegistrations() public method

public isAllowMultipleRegistrations ( ) : boolean
return boolean

isDiscloseCaller() public method

public isDiscloseCaller ( ) : boolean
return boolean

leave() public method

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

managerGetRegistrations() public method

todo: This was part of the manager stuff - but may be used by some tests
public managerGetRegistrations ( )

processCall() public method

Process call
public processCall ( Session $session, Call $call ) : boolean | Call
$session Session
$call Call
return boolean | Call | Call

processQueue() public method

Process the Queue
public processQueue ( )

processRegister() public method

Process register
public processRegister ( Session $session, Thruway\Message\RegisterMessage $msg ) : boolean
$session Session
$msg Thruway\Message\RegisterMessage
return boolean

processUnregister() public method

process unregister
public processUnregister ( Session $session, Thruway\Message\UnregisterMessage $msg ) : boolean
$session Session
$msg Thruway\Message\UnregisterMessage
return boolean

removeCall() public method

Remove all references to Call to it can be GCed
public removeCall ( Call $call )
$call Call

setAllowMultipleRegistrations() public method

public setAllowMultipleRegistrations ( boolean $allowMultipleRegistrations )
$allowMultipleRegistrations boolean

setDiscloseCaller() public method

public setDiscloseCaller ( boolean $discloseCaller )
$discloseCaller boolean

setInvokeType() public method

public setInvokeType ( $invoketype )