org.hornetq.core.server

Interface MessageReference

All Known Subinterfaces:

PagedReference

All Known Implementing Classes:

MessageReferenceImpl, PagedReferenceImpl

public interface MessageReference

A reference to a message. Channels store message references rather than the messages themselves.

Version:

$Revision: 3020 $ $Id: MessageReference.java 3020 2007-08-21 15:46:38Z timfox $

Author:

Ovidiu Feodorov, Tim Fox

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledge()
void	acknowledge(Transaction tx)
MessageReference	copy(Queue queue)
void	decrementDeliveryCount()
int	getDeliveryCount()
ServerMessage	getMessage()
int	getMessageMemoryEstimate() We define this method aggregation here because on paging we need to hold the original estimate, so we need to perform some extra steps on paging.
int	getPersistedCount()
Queue	getQueue()
long	getScheduledDeliveryTime()
void	handled()
void	incrementDeliveryCount()
boolean	isPaged()
void	setDeliveryCount(int deliveryCount)
void	setPersistedCount(int deliveryCount)
void	setScheduledDeliveryTime(long scheduledDeliveryTime)

Method Detail

isPaged

boolean isPaged()

getMessage

ServerMessage getMessage()

getMessageMemoryEstimate

int getMessageMemoryEstimate()

We define this method aggregation here because on paging we need to hold the original estimate, so we need to perform some extra steps on paging.

Returns:

copy

MessageReference copy(Queue queue)

getScheduledDeliveryTime

long getScheduledDeliveryTime()

Returns:

The time in the future that delivery will be delayed until, or zero if no scheduled delivery will occur

setScheduledDeliveryTime

void setScheduledDeliveryTime(long scheduledDeliveryTime)

getDeliveryCount

int getDeliveryCount()

setDeliveryCount

void setDeliveryCount(int deliveryCount)

setPersistedCount

void setPersistedCount(int deliveryCount)

getPersistedCount

int getPersistedCount()

incrementDeliveryCount

void incrementDeliveryCount()

decrementDeliveryCount

void decrementDeliveryCount()

getQueue

Queue getQueue()

acknowledge

void acknowledge()
                 throws Exception

Throws:

Exception

acknowledge

void acknowledge(Transaction tx)
                 throws Exception

Throws:

Exception

handled

void handled()