org.apache.qpid.proton.engine.impl

Class DeliveryImpl

java.lang.Object

org.apache.qpid.proton.engine.impl.DeliveryImpl

All Implemented Interfaces:

Delivery

public class DeliveryImpl
extends java.lang.Object
implements Delivery

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
void	disposition(DeliveryState state) updates the state of the delivery
void	free() TODO When does an application call this method? Do we really need this?
java.lang.Object	getContext()
LinkImpl	getLink()
DeliveryState	getLocalState()
int	getMessageFormat() TODO is this required??
DeliveryState	getRemoteState()
byte[]	getTag()
DeliveryImpl	getWorkNext()
boolean	isBuffered()
boolean	isPartial()
boolean	isReadable() Returns whether this delivery has data ready to be received.
boolean	isSettled() Returns whether this delivery has been settled.
boolean	isUpdated() Returns whether this delivery's state or settled flag has ever remotely changed.
boolean	isWritable()
DeliveryImpl	next()
int	pending()
boolean	remotelySettled()
void	setContext(java.lang.Object context)
void	setDataOffset(int arrayOffset)
void	settle() Settles this delivery.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getTag

public byte[] getTag()

Specified by:

getTag in interface Delivery

getLink

public LinkImpl getLink()

Specified by:

getLink in interface Delivery

getLocalState

public DeliveryState getLocalState()

Specified by:

getLocalState in interface Delivery

getRemoteState

public DeliveryState getRemoteState()

Specified by:

getRemoteState in interface Delivery

remotelySettled

public boolean remotelySettled()

Specified by:

remotelySettled in interface Delivery

getMessageFormat

public int getMessageFormat()

Description copied from interface: Delivery

TODO is this required??

Specified by:

getMessageFormat in interface Delivery

disposition

public void disposition(DeliveryState state)

Description copied from interface: Delivery

updates the state of the delivery

Specified by:

disposition in interface Delivery

Parameters:

state - the new delivery state

settle

public void settle()

Description copied from interface: Delivery

Settles this delivery. Causes the delivery to be removed from the connection's work list (see Connection.getWorkHead()). If this delivery is its link's current delivery, the link's current delivery pointer is advanced.

Specified by:

settle in interface Delivery

next

public DeliveryImpl next()

Specified by:

next in interface Delivery

free

public void free()

Description copied from interface: Delivery

TODO When does an application call this method? Do we really need this?

Specified by:

free in interface Delivery

getWorkNext

public DeliveryImpl getWorkNext()

Specified by:

getWorkNext in interface Delivery

See Also:

Connection.getWorkHead()

isSettled

public boolean isSettled()

Description copied from interface: Delivery

Returns whether this delivery has been settled. TODO proton-j and proton-c return the local and remote statuses respectively. Resolve this ambiguity.

Specified by:

isSettled in interface Delivery

See Also:

Delivery.settle()

setDataOffset

public void setDataOffset(int arrayOffset)

isWritable

public boolean isWritable()

Specified by:

isWritable in interface Delivery

isReadable

public boolean isReadable()

Description copied from interface: Delivery

Returns whether this delivery has data ready to be received.

Specified by:

isReadable in interface Delivery

See Also:

Receiver.recv(byte[], int, int)

isPartial

public boolean isPartial()

Specified by:

isPartial in interface Delivery

isUpdated

public boolean isUpdated()

Description copied from interface: Delivery

Returns whether this delivery's state or settled flag has ever remotely changed. TODO what is the main intended use case for calling this method?

Specified by:

isUpdated in interface Delivery

clear

public void clear()

Specified by:

clear in interface Delivery

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Delivery

getContext

public java.lang.Object getContext()

Specified by:

getContext in interface Delivery

setContext

public void setContext(java.lang.Object context)

Specified by:

setContext in interface Delivery

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

pending

public int pending()

Specified by:

pending in interface Delivery