org.jboss.messaging.core.client
Interface ClientMessage

All Superinterfaces:
Message
All Known Subinterfaces:
ClientMessageInternal
All Known Implementing Classes:
ClientMessageImpl

public interface ClientMessage
extends Message

A ClientMessage

Author:
Tim Fox, Clebert Suconic

Method Summary
 void acknowledge()
           
 int getDeliveryCount()
           
 void saveToOutputStream(java.io.OutputStream out)
          Save the content of the message to the OutputStream.
 void setDeliveryCount(int deliveryCount)
           
 void setOutputStream(java.io.OutputStream out)
          Sets the OutputStream that will receive the content of a message received in a non blocking way
 boolean waitOutputStreamCompletion(long timeMilliseconds)
          Wait the outputStream completion of the message.
 
Methods inherited from interface org.jboss.messaging.core.message.Message
containsProperty, containsProperty, decode, decodeBody, decodeProperties, encode, encodeBody, encodeBody, encodeProperties, getBody, getBodyInputStream, getBodySize, getDestination, getEncodeSize, getExpiration, getLargeBodySize, getMessageID, getPriority, getProperties, getPropertiesEncodeSize, getProperty, getProperty, getPropertyNames, getTimestamp, getType, isDurable, isExpired, isLargeMessage, putBooleanProperty, putBooleanProperty, putByteProperty, putByteProperty, putBytesProperty, putBytesProperty, putDoubleProperty, putDoubleProperty, putFloatProperty, putFloatProperty, putIntProperty, putIntProperty, putLongProperty, putLongProperty, putShortProperty, putShortProperty, putStringProperty, putStringProperty, putTypedProperties, removeProperty, removeProperty, setBody, setBodyInputStream, setDestination, setDurable, setExpiration, setPriority, setTimestamp, toMap
 

Method Detail

getDeliveryCount

int getDeliveryCount()

setDeliveryCount

void setDeliveryCount(int deliveryCount)

setOutputStream

void setOutputStream(java.io.OutputStream out)
                     throws MessagingException
Sets the OutputStream that will receive the content of a message received in a non blocking way

Throws:
MessagingException

saveToOutputStream

void saveToOutputStream(java.io.OutputStream out)
                        throws MessagingException
Save the content of the message to the OutputStream. It will block until the entire content is transfered to the OutputStream.

Throws:
MessagingException

waitOutputStreamCompletion

boolean waitOutputStreamCompletion(long timeMilliseconds)
                                   throws MessagingException
Wait the outputStream completion of the message.

Parameters:
timeMilliseconds - - 0 means wait forever
Returns:
true if it reached the end
Throws:
MessagingException

acknowledge

void acknowledge()
                 throws MessagingException
Throws:
MessagingException


Copyright © 2006 JBoss Inc. All Rights Reserved.