0 follower

Interface Yiisoft\Queue\Message\EnvelopeInterface

All Classes | Methods | Constants

Extends	Yiisoft\Queue\Message\MessageInterface
Implemented by	Yiisoft\Queue\Message\Envelope, Yiisoft\Queue\Message\IdEnvelope, Yiisoft\Queue\Middleware\FailureHandling\FailureEnvelope

Envelope is a message container that adds additional metadata.

Public Methods

Method	Description	Defined By
fromData()		Yiisoft\Queue\Message\MessageInterface
fromMessage()		Yiisoft\Queue\Message\EnvelopeInterface
getData()	Returns payload data.	Yiisoft\Queue\Message\MessageInterface
getHandlerName()	Returns handler name.	Yiisoft\Queue\Message\MessageInterface
getMessage()		Yiisoft\Queue\Message\EnvelopeInterface
getMetadata()	Returns message metadata: timings, attempts count, metrics, etc.	Yiisoft\Queue\Message\MessageInterface

Constant	Value	Description	Defined By
ENVELOPE_STACK_KEY	'envelopes'		Yiisoft\Queue\Message\EnvelopeInterface

fromData() public abstract static method

Defined in: Yiisoft\Queue\Message\MessageInterface::fromData()

public abstract static self fromData ( string $handlerName, mixed $data, array $metadata = [] )
$handlerName	string
$data	mixed
$metadata	array

                public static function fromData(string $handlerName, mixed $data, array $metadata = []): self;

fromMessage() public abstract static method

public abstract static Yiisoft\Queue\Message\EnvelopeInterface fromMessage ( Yiisoft\Queue\Message\MessageInterface $message )
$message	Yiisoft\Queue\Message\MessageInterface

                public static function fromMessage(MessageInterface $message): static;

getData() public abstract method

Defined in: Yiisoft\Queue\Message\MessageInterface::getData()

Returns payload data.

public abstract mixed getData ( )

                public function getData(): mixed;

getHandlerName() public abstract method

Defined in: Yiisoft\Queue\Message\MessageInterface::getHandlerName()

Returns handler name.

public abstract string getHandlerName ( )

                public function getHandlerName(): string;

getMessage() public abstract method

public abstract Yiisoft\Queue\Message\MessageInterface getMessage ( )

                public function getMessage(): MessageInterface;

getMetadata() public abstract method

Defined in: Yiisoft\Queue\Message\MessageInterface::getMetadata()

Returns message metadata: timings, attempts count, metrics, etc.

public abstract array getMetadata ( )

                public function getMetadata(): array;