Package org.apache.qpid.protonj2.engine.impl

Class ProtonSender

java.lang.Object

org.apache.qpid.protonj2.engine.impl.ProtonEndpoint<L>

org.apache.qpid.protonj2.engine.impl.ProtonLink<Sender>

org.apache.qpid.protonj2.engine.impl.ProtonSender

All Implemented Interfaces:

Endpoint<Sender>, Link<Sender>, Sender

public class ProtonSender
extends ProtonLink<Sender>
implements Sender

Proton Sender link implementation.

Field Summary

Fields inherited from class org.apache.qpid.protonj2.engine.impl.ProtonLink

connection, localAttach, remoteAttach, session

Fields inherited from class org.apache.qpid.protonj2.engine.impl.ProtonEndpoint

engine

Constructor Summary

Constructors

Constructor	Description
ProtonSender(ProtonSession session, java.lang.String name)	Create a new Sender instance with the given Session parent.

Method Summary

Modifier and Type	Method	Description
Sender	creditStateUpdateHandler(EventHandler<Sender> handler)	Handler for link credit updates that occur after a remote Flow arrives.
OutgoingDelivery	current()	Gets the current OutgoingDelivery for this Sender if one is available.
protected ProtonSender	decorateOutgoingFlow(Flow flow)
Sender	deliveryStateUpdatedHandler(EventHandler<OutgoingDelivery> handler)	Handler for updates for deliveries that have previously been sent.
Sender	disposition(java.util.function.Predicate<OutgoingDelivery> filter, DeliveryState state, boolean settle)	For each unsettled outgoing delivery that is pending in the Sender apply the given predicate and if it matches then apply the given delivery state and settled value to it.
Sender	drained()	Called when the Receiver has requested a drain of credit and the sender has sent all available messages.
int	getCredit()	Get the credit that is currently available or assigned to this link.
DeliveryTagGenerator	getDeliveryTagGenerator()
Role	getRole()
protected ProtonSender	handleRemoteAttach(Attach attach)
protected ProtonSender	handleRemoteDetach(Detach detach)
protected ProtonSender	handleRemoteDisposition(Disposition disposition, ProtonIncomingDelivery delivery)
protected ProtonSender	handleRemoteDisposition(Disposition disposition, ProtonOutgoingDelivery delivery)
protected ProtonSender	handleRemoteFlow(Flow flow)
protected ProtonIncomingDelivery	handleRemoteTransfer(Transfer transfer, ProtonBuffer payload)
boolean	hasUnsettled()
boolean	isDraining()	Indicates if the link is draining.
boolean	isSendable()	Checks if the sender has credit and the session window allows for any bytes to be written currently.
OutgoingDelivery	next()	When there has been no deliveries so far or the current delivery has reached a complete state this method updates the current delivery to a new instance and returns that value.
protected ProtonSender	self()
Sender	setDeliveryTagGenerator(DeliveryTagGenerator generator)	Configures a DeliveryTagGenerator that will be used to create and set a DeliveryTag value on each new OutgoingDelivery that is created and returned from the Sender.next() method.
Sender	settle(java.util.function.Predicate<OutgoingDelivery> filter)	For each unsettled outgoing delivery that is pending in the Sender apply the given predicate and if it matches then settle the delivery.
protected void	transitionedToLocallyClosed()
protected void	transitionedToLocallyDetached()
protected void	transitionedToLocallyOpened()
protected void	transitionToParentLocallyClosed()
protected void	transitionToParentRemotelyClosed()
protected void	transitionToRemotelyClosed()
protected void	transitionToRemotelyDetached()
java.util.Collection<OutgoingDelivery>	unsettled()	Retrieves the list of unsettled deliveries sent from this Sender.

Methods inherited from class org.apache.qpid.protonj2.engine.impl.ProtonLink

areDeliveriesStillActive, checkLinkOperable, checkNotClosed, checkNotOpened, close, detach, detachHandler, getConnection, getDesiredCapabilities, getMaxMessageSize, getName, getOfferedCapabilities, getParent, getProperties, getReceiverSettleMode, getRemoteDesiredCapabilities, getRemoteMaxMessageSize, getRemoteOfferedCapabilities, getRemoteProperties, getRemoteReceiverSettleMode, getRemoteSenderSettleMode, getRemoteSource, getRemoteState, getRemoteTarget, getSenderSettleMode, getSession, getSource, getState, getTarget, isLocallyClosed, isLocallyClosedOrDetached, isLocallyDetached, isLocallyOpen, isReceiver, isRemotelyClosed, isRemotelyClosedOrDetached, isRemotelyDetached, isRemotelyOpen, isSender, localDetachHandler, open, parentEndpointClosedHandler, setDesiredCapabilities, setMaxMessageSize, setOfferedCapabilities, setProperties, setReceiverSettleMode, setSenderSettleMode, setSource, setTarget, setTarget, transitionToRemotelyOpenedState

Methods inherited from class org.apache.qpid.protonj2.engine.impl.ProtonEndpoint

