Represents an AMQP message.
Reference about the different metadata can be found on AMQP message properties.
Note that the body is retrieved using body*
method depending on the expected type.
package |
Default |
---|
__construct()
accepted() : $this
$this
the current {@link AmqpMessage} object
address() : string
string
the message address, also named {@code to} field
applicationProperties() : array
array
the message properties as JSON object.
bodyAsBinary() : \io\vertx\jphp\core\buffer\Buffer
\io\vertx\jphp\core\buffer\Buffer
the bytes contained in the body. The value must be passed as AMQP data.
bodyAsBoolean() : boolean
boolean
the boolean value contained in the body. The value must be passed as AMQP value.
bodyAsByte() : integer
integer
the byte value contained in the body. The value must be passed as AMQP value.
bodyAsChar() : string
string
the character value contained in the body. The value must be passed as AMQP value.
bodyAsDouble() : float
float
the double value contained in the body. The value must be passed as AMQP value.
bodyAsFloat() : float
float
the float value contained in the body. The value must be passed as AMQP value.
bodyAsInteger() : integer
integer
the integer value contained in the body. The value must be passed as AMQP value.
bodyAsJsonArray() : array
array
the JSON array contained in the body. The value must be passed as AMQP data.
bodyAsJsonObject() : array
array
the JSON object contained in the body. The value must be passed as AMQP data.
bodyAsList() : array
array
the list of values contained in the body. The value must be passed as AMQP value.
bodyAsLong() : integer
integer
the long value contained in the body. The value must be passed as AMQP value.
bodyAsShort() : integer
integer
the short value contained in the body. The value must be passed as AMQP value.
bodyAsString() : string
string
the string value contained in the body. The value must be passed as AMQP value.
bodyAsSymbol() : string
string
the symbol value contained in the body. The value must be passed as AMQP value.
contentEncoding() : string
string
contentType() : string
string
correlationId() : string
string
The client-specific id that can be used to mark or identify messages between clients.
create( $arg0 = null) : \io\vertx\jphp\amqp\AmqpMessageBuilder
Creates a builder to create a new @see \io\vertx\jphp\amqp\AmqpMessage copying the metadata from the passed message.
param $existing [AmqpMessage] an existing message, must not be {@code null}. create($existing)
AmqpMessage
\io\vertx\jphp\amqp\AmqpMessageBuilder
a builder to create an {@link AmqpMessage}.
creationTime() : integer
integer
deliveryCount() : integer
integer
the number of unsuccessful previous attempts to deliver this message. If this value is non-zero it can be taken as an indication that the delivery might be a duplicate. On first delivery, the value is zero. It is incremented upon an outcome being settled at the sender, according to rules defined for each outcome.
expiryTime() : integer
integer
groupId() : string
string
groupSequence() : integer
integer
id() : string
string
the message id
isBodyNull() : boolean
boolean
whether the body is {@code null}. This method returns {@code true} is the message does not contain a body or if the message contain a {@code null} AMQP value as body.
isDurable() : boolean
boolean
whether or not the message is durable.
isFirstAcquirer() : boolean
boolean
if {@code true}, then this message has not been acquired by any other link. If {@code false}, then this message MAY have previously been acquired by another link or links.
modified( $arg0, $arg1) : $this
boolean
boolean
$this
the current {@link AmqpMessage} object
priority() : integer
integer
the relative message priority. Higher numbers indicate higher priority messages. Messages with higher priorities MAY be delivered before those with lower priorities.
rejected() : $this
$this
the current {@link AmqpMessage} object
released() : $this
$this
the current {@link AmqpMessage} object
replyTo() : string
string
The address of the node to send replies to, if any.
replyToGroupId() : string
string
subject() : string
string
ttl() : integer
integer
the duration in milliseconds for which the message is to be considered "live".