org.hornetq.core.client.impl

Class ClientMessageImpl

java.lang.Object

org.hornetq.core.message.impl.MessageImpl

org.hornetq.core.client.impl.ClientMessageImpl

All Implemented Interfaces:

ClientMessage, Message, ClientMessageInternal, MessageInternal

Direct Known Subclasses:

ClientLargeMessageImpl

public class ClientMessageImpl
extends MessageImpl
implements ClientMessageInternal

A ClientMessageImpl

Author:

Tim Fox, Andy Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleString	REPLYTO_HEADER_NAME

Fields inherited from class org.hornetq.core.message.impl.MessageImpl

address, BODY_OFFSET, bodyBuffer, buffer, BUFFER_HEADER_SPACE, bufferValid, durable, HDR_BRIDGE_DUPLICATE_ID, HDR_ROUTE_TO_IDS, messageID, priority, properties, timestamp, type

Fields inherited from interface org.hornetq.api.core.Message

BYTES_TYPE, DEFAULT_TYPE, HDR_ACTUAL_EXPIRY_TIME, HDR_DUPLICATE_DETECTION_ID, HDR_GROUP_ID, HDR_LARGE_BODY_SIZE, HDR_LARGE_COMPRESSED, HDR_LAST_VALUE_NAME, HDR_ORIG_MESSAGE_ID, HDR_ORIGINAL_ADDRESS, HDR_ORIGINAL_QUEUE, HDR_SCHEDULED_DELIVERY_TIME, MAP_TYPE, OBJECT_TYPE, STREAM_TYPE, TEXT_TYPE

Constructor Summary

Constructors