closeHandler, engineShutdownHandler, getAttachments, getCondition, getEngine, getLinkedResource, getLinkedResource, getRemoteCondition, localCloseHandler, localOpenHandler, openHandler, setCondition, setLinkedResource

Methods inherited from class java.lang.Object

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

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

close, closeHandler, engineShutdownHandler, getAttachments, getCondition, getDesiredCapabilities, getEngine, getLinkedResource, getLinkedResource, getOfferedCapabilities, getProperties, getRemoteCondition, getRemoteDesiredCapabilities, getRemoteOfferedCapabilities, getRemoteProperties, isLocallyClosed, isLocallyOpen, localCloseHandler, localOpenHandler, open, openHandler, setCondition, setDesiredCapabilities, setLinkedResource, setOfferedCapabilities, setProperties

Methods inherited from interface org.apache.qpid.protonj2.engine.Link

detach, detachHandler, getConnection, getMaxMessageSize, getName, getParent, getReceiverSettleMode, getRemoteMaxMessageSize, getRemoteReceiverSettleMode, getRemoteSenderSettleMode, getRemoteSource, getRemoteState, getRemoteTarget, getSenderSettleMode, getSession, getSource, getState, getTarget, isLocallyClosedOrDetached, isLocallyDetached, isReceiver, isRemotelyClosed, isRemotelyClosedOrDetached, isRemotelyDetached, isRemotelyOpen, isSender, localDetachHandler, parentEndpointClosedHandler, setMaxMessageSize, setReceiverSettleMode, setSenderSettleMode, setSource, setTarget, setTarget

Constructor Detail

ProtonSender

public ProtonSender(ProtonSession session,
                    java.lang.String name)

Create a new Sender instance with the given Session parent.

Parameters:

session - The Session that is linked to this sender instance.

name - The name assigned to this Sender link.

Method Detail

getRole

public Role getRole()

Specified by:

getRole in interface Link<Sender>

Returns:

the Role that this end of the link is performing.

self

protected ProtonSender self()

Specified by:

self in class ProtonLink<Sender>

getCredit

public int getCredit()

Description copied from interface: Link

Get the credit that is currently available or assigned to this link.

Specified by:

getCredit in interface Link<Sender>

Returns:

the current link credit.

isSendable

public boolean isSendable()

Description copied from interface: Sender

Checks if the sender has credit and the session window allows for any bytes to be written currently.

Specified by:

isSendable in interface Sender

Returns:

true if the link has credit and the session window allows for any bytes to be written.

isDraining

public boolean isDraining()

Description copied from interface: Link

Indicates if the link is draining. For a Sender link this indicates that the remote has requested that the Sender transmit deliveries up to the currently available credit or indicate that it has no more to send. For a Receiver this indicates that the Receiver has requested that the Sender consume its outstanding credit.

Specified by:

isDraining in interface Link<Sender>

Returns:

true if the Link is currently marked as draining.

drained

public Sender drained()

Description copied from interface: Sender

Called when the Receiver has requested a drain of credit and the sender has sent all available messages.

Specified by:

drained in interface Sender

Returns:

this Sender instance.

disposition

public Sender disposition(java.util.function.Predicate<OutgoingDelivery> filter,
                          DeliveryState state,
                          boolean settle)

Description copied from interface: Sender

For each unsettled outgoing delivery that is pending in the Sender apply the given predicate and if it matches then apply the given delivery state and settled value to it.

Specified by:

disposition in interface Sender

Parameters:

filter - The predicate to apply to each unsettled delivery to test for a match.

state - The new DeliveryState to apply to any matching outgoing deliveries.

settle - Boolean indicating if the matching unsettled deliveries should be settled.

Returns:

this Sender instance.

settle

public Sender settle(java.util.function.Predicate<OutgoingDelivery> filter)

Description copied from interface: Sender

For each unsettled outgoing delivery that is pending in the Sender apply the given predicate and if it matches then settle the delivery.

Specified by:

settle in interface Sender

Parameters:

filter - The predicate to apply to each unsettled delivery to test for a match.

Returns:

this Sender instance.

current

public OutgoingDelivery current()

Description copied from interface: Sender

Gets the current OutgoingDelivery for this Sender if one is available.

The sender only tracks a current delivery in the case that the next method has bee called and if any bytes are written to the delivery using the streaming based API OutgoingDelivery.streamBytes(ProtonBuffer) which allows for later writing of additional bytes to the delivery. Once the method OutgoingDelivery.writeBytes(ProtonBuffer) is called the final Transfer is written indicating that the delivery is complete and the current delivery value is reset. An outgoing delivery that is being streamed may also be completed by calling the OutgoingDelivery.abort() method.

Specified by:

current in interface Sender

Returns:

the current active outgoing delivery or null if there is no current delivery.

next

public OutgoingDelivery next()

Description copied from interface: Sender

When there has been no deliveries so far or the current delivery has reached a complete state this method updates the current delivery to a new instance and returns that value. If the current OutgoingDelivery has not been completed by either calling the OutgoingDelivery.writeBytes(ProtonBuffer) or the OutgoingDelivery.abort() method then this method will throw an exception to indicate the sender state cannot allow a new delivery to be started.

