Package org.apache.qpid.proton.engine.impl

Class SenderImpl

java.lang.Object

org.apache.qpid.proton.engine.impl.EndpointImpl

org.apache.qpid.proton.engine.impl.LinkImpl

org.apache.qpid.proton.engine.impl.SenderImpl

All Implemented Interfaces:

Endpoint, Extendable, Link, ProtonJEndpoint, Sender

public class SenderImpl
extends LinkImpl
implements Sender

Method Summary

Modifier and Type	Method	Description
void	abort()	Abort the current delivery.
boolean	advance()	Attempts to advance the current delivery.
int	getRemoteCredit()	Returns a [locally generated] view of credit at the remote peer by considering the current link credit count as well as the effect of any locally queued messages.
void	offer(int credits)	indicates pending deliveries
int	send(byte[] bytes, int offset, int length)	Sends some data for the current delivery.
int	send(ReadableBuffer buffer)	Sends some data for the current delivery.
int	sendNoCopy(ReadableBuffer buffer)	Sends data to the current delivery attempting not to copy the data unless a previous send has already added data to the Delivery in which case a copy may occur depending on the implementation.
void	setCredit(int credit)

Methods inherited from class org.apache.qpid.proton.engine.impl.LinkImpl

addCredit, current, delivery, delivery, detach, detached, drained, getConnectionImpl, getCredit, getDesiredCapabilities, getDrain, getMaxMessageSize, getName, getOfferedCapabilities, getProperties, getQueued, getReceiverSettleMode, getRemoteDesiredCapabilities, getRemoteMaxMessageSize, getRemoteOfferedCapabilities, getRemoteProperties, getRemoteReceiverSettleMode, getRemoteSenderSettleMode, getRemoteSource, getRemoteTarget, getSenderSettleMode, getSession, getSource, getTarget, getUnsettled, head, next, setDesiredCapabilities, setMaxMessageSize, setOfferedCapabilities, setProperties, setReceiverSettleMode, setRemoteSenderSettleMode, setSenderSettleMode, setSource, setTarget

Methods inherited from class org.apache.qpid.proton.engine.impl.EndpointImpl

attachments, close, free, getCondition, getContext, getLocalState, getRemoteCondition, getRemoteState, open, setCondition, setContext

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.proton.engine.Endpoint

close, free, getCondition, getContext, getLocalState, getRemoteCondition, getRemoteState, open, setCondition, setContext

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

attachments

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

current, delivery, delivery, detach, detached, drained, getCredit, getDesiredCapabilities, getDrain, getMaxMessageSize, getName, getOfferedCapabilities, getProperties, getQueued, getReceiverSettleMode, getRemoteDesiredCapabilities, getRemoteMaxMessageSize, getRemoteOfferedCapabilities, getRemoteProperties, getRemoteReceiverSettleMode, getRemoteSenderSettleMode, getRemoteSource, getRemoteTarget, getSenderSettleMode, getSession, getSource, getTarget, getUnsettled, head, next, setDesiredCapabilities, setMaxMessageSize, setOfferedCapabilities, setProperties, setReceiverSettleMode, setRemoteSenderSettleMode, setSenderSettleMode, setSource, setTarget

Method Detail

offer

public void offer(int credits)

Description copied from interface: Sender

indicates pending deliveries

Specified by:

offer in interface Sender

Parameters:

credits - the number of pending deliveries

send

public int send(byte[] bytes,
                int offset,
                int length)

Description copied from interface: Sender

Sends some data for the current delivery. The application may call this method multiple times for the same delivery.

Specified by:

send in interface Sender

Parameters:

bytes - the byte array containing the data to be sent.

offset - the offset into the given array to start reading.

length - the number of bytes to read from the given byte array.

Returns:

the number of bytes accepted TODO Proton-j current copies all the bytes it has been given so the return value will always be length. Should this be changed? How does Proton-c behave? What should the application do if the number of bytes accepted is smaller than length.

send

public int send(ReadableBuffer buffer)

Description copied from interface: Sender

Sends some data for the current delivery. The application may call this method multiple times for the same delivery.

Specified by:

send in interface Sender

Parameters:

buffer - the buffer to read the data from.

Returns:

the number of bytes read from the provided buffer.

sendNoCopy

public int sendNoCopy(ReadableBuffer buffer)

Description copied from interface: Sender

Sends data to the current delivery attempting not to copy the data unless a previous send has already added data to the Delivery in which case a copy may occur depending on the implementation.

Care should be taken when passing ReadableBuffer instances that wrapped pooled bytes as the send does not mean the data will be sent immediately when the transport is flushed so the pooled bytes could be held for longer than expected.

Specified by:

sendNoCopy in interface Sender

Parameters:

buffer - An immutable ReadableBuffer that can be held until the next transport flush.

Returns:

the number of bytes read from the provided buffer.

abort

public void abort()

Description copied from interface: Sender

Abort the current delivery. Note "pn_link_abort" is commented out in the .h

Specified by:

abort in interface Sender

advance

public boolean advance()

Description copied from interface: Link

Attempts to advance the current delivery. Advances it to the next delivery if one exists, else null. The behaviour of this method is different for senders and receivers.

Specified by:

advance in interface Link

Specified by:

advance in interface Sender

Overrides:

advance in class LinkImpl

Returns:

true if it can advance, false if it cannot TODO document the meaning of the return value more fully. Currently Senderimpl only returns false if there is no current delivery

See Also:

TODO fully state the rules regarding when you have to call this method, what happens if you don't call it before creating another delivery etc.

setCredit

public void setCredit(int credit)

Overrides:

setCredit in class LinkImpl

getRemoteCredit

public int getRemoteCredit()

Description copied from interface: Link

Returns a [locally generated] view of credit at the remote peer by considering the current link credit count as well as the effect of any locally queued messages.

Specified by:

getRemoteCredit in interface Link

Returns:

view of effective remote credit