public interface Link extends Endpoint
SenderSettleMode.MIXED
.
Receiver settle mode - ReceiverSettleMode.FIRST
TODO describe the application's responsibility to honour settlement.Modifier and Type | Method and Description |
---|---|
boolean |
advance()
Attempts to advance the current delivery.
|
Delivery |
current()
Returns the current delivery
|
Delivery |
delivery(byte[] tag)
Create a delivery object based on the specified tag and adds it to the
this link's delivery list and its connection work list.
|
Delivery |
delivery(byte[] tag,
int offset,
int length)
Create a delivery object based on the specified tag.
|
void |
detach() |
boolean |
detached() |
int |
drained() |
int |
getCredit() |
boolean |
getDrain() |
String |
getName()
Returns the name of the link
|
Map<Symbol,Object> |
getProperties()
Gets the local link properties.
|
int |
getQueued() |
ReceiverSettleMode |
getReceiverSettleMode() |
int |
getRemoteCredit() |
Map<Symbol,Object> |
getRemoteProperties()
Gets the remote link properties, as conveyed from the peer via the Attach frame
when attaching the link to the session.
|
ReceiverSettleMode |
getRemoteReceiverSettleMode() |
SenderSettleMode |
getRemoteSenderSettleMode() |
Source |
getRemoteSource() |
Target |
getRemoteTarget() |
SenderSettleMode |
getSenderSettleMode() |
Session |
getSession() |
Source |
getSource() |
Target |
getTarget() |
int |
getUnsettled() |
Delivery |
head()
Returns the head delivery on the link.
|
Link |
next(EnumSet<EndpointState> local,
EnumSet<EndpointState> remote) |
void |
setProperties(Map<Symbol,Object> properties)
Sets the local link properties, to be conveyed to the peer via the Attach frame when
attaching the link to the session.
|
void |
setReceiverSettleMode(ReceiverSettleMode receiverSettleMode)
Sets the receiver settle mode.
|
void |
setRemoteSenderSettleMode(SenderSettleMode remoteSenderSettleMode)
Deprecated.
|
void |
setSenderSettleMode(SenderSettleMode senderSettleMode)
Sets the sender settle mode.
|
void |
setSource(Source address)
Sets the source for this link.
|
void |
setTarget(Target address)
Expected to be used in a similar manner to
setSource(Source) |
close, free, getCondition, getContext, getLocalState, getRemoteCondition, getRemoteState, open, setCondition, setContext
attachments
String getName()
Delivery delivery(byte[] tag)
Connection.getWorkHead()
.tag
- a tag for the deliveryDelivery delivery(byte[] tag, int offset, int length)
tag
- a tag for the deliveryoffset
- (currently ignored and must be 0)length
- (currently ignored and must be the length of the tag
arrayDelivery head()
Delivery current()
boolean advance()
Source getSource()
Target getTarget()
void setSource(Source address)
getRemoteSource()
to determine an actual Source. If it
failed to determine an actual source, it should set null, and then go on to Endpoint.close()
the link.void setTarget(Target address)
setSource(Source)
Source getRemoteSource()
setSource(Source)
Target getRemoteTarget()
setTarget(Target)
Link next(EnumSet<EndpointState> local, EnumSet<EndpointState> remote)
int getCredit()
int getQueued()
int getUnsettled()
Session getSession()
SenderSettleMode getSenderSettleMode()
void setSenderSettleMode(SenderSettleMode senderSettleMode)
Endpoint.open()
.
If this endpoint is the initiator of the link, this method can be used to set a value other than
the default.
If this endpoint is not the initiator, this method should be used to set a local value. According
to the AMQP spec, the application may choose to accept the sender's suggestion
(accessed by calling getRemoteSenderSettleMode()
) or choose another value. The value
has no effect on Proton, but may be useful to the application at a later point.
In order to be AMQP compliant the application is responsible for honouring the settlement mode. See Link
.SenderSettleMode getRemoteSenderSettleMode()
setSenderSettleMode(SenderSettleMode)
ReceiverSettleMode getReceiverSettleMode()
void setReceiverSettleMode(ReceiverSettleMode receiverSettleMode)
setSenderSettleMode(SenderSettleMode)
ReceiverSettleMode getRemoteReceiverSettleMode()
@Deprecated void setRemoteSenderSettleMode(SenderSettleMode remoteSenderSettleMode)
Map<Symbol,Object> getProperties()
setProperties(Map)
void setProperties(Map<Symbol,Object> properties)
Endpoint.open()
method.Map<Symbol,Object> getRemoteProperties()
int drained()
int getRemoteCredit()
boolean getDrain()
void detach()
boolean detached()
Copyright © 2016 The Apache Software Foundation. All rights reserved.