Documentation

Request
in package
implements RequestInterface uses RequestTrait

Carries request to perform host action with payloads and failure as context. Can be cancelled if allows

Tags
psalm-import-type

RequestOptions from RequestInterface

Table of Contents

Interfaces

RequestInterface
Carries requests and responses between worker and host process.

Properties

$failure  : Throwable|null
$header  : HeaderInterface
$id  : int
$lastID  : int
$name  : string
$options  : array<string|int, mixed>
$payloads  : ValuesInterface

Methods

__construct()  : mixed
getFailure()  : Throwable|null
Optional failure.
getHeader()  : Header
getID()  : int
getName()  : string
getOptions()  : array<string|int, mixed>
getPayloads()  : ValuesInterface
setFailure()  : void
withHeader()  : self
getNextID()  : int

Properties

$failure

protected Throwable|null $failure = null

$lastID

protected static int $lastID = 9000

$options

protected array<string|int, mixed> $options = []

Methods

getFailure()

Optional failure.

public getFailure() : Throwable|null
Return values
Throwable|null

getID()

public getID() : int
Return values
int

getName()

public getName() : string
Return values
string

getOptions()

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

setFailure()

public setFailure(Throwable|null $failure) : void
Parameters
$failure : Throwable|null

getNextID()

private getNextID() : int
Return values
int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results