AMQPEnvelope

class AMQPEnvelope extends AMQPBasicProperties (View source)

stub class representing AMQPEnvelope from pecl-amqp

Methods

__construct(string|null $contentType = null, string|null $contentEncoding = null, array $headers = [], int $deliveryMode = AMQP_DELIVERY_MODE_TRANSIENT, int $priority = 0, string|null $correlationId = null, string|null $replyTo = null, string|null $expiration = null, string|null $messageId = null, int|null $timestamp = null, string|null $type = null, string|null $userId = null, string|null $appId = null, string|null $clusterId = null)

No description

from  AMQPBasicProperties
string|null
getContentType()

Get the message content type.

from  AMQPBasicProperties
string|null
getContentEncoding()

Get the content encoding of the message.

from  AMQPBasicProperties
array
getHeaders()

Get the headers of the message.

from  AMQPBasicProperties
int
getDeliveryMode()

Get the delivery mode of the message.

from  AMQPBasicProperties
int
getPriority()

Get the priority of the message.

from  AMQPBasicProperties
string|null
getCorrelationId()

Get the message correlation id.

from  AMQPBasicProperties
string|null
getReplyTo()

Get the reply-to address of the message.

from  AMQPBasicProperties
string|null
getExpiration()

Get the expiration of the message.

from  AMQPBasicProperties
string|null
getMessageId()

Get the message id of the message.

from  AMQPBasicProperties
int|null
getTimestamp()

Get the timestamp of the message.

from  AMQPBasicProperties
string|null
getType()

Get the message type.

from  AMQPBasicProperties
string|null
getUserId()

Get the message user id.

from  AMQPBasicProperties
string|null
getAppId()

Get the application id of the message.

from  AMQPBasicProperties
string|null
getClusterId()

Get the cluster id of the message.

from  AMQPBasicProperties
string
getBody()

Get the body of the message.

string
getRoutingKey()

Get the routing key of the message.

string|null
getConsumerTag()

Get the consumer tag of the message.

int|null
getDeliveryTag()

Get the delivery tag of the message.

string|null
getExchangeName()

Get the exchange name on which the message was published.

bool
isRedelivery()

Whether this is a redelivery of the message.

mixed
getHeader(string $headerName)

Get a specific message header.

bool
hasHeader(string $headerName)

Check whether specific message header exists.

Details

in AMQPBasicProperties at line 176
__construct(string|null $contentType = null, string|null $contentEncoding = null, array $headers = [], int $deliveryMode = AMQP_DELIVERY_MODE_TRANSIENT, int $priority = 0, string|null $correlationId = null, string|null $replyTo = null, string|null $expiration = null, string|null $messageId = null, int|null $timestamp = null, string|null $type = null, string|null $userId = null, string|null $appId = null, string|null $clusterId = null)

No description

Parameters

string|null $contentType
string|null $contentEncoding
array $headers
int $deliveryMode
int $priority
string|null $correlationId
string|null $replyTo
string|null $expiration
string|null $messageId
int|null $timestamp
string|null $type
string|null $userId
string|null $appId
string|null $clusterId

in AMQPBasicProperties at line 198
string|null getContentType()

Get the message content type.

Return Value

string|null

The content type of the message.

in AMQPBasicProperties at line 205
string|null getContentEncoding()

Get the content encoding of the message.

Return Value

string|null

The content encoding of the message.

in AMQPBasicProperties at line 212
array getHeaders()

Get the headers of the message.

Return Value

array

An array of key value pairs associated with the message.

in AMQPBasicProperties at line 219
int getDeliveryMode()

Get the delivery mode of the message.

Return Value

int

The delivery mode of the message.

in AMQPBasicProperties at line 226
int getPriority()

Get the priority of the message.

Return Value

int

The message priority.

in AMQPBasicProperties at line 233
string|null getCorrelationId()

Get the message correlation id.

Return Value

string|null

The correlation id of the message.

in AMQPBasicProperties at line 240
string|null getReplyTo()

Get the reply-to address of the message.

Return Value

string|null

The contents of the reply to field.

in AMQPBasicProperties at line 247
string|null getExpiration()

Get the expiration of the message.

Return Value

string|null

The message expiration.

in AMQPBasicProperties at line 254
string|null getMessageId()

Get the message id of the message.

Return Value

string|null

The message id

in AMQPBasicProperties at line 261
int|null getTimestamp()

Get the timestamp of the message.

Return Value

int|null

The message timestamp.

in AMQPBasicProperties at line 268
string|null getType()

Get the message type.

Return Value

string|null

The message type.

in AMQPBasicProperties at line 275
string|null getUserId()

Get the message user id.

Return Value

string|null

The message user id.

in AMQPBasicProperties at line 282
string|null getAppId()

Get the application id of the message.

Return Value

string|null

The application id of the message.

in AMQPBasicProperties at line 289
string|null getClusterId()

Get the cluster id of the message.

Return Value

string|null

The cluster id of the message.

at line 1064
string getBody()

Get the body of the message.

Return Value

string

The contents of the message body.

at line 1071
string getRoutingKey()

Get the routing key of the message.

Return Value

string

The message routing key.

at line 1078
string|null getConsumerTag()

Get the consumer tag of the message.

Return Value

string|null

The consumer tag of the message.

at line 1085
int|null getDeliveryTag()

Get the delivery tag of the message.

Return Value

int|null

The delivery tag of the message.

at line 1092
string|null getExchangeName()

Get the exchange name on which the message was published.

Return Value

string|null

The exchange name on which the message was published.

at line 1104
bool isRedelivery()

Whether this is a redelivery of the message.

Whether this is a redelivery of a message. If this message has been delivered and AMQPEnvelope::nack() was called, the message will be put back on the queue to be redelivered, at which point the message will always return TRUE when this method is called.

Return Value

bool

TRUE if this is a redelivery, FALSE otherwise.

at line 1113
mixed getHeader(string $headerName)

Get a specific message header.

Parameters

string $headerName

Name of the header to get the value from.

Return Value

mixed

The contents of the specified header or null if not set.

at line 1122
bool hasHeader(string $headerName)

Check whether specific message header exists.

Parameters

string $headerName

Name of the header to check.

Return Value

bool