Package io.vertx.rxjava3.amqp
Class AmqpMessage
- java.lang.Object
-
- io.vertx.rxjava3.amqp.AmqpMessage
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class AmqpMessage extends Object implements io.vertx.lang.rx.RxDelegate
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.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<AmqpMessage>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description AmqpMessage(AmqpMessage delegate)AmqpMessage(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AmqpMessageaccepted()When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message.Stringaddress()JsonObjectapplicationProperties()BufferbodyAsBinary()booleanbodyAsBoolean()bytebodyAsByte()charbodyAsChar()doublebodyAsDouble()floatbodyAsFloat()intbodyAsInteger()JsonArraybodyAsJsonArray()JsonObjectbodyAsJsonObject()<T> List<T>bodyAsList()longbodyAsLong()shortbodyAsShort()StringbodyAsString()StringbodyAsSymbol()InstantbodyAsTimestamp()UUIDbodyAsUUID()StringcontentEncoding()StringcontentType()StringcorrelationId()static AmqpMessageBuildercreate()static AmqpMessageBuildercreate(AmqpMessage existing)Creates a builder to create a newAmqpMessagecopying the metadata from the passed message.longcreationTime()intdeliveryCount()booleanequals(Object o)longexpiryTime()AmqpMessagegetDelegate()StringgroupId()longgroupSequence()inthashCode()Stringid()booleanisBodyNull()booleanisDurable()booleanisFirstAcquirer()AmqpMessagemodified(boolean deliveryFailed, boolean undeliverableHere)When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message asmodified.static AmqpMessagenewInstance(AmqpMessage arg)intpriority()AmqpMessagerejected()When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message asrejected.AmqpMessagereleased()When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message asreleased.StringreplyTo()StringreplyToGroupId()Stringsubject()StringtoString()longttl()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<AmqpMessage> __TYPE_ARG
-
-
Constructor Detail
-
AmqpMessage
public AmqpMessage(AmqpMessage delegate)
-
AmqpMessage
public AmqpMessage(Object delegate)
-
-
Method Detail
-
getDelegate
public AmqpMessage getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
create
public static AmqpMessageBuilder create()
- Returns:
- a builder to create an
AmqpMessage.
-
create
public static AmqpMessageBuilder create(AmqpMessage existing)
Creates a builder to create a newAmqpMessagecopying the metadata from the passed message.- Parameters:
existing- an existing message, must not benull.- Returns:
- a builder to create an
AmqpMessage.
-
isDurable
public boolean isDurable()
- Returns:
- whether or not the message is durable.
-
isFirstAcquirer
public boolean isFirstAcquirer()
- Returns:
- if
true, then this message has not been acquired by any other link. Iffalse, then this message MAY have previously been acquired by another link or links.
-
priority
public int priority()
- Returns:
- the relative message priority. Higher numbers indicate higher priority messages. Messages with higher priorities MAY be delivered before those with lower priorities.
-
deliveryCount
public int deliveryCount()
- Returns:
- 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.
-
ttl
public long ttl()
- Returns:
- the duration in milliseconds for which the message is to be considered "live".
-
id
public String id()
- Returns:
- the message id
-
address
public String address()
- Returns:
- the message address, also named
tofield
-
replyTo
public String replyTo()
- Returns:
- The address of the node to send replies to, if any.
-
correlationId
public String correlationId()
- Returns:
- The client-specific id that can be used to mark or identify messages between clients.
-
isBodyNull
public boolean isBodyNull()
- Returns:
- whether the body is
null. This method returnstrueis the message does not contain a body or if the message contain anullAMQP value as body.
-
bodyAsBoolean
public boolean bodyAsBoolean()
- Returns:
- the boolean value contained in the body. The value must be passed as AMQP value.
-
bodyAsByte
public byte bodyAsByte()
- Returns:
- the byte value contained in the body. The value must be passed as AMQP value.
-
bodyAsShort
public short bodyAsShort()
- Returns:
- the short value contained in the body. The value must be passed as AMQP value.
-
bodyAsInteger
public int bodyAsInteger()
- Returns:
- the integer value contained in the body. The value must be passed as AMQP value.
-
bodyAsLong
public long bodyAsLong()
- Returns:
- the long value contained in the body. The value must be passed as AMQP value.
-
bodyAsFloat
public float bodyAsFloat()
- Returns:
- the float value contained in the body. The value must be passed as AMQP value.
-
bodyAsDouble
public double bodyAsDouble()
- Returns:
- the double value contained in the body. The value must be passed as AMQP value.
-
bodyAsChar
public char bodyAsChar()
- Returns:
- the character value contained in the body. The value must be passed as AMQP value.
-
bodyAsBinary
public Buffer bodyAsBinary()
- Returns:
- the bytes contained in the body. The value must be passed as AMQP data.
-
bodyAsString
public String bodyAsString()
- Returns:
- the string value contained in the body. The value must be passed as AMQP value.
-
bodyAsSymbol
public String bodyAsSymbol()
- Returns:
- the symbol value contained in the body. The value must be passed as AMQP value.
-
bodyAsList
public <T> List<T> bodyAsList()
- Returns:
- the list of values contained in the body. The value must be passed as AMQP value.
-
bodyAsJsonObject
public JsonObject bodyAsJsonObject()
- Returns:
- the JSON object contained in the body. The value must be passed as AMQP data.
-
bodyAsJsonArray
public JsonArray bodyAsJsonArray()
- Returns:
- the JSON array contained in the body. The value must be passed as AMQP data.
-
subject
public String subject()
-
contentType
public String contentType()
-
contentEncoding
public String contentEncoding()
-
expiryTime
public long expiryTime()
-
creationTime
public long creationTime()
-
groupId
public String groupId()
-
replyToGroupId
public String replyToGroupId()
-
groupSequence
public long groupSequence()
-
applicationProperties
public JsonObject applicationProperties()
- Returns:
- the message properties as JSON object.
-
accepted
public AmqpMessage accepted()
When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message. It marks the message as delivered with theacceptedstatus.- Returns:
- the current
AmqpMessageobject
-
rejected
public AmqpMessage rejected()
When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message asrejected.- Returns:
- the current
AmqpMessageobject
-
released
public AmqpMessage released()
When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message asreleased.- Returns:
- the current
AmqpMessageobject
-
modified
public AmqpMessage modified(boolean deliveryFailed, boolean undeliverableHere)
When receiving a message, and when auto-acknowledgement is disabled, this method is used to acknowledge the incoming message asmodified.- Parameters:
deliveryFailed- passtrueto increase the failed delivery countundeliverableHere- passtrueto prevent re-delivery of this message to the same consumer- Returns:
- the current
AmqpMessageobject
-
bodyAsTimestamp
public Instant bodyAsTimestamp()
- Returns:
- the timestamp value contained in the body. The value must be passed as AMQP value.
-
bodyAsUUID
public UUID bodyAsUUID()
- Returns:
- the UUID value contained in the body. The value must be passed as AMQP value.
-
newInstance
public static AmqpMessage newInstance(AmqpMessage arg)
-
-