org.apache.qpid.amqp_1_0.client

Class Receiver

java.lang.Object

org.apache.qpid.amqp_1_0.client.Receiver

All Implemented Interfaces:

DeliveryStateHandler

public class Receiver
extends Object
implements DeliveryStateHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Receiver.MessageArrivalListener
static interface	Receiver.SettledAction

Constructor Summary

Constructors

Constructor and Description
Receiver(Session session, String linkName, Target target, Source source, AcknowledgeMode ackMode)
Receiver(Session session, String linkName, Target target, Source source, AcknowledgeMode ackMode, boolean isDurable)
Receiver(Session session, String linkName, Target target, Source source, AcknowledgeMode ackMode, boolean isDurable, Map<Binary,Outcome> unsettled)

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledge(Binary deliveryTag)
void	acknowledge(Binary deliveryTag, Receiver.SettledAction a)
void	acknowledge(Binary deliveryTag, Transaction txn)
void	acknowledge(Binary deliveryTag, Transaction txn, Receiver.SettledAction action)
void	acknowledge(Message m)
void	acknowledge(Message m, Receiver.SettledAction a)
void	acknowledge(Message m, Transaction txn)
void	acknowledgeAll(Binary deliveryTag)
void	acknowledgeAll(Binary deliveryTag, Transaction txn, Receiver.SettledAction action)
void	acknowledgeAll(Message m)
void	clearDrain() Clears the receiver drain so that message delivery can resume.
void	close()
void	detach()
void	drain()
boolean	drainWait() Waits for the receiver to drain or a message to be available to be received.
String	getAddress()
Error	getError()
Map	getFilter()
Map<Binary,Outcome>	getRemoteUnsettled()
Session	getSession()
Source	getSource()
void	handle(Binary deliveryTag, DeliveryState state, Boolean settled)
void	modified(Binary tag)
Message	receive()
Message	receive(boolean wait)
Message	receive(long wait)
void	release(Binary deliveryTag)
void	release(Message m)
void	setCredit(UnsignedInteger credit, boolean window)
void	setCreditWithTransaction(UnsignedInteger credit, Transaction txn)
void	setMessageArrivalListener(Receiver.MessageArrivalListener messageArrivalListener)
void	setRemoteErrorListener(Runnable listener)
void	update(Outcome outcome, Binary deliveryTag, Transaction txn, Receiver.SettledAction action)
void	updateAll(Outcome outcome, Binary deliveryTag)
void	updateAll(Outcome outcome, Binary deliveryTag, Transaction txn, Receiver.SettledAction action)

Methods inherited from class java.lang.Object

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

Constructor Detail

Receiver

public Receiver(Session session,
        String linkName,
        Target target,
        Source source,
        AcknowledgeMode ackMode)
         throws ConnectionErrorException

Throws:

ConnectionErrorException

Receiver

public Receiver(Session session,
        String linkName,
        Target target,
        Source source,
        AcknowledgeMode ackMode,
        boolean isDurable)
         throws ConnectionErrorException

Throws:

ConnectionErrorException

Receiver

public Receiver(Session session,
        String linkName,
        Target target,
        Source source,
        AcknowledgeMode ackMode,
        boolean isDurable,
        Map<Binary,Outcome> unsettled)
         throws ConnectionErrorException

Throws:

ConnectionErrorException

Method Detail

setCredit

public void setCredit(UnsignedInteger credit,
             boolean window)

getAddress

public String getAddress()

getFilter

public Map getFilter()

receive

public Message receive()

receive

public Message receive(boolean wait)

receive

public Message receive(long wait)

release

public void release(Message m)

release

public void release(Binary deliveryTag)

modified

public void modified(Binary tag)

acknowledge

public void acknowledge(Message m)

acknowledge

public void acknowledge(Message m,
               Receiver.SettledAction a)

acknowledge

public void acknowledge(Message m,
               Transaction txn)

acknowledge

public void acknowledge(Binary deliveryTag)

acknowledge

public void acknowledge(Binary deliveryTag,
               Receiver.SettledAction a)

acknowledge

public void acknowledge(Binary deliveryTag,
               Transaction txn)

acknowledge

public void acknowledge(Binary deliveryTag,
               Transaction txn,
               Receiver.SettledAction action)

update

public void update(Outcome outcome,
          Binary deliveryTag,
          Transaction txn,
          Receiver.SettledAction action)

getError

public Error getError()

acknowledgeAll

public void acknowledgeAll(Message m)

acknowledgeAll

public void acknowledgeAll(Binary deliveryTag)

acknowledgeAll

public void acknowledgeAll(Binary deliveryTag,
                  Transaction txn,
                  Receiver.SettledAction action)

updateAll

public void updateAll(Outcome outcome,
             Binary deliveryTag)

updateAll

public void updateAll(Outcome outcome,
             Binary deliveryTag,
             Transaction txn,
             Receiver.SettledAction action)

close

public void close()

detach

public void detach()

drain

public void drain()

drainWait

public boolean drainWait()

Waits for the receiver to drain or a message to be available to be received.

Returns:

true if the receiver has been drained.

clearDrain

public void clearDrain()

Clears the receiver drain so that message delivery can resume.

setCreditWithTransaction

public void setCreditWithTransaction(UnsignedInteger credit,
                            Transaction txn)

handle

public void handle(Binary deliveryTag,
          DeliveryState state,
          Boolean settled)

Specified by:

handle in interface DeliveryStateHandler

getRemoteUnsettled

public Map<Binary,Outcome> getRemoteUnsettled()

setMessageArrivalListener

public void setMessageArrivalListener(Receiver.MessageArrivalListener messageArrivalListener)

getSession

public Session getSession()

getSource

public Source getSource()

setRemoteErrorListener

public void setRemoteErrorListener(Runnable listener)