org.apache.qpid.api

Interface Message

public interface Message

Method Summary

Methods

Modifier and Type	Method and Description
void	appendData(byte[] src) This will abstract the underlying message data.
void	appendData(ByteBuffer src) This will abstract the underlying message data.
void	clearData() This should clear the body of the message.
DeliveryProperties	getDeliveryProperties()
Header	getHeader()
MessageProperties	getMessageProperties()
int	getMessageTransferId() The provides access to the command Id assigned to the message transfer.
ByteBuffer	readData() * This will abstract the underlying message data.
void	readData(byte[] target) This will abstract the underlying message data.
void	setHeader(Header header)

Method Detail

getHeader

Header getHeader()

setHeader

void setHeader(Header header)

getMessageProperties

MessageProperties getMessageProperties()

getDeliveryProperties

DeliveryProperties getDeliveryProperties()

appendData

void appendData(byte[] src)
                throws IOException

This will abstract the underlying message data. The Message implementation may not hold all message data in memory (especially in the case of large messages) The appendData function might write data to

• Memory (Ex: ByteBuffer)
• To Disk
• To Socket (Stream)

Parameters:

src - - the data to append

Throws:

IOException - if there is an issue appending the data

appendData

void appendData(ByteBuffer src)
                throws IOException

This will abstract the underlying message data. The Message implementation may not hold all message data in memory (especially in the case of large messages) The appendData function might write data to

• Memory (Ex: ByteBuffer)
• To Disk
• To Socket (Stream)

Parameters:

src - - the data to append

Throws:

IOException - if there is an issue appending the data

readData

void readData(byte[] target)
              throws IOException

This will abstract the underlying message data. The Message implementation may not hold all message data in memory (especially in the case of large messages) The read function might copy data from

• From memory (Ex: ByteBuffer)
• From Disk
• From Socket as and when it gets streamed

Parameters:

target - The target byte[] which the data gets copied to

Throws:

IOException - if there is an issue reading the data

readData

ByteBuffer readData()
                    throws IOException

* This will abstract the underlying message data. The Message implementation may not hold all message data in memory (especially in the case of large messages) The read function might copy data from

• From memory (Ex: ByteBuffer)
• From Disk
• From Socket as and when it gets streamed

Returns:

A ByteBuffer containing data

Throws:

IOException - if there is an issue reading the data

clearData

void clearData()

This should clear the body of the message.

getMessageTransferId

int getMessageTransferId()

The provides access to the command Id assigned to the message transfer. This id is useful when you do

• For message acquiring - If the transfer happend in no-acquire mode you could use this id to accquire it.
• For releasing a message. You can use this id to release an acquired message
• For Acknowledging a message - You need to pass this ID, in order to acknowledge the message
• For Rejecting a message - You need to pass this ID, in order to reject the message.

Returns:

the message transfer id.