Message

Represents a Message within Proton.

Create instances of Message using {@link Message.Factory}.

interface Message {}

Members

Classes

Factory
class Factory
Undocumented in source.

Functions

clear
void clear()
Undocumented in source.
decode
int decode(byte[] data, int offset, int length)

TODO describe what happens if the data does not represent a complete message. Currently this appears to leave the message in an unknown state.

decode
void decode(ReadableBuffer buffer)

Decodes the Message from the given {@link ReadableBuffer}. <p> If the buffer given does not contain the fully encoded Message bytes for decode this method will throw an exception to indicate the buffer underflow condition and the message object will be left in an undefined state.

encode
int encode(byte[] data, int offset, int length)

Encodes up to {@code length} bytes of the message into the provided byte array, starting at position {@code offset}.

encode
int encode(WritableBuffer buffer)

Encodes the current Message contents into the given {@link WritableBuffer} instance. <p> This method attempts to encode all message data into the {@link WritableBuffer} and if the buffer has insufficient space it will throw an exception to indicate the buffer overflow condition. If successful the method returns the number of bytes written to the provided buffer to fully encode the message.

getAddress
String getAddress()
Undocumented in source.
getApplicationProperties
ApplicationProperties getApplicationProperties()
Undocumented in source.
getBody
Section getBody()
Undocumented in source.
getContentEncoding
String getContentEncoding()
Undocumented in source.
getContentType
String getContentType()
Undocumented in source.
getCorrelationId
Object getCorrelationId()
Undocumented in source.
getCreationTime
long getCreationTime()
Undocumented in source.
getDeliveryAnnotations
DeliveryAnnotations getDeliveryAnnotations()
Undocumented in source.
getDeliveryCount
long getDeliveryCount()
Undocumented in source.
getError
MessageError getError()
Undocumented in source.
getExpiryTime
long getExpiryTime()
Undocumented in source.
getFooter
Footer getFooter()
Undocumented in source.
getGroupId
String getGroupId()
Undocumented in source.
getGroupSequence
long getGroupSequence()
Undocumented in source.
getHeader
Header getHeader()
Undocumented in source.
getMessageAnnotations
MessageAnnotations getMessageAnnotations()
Undocumented in source.
getMessageId
Object getMessageId()
Undocumented in source.
getPriority
short getPriority()
Undocumented in source.
getProperties
Properties getProperties()
Undocumented in source.
getReplyTo
String getReplyTo()
Undocumented in source.
getReplyToGroupId
String getReplyToGroupId()
Undocumented in source.
getSubject
String getSubject()
Undocumented in source.
getTtl
long getTtl()
Undocumented in source.
getUserId
byte[] getUserId()
Undocumented in source.
isDurable
bool isDurable()
Undocumented in source.
isFirstAcquirer
bool isFirstAcquirer()
Undocumented in source.
setAddress
void setAddress(String to)
Undocumented in source.
setApplicationProperties
void setApplicationProperties(ApplicationProperties applicationProperties)
Undocumented in source.
setBody
void setBody(Section body)
Undocumented in source.
setContentEncoding
void setContentEncoding(String contentEncoding)
Undocumented in source.
setContentType
void setContentType(String contentType)
Undocumented in source.
setCorrelationId
void setCorrelationId(String correlationId)
Undocumented in source.
setCreationTime
void setCreationTime(long creationTime)
Undocumented in source.
setDeliveryAnnotations
void setDeliveryAnnotations(DeliveryAnnotations deliveryAnnotations)
Undocumented in source.
setDeliveryCount
void setDeliveryCount(long deliveryCount)
Undocumented in source.
setDurable
void setDurable(bool durable)
Undocumented in source.
setExpiryTime
void setExpiryTime(long absoluteExpiryTime)
Undocumented in source.
setFirstAcquirer
void setFirstAcquirer(bool firstAcquirer)
Undocumented in source.
setFooter
void setFooter(Footer footer)
Undocumented in source.
setGroupId
void setGroupId(String groupId)
Undocumented in source.
setGroupSequence
void setGroupSequence(long groupSequence)
Undocumented in source.
setHeader
void setHeader(Header header)
Undocumented in source.
setMessageAnnotations
void setMessageAnnotations(MessageAnnotations messageAnnotations)
Undocumented in source.
setMessageId
void setMessageId(String messageId)
Undocumented in source.
setPriority
void setPriority(short priority)
Undocumented in source.
setProperties
void setProperties(Properties properties)
Undocumented in source.
setReplyTo
void setReplyTo(String replyTo)
Undocumented in source.
setReplyToGroupId
void setReplyToGroupId(String replyToGroupId)
Undocumented in source.
setSubject
void setSubject(String subject)
Undocumented in source.
setTtl
void setTtl(long ttl)
Undocumented in source.
setUserId
void setUserId(byte[] userId)
Undocumented in source.

Variables

DEFAULT_PRIORITY
enum short DEFAULT_PRIORITY;
Undocumented in source.

Meta