org.hornetq.core.server

Interface ServerConsumer

All Superinterfaces:

Consumer

All Known Implementing Classes:

ServerConsumerImpl

public interface ServerConsumer
extends Consumer

A ServerConsumer

Author:

Tim Fox

Method Summary

Modifier and Type	Method and Description
void	acknowledge(boolean autoCommitAcks, Transaction tx, long messageID)
List<MessageReference>	cancelRefs(boolean failed, boolean lastConsumedAsDelivered, Transaction tx)
void	close(boolean failed)
void	forceDelivery(long sequence)
Object	getConnectionID()
long	getCreationTime()
long	getID()
Queue	getQueue()
String	getSessionID()
void	individualAcknowledge(boolean autoCommitAcks, Transaction tx, long messageID)
void	individualCancel(long messageID, boolean failed)
boolean	isBrowseOnly()
void	receiveCredits(int credits)
void	removeItself() This method is just to remove itself from Queues.
MessageReference	removeReferenceByID(long messageID)
void	setStarted(boolean started)
void	setTransferring(boolean transferring)

Methods inherited from interface org.hornetq.core.server.Consumer

debug, disconnect, getDeliveringMessages, getFilter, handle, proceedDeliver, toManagementString

Method Detail

getID

long getID()

getConnectionID

Object getConnectionID()

close

void close(boolean failed)
    throws Exception

Throws:

Exception

removeItself

void removeItself()
           throws Exception

This method is just to remove itself from Queues. If for any reason during a close an exception occurred, the exception treatment will call removeItself what should take the consumer out of any queues.

Throws:

Exception

cancelRefs

List<MessageReference> cancelRefs(boolean failed,
                                  boolean lastConsumedAsDelivered,
                                  Transaction tx)
                           throws Exception

Throws:

Exception

setStarted

void setStarted(boolean started)

receiveCredits

void receiveCredits(int credits)
             throws Exception

Throws:

Exception

getQueue

Queue getQueue()

removeReferenceByID

MessageReference removeReferenceByID(long messageID)
                              throws Exception

Throws:

Exception

acknowledge

void acknowledge(boolean autoCommitAcks,
                 Transaction tx,
                 long messageID)
          throws Exception

Throws:

Exception

individualAcknowledge

void individualAcknowledge(boolean autoCommitAcks,
                           Transaction tx,
                           long messageID)
                    throws Exception

Throws:

Exception

individualCancel

void individualCancel(long messageID,
                      boolean failed)
               throws Exception

Throws:

Exception

forceDelivery

void forceDelivery(long sequence)

setTransferring

void setTransferring(boolean transferring)

isBrowseOnly

boolean isBrowseOnly()

getCreationTime

long getCreationTime()

getSessionID

String getSessionID()