Specified by:

next in interface Sender

Returns:

a new delivery instance unless the current delivery is not complete.

unsettled

public java.util.Collection<OutgoingDelivery> unsettled()

Description copied from interface: Sender

Retrieves the list of unsettled deliveries sent from this Sender. The deliveries in the Collection cannot be written to but can have their settled state and disposition updated. Only when this Sender settles on its end are the OutgoingDelivery instances removed from the unsettled Collection. The Collection returned from this method is a copy of the internally maintained data and is not modifiable. The caller should use this method judiciously to avoid excess GC overhead.

Specified by:

unsettled in interface Sender

Returns:

a collection of unsettled deliveries or an empty collection if no pending deliveries are outstanding.

hasUnsettled

public boolean hasUnsettled()

Specified by:

hasUnsettled in interface Sender

Returns:

true if there are unsettled deliveries for this Sender link.

setDeliveryTagGenerator

public Sender setDeliveryTagGenerator(DeliveryTagGenerator generator)

Description copied from interface: Sender

Configures a DeliveryTagGenerator that will be used to create and set a DeliveryTag value on each new OutgoingDelivery that is created and returned from the Sender.next() method.

Specified by:

setDeliveryTagGenerator in interface Sender

Parameters:

generator - The DeliveryTagGenerator to use to create automatic DeliveryTag values.

Returns:

this Sender instance.

getDeliveryTagGenerator

public DeliveryTagGenerator getDeliveryTagGenerator()

Specified by:

getDeliveryTagGenerator in interface Sender

Returns:

the currently configured DeliveryTagGenerator for this Sender.

handleRemoteAttach

protected final ProtonSender handleRemoteAttach(Attach attach)

Specified by:

handleRemoteAttach in class ProtonLink<Sender>

handleRemoteDetach

protected final ProtonSender handleRemoteDetach(Detach detach)

Specified by:

handleRemoteDetach in class ProtonLink<Sender>

handleRemoteDisposition

protected final ProtonSender handleRemoteDisposition(Disposition disposition,
                                                     ProtonIncomingDelivery delivery)

Specified by:

handleRemoteDisposition in class ProtonLink<Sender>

handleRemoteDisposition

protected final ProtonSender handleRemoteDisposition(Disposition disposition,
                                                     ProtonOutgoingDelivery delivery)

Specified by:

handleRemoteDisposition in class ProtonLink<Sender>

handleRemoteTransfer

protected final ProtonIncomingDelivery handleRemoteTransfer(Transfer transfer,
                                                            ProtonBuffer payload)

Specified by:

handleRemoteTransfer in class ProtonLink<Sender>

handleRemoteFlow

protected final ProtonSender handleRemoteFlow(Flow flow)

Specified by:

handleRemoteFlow in class ProtonLink<Sender>

decorateOutgoingFlow

protected final ProtonSender decorateOutgoingFlow(Flow flow)

Specified by:

decorateOutgoingFlow in class ProtonLink<Sender>

creditStateUpdateHandler

public Sender creditStateUpdateHandler(EventHandler<Sender> handler)

Description copied from interface: Link

Handler for link credit updates that occur after a remote Flow arrives.

Specified by:

creditStateUpdateHandler in interface Link<Sender>

Parameters:

handler - An event handler that will be signaled when the link credit is updated by a remote flow.

Returns:

the Link for chaining.

deliveryStateUpdatedHandler

public Sender deliveryStateUpdatedHandler(EventHandler<OutgoingDelivery> handler)

Description copied from interface: Sender

Handler for updates for deliveries that have previously been sent. Updates can happen when the remote settles or otherwise modifies the delivery and the user needs to act on those changes.

Specified by:

deliveryStateUpdatedHandler in interface Sender

Parameters:

handler - The handler that will be invoked when a new update delivery arrives on this link.

Returns:

this Sender instance.

transitionedToLocallyOpened

protected void transitionedToLocallyOpened()

Overrides:

transitionedToLocallyOpened in class ProtonLink<Sender>

transitionedToLocallyDetached

protected void transitionedToLocallyDetached()

Overrides:

transitionedToLocallyDetached in class ProtonLink<Sender>

transitionedToLocallyClosed

protected void transitionedToLocallyClosed()

Overrides:

transitionedToLocallyClosed in class ProtonLink<Sender>

transitionToRemotelyDetached

protected void transitionToRemotelyDetached()

Overrides:

transitionToRemotelyDetached in class ProtonLink<Sender>

transitionToRemotelyClosed

protected void transitionToRemotelyClosed()

Overrides:

transitionToRemotelyClosed in class ProtonLink<Sender>

transitionToParentLocallyClosed

protected void transitionToParentLocallyClosed()

Overrides:

transitionToParentLocallyClosed in class ProtonLink<Sender>

transitionToParentRemotelyClosed

protected void transitionToParentRemotelyClosed()

Overrides:

transitionToParentRemotelyClosed in class ProtonLink<Sender>