Constructor and Description
ClientMessageImpl()
ClientMessageImpl(byte type, boolean durable, long expiration, long timestamp, byte priority, int initialMessageBufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledge() Acknowledges reception of this message.
void	discardBody() Discard unused packets (used on large-message)
BodyEncoder	getBodyEncoder()
InputStream	getBodyInputStream()
int	getBodySize() Returns the size (in bytes) of this message's body
int	getDeliveryCount() Returns the number of times this message was delivered.
int	getFlowControlSize() Size used for FlowControl
void	individualAcknowledge() Acknowledges reception of a single message.
boolean	isCompressed()
boolean	isLargeMessage() Returns whether this message is a large message or a regular message.
boolean	isServerMessage()
void	onReceipt(ClientConsumerInternal consumer)
void	saveToOutputStream(OutputStream out) Saves the content of the message to the OutputStream.
void	setBodyInputStream(InputStream bodyInputStream) Sets the body's IntputStream.
void	setDeliveryCount(int deliveryCount) Sets the delivery count for this message.
void	setFlowControlSize(int flowControlSize) Size used for FlowControl
void	setOutputStream(OutputStream out) Sets the OutputStream that will receive the content of a message received in a non blocking way.
String	toString()
boolean	waitOutputStreamCompletion(long timeMilliseconds) Wait the outputStream completion of the message.

Methods inherited from class org.hornetq.core.message.impl.MessageImpl

bodyChanged, checkCompletion, checkCopy, containsProperty, containsProperty, copyHeadersAndProperties, createBody, decode, decodeFromBuffer, decodeHeadersAndProperties, encode, encodeHeadersAndProperties, getAddress, getBodyBuffer, getBodyBufferCopy, getBooleanProperty, getBooleanProperty, getByteProperty, getByteProperty, getBytesProperty, getBytesProperty, getDoubleProperty, getDoubleProperty, getEncodedBuffer, getEncodeSize, getEndOfBodyPosition, getEndOfMessagePosition, getExpiration, getFloatProperty, getFloatProperty, getHeadersAndPropertiesEncodeSize, getIntProperty, getIntProperty, getLongProperty, getLongProperty, getMessageID, getObjectProperty, getObjectProperty, getPriority, getProperties, getPropertyNames, getShortProperty, getShortProperty, getSimpleStringProperty, getSimpleStringProperty, getStringProperty, getStringProperty, getTimestamp, getType, getTypedProperties, getUserID, getWholeBuffer, isDurable, isExpired, putBooleanProperty, putBooleanProperty, putByteProperty, putByteProperty, putBytesProperty, putBytesProperty, putCharProperty, putCharProperty, putDoubleProperty, putDoubleProperty, putFloatProperty, putFloatProperty, putIntProperty, putIntProperty, putLongProperty, putLongProperty, putObjectProperty, putObjectProperty, putShortProperty, putShortProperty, putStringProperty, putStringProperty, putTypedProperties, removeProperty, removeProperty, resetCopied, setAddress, setAddressTransient, setDurable, setExpiration, setPriority, setTimestamp, setType, setUserID, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hornetq.api.core.client.ClientMessage

checkCompletion

Methods inherited from interface org.hornetq.core.message.impl.MessageInternal

bodyChanged, checkCopy, decodeFromBuffer, decodeHeadersAndProperties, encodeHeadersAndProperties, getEncodedBuffer, getEndOfBodyPosition, getEndOfMessagePosition, getHeadersAndPropertiesEncodeSize, getTypedProperties, getWholeBuffer, resetCopied, setAddressTransient

Methods inherited from interface org.hornetq.api.core.Message

containsProperty, containsProperty, getAddress, getBodyBuffer, getBodyBufferCopy, getBooleanProperty, getBooleanProperty, getByteProperty, getByteProperty, getBytesProperty, getBytesProperty, getDoubleProperty, getDoubleProperty, getEncodeSize, getExpiration, getFloatProperty, getFloatProperty, getIntProperty, getIntProperty, getLongProperty, getLongProperty, getMessageID, getObjectProperty, getObjectProperty, getPriority, getPropertyNames, getShortProperty, getShortProperty, getSimpleStringProperty, getSimpleStringProperty, getStringProperty, getStringProperty, getTimestamp, getType, getUserID, isDurable, isExpired, putBooleanProperty, putBooleanProperty, putByteProperty, putByteProperty, putBytesProperty, putBytesProperty, putCharProperty, putCharProperty, putDoubleProperty, putDoubleProperty, putFloatProperty, putFloatProperty, putIntProperty, putIntProperty, putLongProperty, putLongProperty, putObjectProperty, putObjectProperty, putShortProperty, putShortProperty, putStringProperty, putStringProperty, removeProperty, removeProperty, setAddress, setDurable, setExpiration, setPriority, setTimestamp, setUserID, toMap

Field Detail

REPLYTO_HEADER_NAME

public static final SimpleString REPLYTO_HEADER_NAME

Constructor Detail

ClientMessageImpl

public ClientMessageImpl()

ClientMessageImpl

public ClientMessageImpl(byte type,
                 boolean durable,
                 long expiration,
                 long timestamp,
                 byte priority,
                 int initialMessageBufferSize)

Method Detail

isServerMessage

public boolean isServerMessage()

Specified by:

isServerMessage in interface MessageInternal

onReceipt

public void onReceipt(ClientConsumerInternal consumer)

Specified by:

onReceipt in interface ClientMessageInternal

setDeliveryCount

public void setDeliveryCount(int deliveryCount)

Description copied from interface: ClientMessage

Sets the delivery count for this message.

This method is not meant to be called by HornetQ clients.

Specified by:

setDeliveryCount in interface ClientMessage

Parameters:

deliveryCount - message delivery count

getDeliveryCount

public int getDeliveryCount()

Description copied from interface: ClientMessage

Returns the number of times this message was delivered.

Specified by:

getDeliveryCount in interface ClientMessage

acknowledge

public void acknowledge()
                 throws HornetQException

Description copied from interface: ClientMessage

Acknowledges reception of this message.

If the session responsible to acknowledge this message has autoCommitAcks set to true, the transaction will automatically commit the current transaction. Otherwise, this acknowledgement will not be committed until the client commits the session transaction.

Specified by:

acknowledge in interface ClientMessage

Throws:

HornetQException - if an error occurred while acknowledging the message.

See Also:

ClientSession.isAutoCommitAcks()

individualAcknowledge

public void individualAcknowledge()
                           throws HornetQException

Description copied from interface: ClientMessage

Acknowledges reception of a single message.

If the session responsible to acknowledge this message has autoCommitAcks set to true, the transaction will automatically commit the current transaction. Otherwise, this acknowledgement will not be committed until the client commits the session transaction.

Specified by:

individualAcknowledge in interface ClientMessage

Throws:

HornetQException - if an error occurred while acknowledging the message.

See Also:

ClientSession.isAutoCommitAcks()

getFlowControlSize

public int getFlowControlSize()

Description copied from interface: ClientMessageInternal

Size used for FlowControl

Specified by:

getFlowControlSize in interface ClientMessageInternal

setFlowControlSize

public void setFlowControlSize(int flowControlSize)

Description copied from interface: ClientMessageInternal

Size used for FlowControl

Specified by:

setFlowControlSize in interface ClientMessageInternal

isLargeMessage

public boolean isLargeMessage()

Description copied from interface: Message

Returns whether this message is a large message or a regular message.

Specified by:

isLargeMessage in interface Message

Returns:

the largeMessage

isCompressed

public boolean isCompressed()

Specified by:

isCompressed in interface ClientMessageInternal

getBodySize

public int getBodySize()

Description copied from interface: ClientMessage

Returns the size (in bytes) of this message's body

Specified by:

getBodySize in interface ClientMessage

toString

public String toString()

Overrides:

toString in class Object

saveToOutputStream

public void saveToOutputStream(OutputStream out)
                        throws HornetQException

Description copied from interface: ClientMessage

Saves the content of the message to the OutputStream. It will block until the entire content is transferred to the OutputStream.

Specified by:

saveToOutputStream in interface ClientMessage

Throws:

HornetQException

setOutputStream

public void setOutputStream(OutputStream out)
                     throws HornetQException

Description copied from interface: ClientMessage

Sets the OutputStream that will receive the content of a message received in a non blocking way.
This method is used when consuming large messages

Specified by:

setOutputStream in interface ClientMessage

Throws:

HornetQException

waitOutputStreamCompletion

public boolean waitOutputStreamCompletion(long timeMilliseconds)
                                   throws HornetQException

Description copied from interface: ClientMessage

Wait the outputStream completion of the message. This method is used when consuming large messages

Specified by:

waitOutputStreamCompletion in interface ClientMessage

Parameters:

timeMilliseconds - - 0 means wait forever

Returns:

true if it reached the end

Throws:

HornetQException

discardBody

public void discardBody()

Description copied from interface: ClientMessageInternal

Discard unused packets (used on large-message)

Specified by:

discardBody in interface ClientMessageInternal

getBodyInputStream

public InputStream getBodyInputStream()

Specified by:

getBodyInputStream in interface MessageInternal

Returns:

the bodyInputStream

setBodyInputStream

public void setBodyInputStream(InputStream bodyInputStream)

Description copied from interface: ClientMessage

Sets the body's IntputStream.
This method is used when sending large messages

Specified by:

setBodyInputStream in interface ClientMessage

Parameters:

bodyInputStream - the bodyInputStream to set

getBodyEncoder

public BodyEncoder getBodyEncoder()
                           throws HornetQException

Specified by:

getBodyEncoder in interface MessageInternal

Overrides:

getBodyEncoder in class MessageImpl

Throws:

HornetQException