org.apache.qpid.proton.engine
Interface Link

All Superinterfaces:

Endpoint

All Known Subinterfaces:

Receiver, Sender

public interface Link
extends Endpoint

Link

Method Summary

boolean	advance() Attempts to advance the current delivery
Delivery	current()
Delivery	delivery(byte[] tag) Create a delivery object based on the specified tag.
Delivery	delivery(byte[] tag, int offset, int length) Create a delivery object based on the specified tag.
int	getCredit()
String	getName() Returns the name of the link
int	getQueued()
ReceiverSettleMode	getReceiverSettleMode()
ReceiverSettleMode	getRemoteReceiverSettleMode()
SenderSettleMode	getRemoteSenderSettleMode()
Source	getRemoteSource()
Target	getRemoteTarget()
SenderSettleMode	getSenderSettleMode()
Session	getSession()
Source	getSource()
Target	getTarget()
int	getUnsettled()
Link	next(EnumSet<EndpointState> local, EnumSet<EndpointState> remote)
void	setReceiverSettleMode(ReceiverSettleMode receiverSettleMode)
void	setRemoteSenderSettleMode(SenderSettleMode remoteSenderSettleMode)
void	setSenderSettleMode(SenderSettleMode senderSettleMode)
void	setSource(Source address)
void	setTarget(Target address)
Iterator<Delivery>	unsettled()

Methods inherited from interface org.apache.qpid.proton.engine.Endpoint

close, free, getContext, getLocalError, getLocalState, getRemoteError, getRemoteState, open, setContext

Method Detail

getName

String getName()

Returns the name of the link

Returns:

the link name

delivery

Delivery delivery(byte[] tag)

Create a delivery object based on the specified tag.

Parameters:

tag - a tag for the delivery

Returns:

a Delivery object

delivery

Delivery delivery(byte[] tag,
                  int offset,
                  int length)

Create a delivery object based on the specified tag. This form of the method is intended to allow the tag to be formed from a subsequence of the byte array passed in. This might allow more optimsation options in future but at present is not implemented.

Parameters:

tag - a tag for the delivery

offset - (currently ignored and must be 0)

length - (currently ignored and must be the length of the tag array

Returns:

a Delivery object

unsettled

Iterator<Delivery> unsettled()

Returns:

the unsettled deliveries for this link

current

Delivery current()

Returns:

return the current delivery

advance

boolean advance()

Attempts to advance the current delivery

Returns:

true if it can advance, false if it cannot

getSource

Source getSource()

getTarget

Target getTarget()

setSource

void setSource(Source address)

setTarget

void setTarget(Target address)

getRemoteSource

Source getRemoteSource()

getRemoteTarget

Target getRemoteTarget()

next

Link next(EnumSet<EndpointState> local,
          EnumSet<EndpointState> remote)

getCredit

int getCredit()

getQueued

int getQueued()

getUnsettled

int getUnsettled()

getSession

Session getSession()

getSenderSettleMode

SenderSettleMode getSenderSettleMode()

setSenderSettleMode

void setSenderSettleMode(SenderSettleMode senderSettleMode)

getRemoteSenderSettleMode

SenderSettleMode getRemoteSenderSettleMode()

setRemoteSenderSettleMode

void setRemoteSenderSettleMode(SenderSettleMode remoteSenderSettleMode)

getReceiverSettleMode

ReceiverSettleMode getReceiverSettleMode()

setReceiverSettleMode

void setReceiverSettleMode(ReceiverSettleMode receiverSettleMode)

getRemoteReceiverSettleMode

ReceiverSettleMode getRemoteReceiverSettleMode()