io.vertx.proton.impl

Class ProtonReceiverImpl

java.lang.Object

io.vertx.proton.impl.ProtonReceiverImpl

All Implemented Interfaces:

ProtonLink<ProtonReceiver>, ProtonReceiver

public class ProtonReceiverImpl
extends Object
implements ProtonReceiver

Author:

Hiram Chirino

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.qpid.proton.engine.Link	link

Method Summary

Modifier and Type	Method and Description
boolean	advance()
org.apache.qpid.proton.engine.Record	attachments() Retrieves the attachments record, upon which application items can be set/retrieved.
T	close() Closes the AMQP link, i.e.
T	closeHandler(Handler<AsyncResult<T>> closeHandler) Sets a handler for when an AMQP Detach frame with closed=true is received from the remote peer.
org.apache.qpid.proton.engine.Delivery	current()
org.apache.qpid.proton.engine.Delivery	delivery(byte[] tag)
org.apache.qpid.proton.engine.Delivery	delivery(byte[] tag, int offset, int length)
T	detach() Detaches the AMQP link, i.e.
boolean	detached()
T	detachHandler(Handler<AsyncResult<T>> detachHandler) Sets a handler for when an AMQP Detach frame with closed=false is received from the remote peer.
ProtonReceiver	drain(long timeout, Handler<AsyncResult<Void>> completionHandler) Initiates a 'drain' of link credit from the remote sender.
int	drained()
boolean	draining()
ProtonReceiver	flow(int credits) Grants the given number of message credits to the sender.
void	free() Tidies up related link resources when complete with use.
org.apache.qpid.proton.amqp.transport.ErrorCondition	getCondition() Gets the local ErrorCondition object.
int	getCredit() Retrieves the current amount of credit.
boolean	getDrain() Retrieves the current value of link 'drain' flag.
org.apache.qpid.proton.engine.EndpointState	getLocalState()
org.apache.qpid.proton.amqp.UnsignedLong	getMaxMessageSize() Gets the local link max message size.
String	getName() Retrieves the link name
int	getPrefetch() Get the current prefetch value.
ProtonQoS	getQoS() Gets the local QOS config.
int	getQueued() Retrieves the current number of queued messages.
String	getRemoteAddress() Retrieves the remote address from the remote terminus (source for receivers, target for senders).
org.apache.qpid.proton.amqp.transport.ErrorCondition	getRemoteCondition() Gets the remote ErrorCondition object.
int	getRemoteCredit()
org.apache.qpid.proton.amqp.Symbol[]	getRemoteDesiredCapabilities() Gets the remote desired capabilities, as conveyed from the peer via the Attach frame when attaching the link to the session.
org.apache.qpid.proton.amqp.UnsignedLong	getRemoteMaxMessageSize() Gets the remote link max message size, as conveyed from the peer via the Attach frame when attaching the link to the session.
org.apache.qpid.proton.amqp.Symbol[]	getRemoteOfferedCapabilities() Gets the remote offered capabilities, as conveyed from the peer via the Attach frame when attaching the link to the session.
Map<org.apache.qpid.proton.amqp.Symbol,Object>	getRemoteProperties() Gets the remote link properties, as conveyed from the peer via the Attach frame when attaching the link to the session.
ProtonQoS	getRemoteQoS() Gets the remote QOS config.
org.apache.qpid.proton.amqp.transport.Source	getRemoteSource() Gets the current remote source config.
org.apache.qpid.proton.engine.EndpointState	getRemoteState()
org.apache.qpid.proton.amqp.transport.Target	getRemoteTarget() Gets the current remote target config.
ProtonSessionImpl	getSession() Gets the session this link is on.
org.apache.qpid.proton.amqp.transport.Source	getSource() Gets the current local source config.
org.apache.qpid.proton.amqp.transport.Target	getTarget() Gets the current local target config.
int	getUnsettled()
ProtonReceiver	handler(ProtonMessageHandler handler) Sets the handler to process messages as they arrive.
boolean	isAutoAccept() Get whether the receiver is auto accepting.
boolean	isOpen() Check whether the link is locally open.
ProtonReceiver	maxMessageSizeExceededHandler(Handler<ProtonReceiver> handler) Sets a handler to execute when an incoming delivery has exceeded the receivers max-message-size, if one was configured.
ProtonReceiver	open() Opens the AMQP link, i.e.
T	openHandler(Handler<AsyncResult<T>> openHandler) Sets a handler for when an AMQP Attach frame is received from the remote peer.
int	recv(byte[] bytes, int offset, int size)
protected ProtonReceiverImpl	self()
ProtonReceiver	setAutoAccept(boolean autoAccept) Sets whether received deliveries should be automatically accepted (and settled) after the message handler runs for them, if no other disposition has been applied during handling.
T	setCondition(org.apache.qpid.proton.amqp.transport.ErrorCondition condition) Sets the local ErrorCondition object.
void	setDesiredCapabilities(org.apache.qpid.proton.amqp.Symbol[] capabilities) Sets the desired capabilities, to be conveyed to the peer via the Attach frame when attaching the link to the session.
ProtonReceiver	setDrain(boolean drain)
void	setMaxMessageSize(org.apache.qpid.proton.amqp.UnsignedLong maxMessageSize) Sets the local link max message size, to be conveyed to the peer via the Attach frame when attaching the link to the session.
void	setOfferedCapabilities(org.apache.qpid.proton.amqp.Symbol[] capabilities) Sets the offered capabilities, to be conveyed to the peer via the Attach frame when attaching the link to the session.
ProtonReceiver	setPrefetch(int messages) Sets the number of message credits the receiver grants and replenishes automatically as messages are delivered.
void	setProperties(Map<org.apache.qpid.proton.amqp.Symbol,Object> properties) Sets the link properties, to be conveyed to the peer via the Attach frame when attaching the link to the session.
T	setQoS(ProtonQoS qos) Sets the local QOS config.
T	setSource(org.apache.qpid.proton.amqp.transport.Source source) Sets the current local source config.
T	setTarget(org.apache.qpid.proton.amqp.transport.Target target) Sets the current local target config.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.proton.ProtonLink

attachments, close, closeHandler, detach, detachHandler, free, getCondition, getCredit, getDrain, getMaxMessageSize, getName, getQoS, getQueued, getRemoteCondition, getRemoteDesiredCapabilities, getRemoteMaxMessageSize, getRemoteOfferedCapabilities, getRemoteProperties, getRemoteQoS, getRemoteSource, getRemoteTarget, getSession, getSource, getTarget, isOpen, openHandler, setCondition, setDesiredCapabilities, setMaxMessageSize, setOfferedCapabilities, setProperties, setQoS, setSource, setTarget

Field Detail

link

protected final org.apache.qpid.proton.engine.Link link

Method Detail

self

protected ProtonReceiverImpl self()

recv

public int recv(byte[] bytes,
                int offset,
                int size)

getRemoteAddress

public String getRemoteAddress()

Description copied from interface: ProtonLink

Retrieves the remote address from the remote terminus (source for receivers, target for senders). Only useful to call after the link has remotely opened.

Specified by:

getRemoteAddress in interface ProtonLink<ProtonReceiver>

Returns:

the remote address, or null if there was none.

drain

public ProtonReceiver drain(long timeout,
                            Handler<AsyncResult<Void>> completionHandler)

Description copied from interface: ProtonReceiver

Initiates a 'drain' of link credit from the remote sender. The timeout parameter allows scheduling a delay (in milliseconds) after which the handler should be fired with a failure result if the attempt has not yet completed successfully, with a value of 0 equivalent to no-timeout. If a drain attempt fails due to timeout, it is no longer possible to reason about the 'drain' state of the receiver and thus any further attempts to drain it should be avoided. The receiver should typically be closed in such cases. Only available for use when ProtonReceiver.setPrefetch(int) has been used to disable automatic credit handling.

Specified by:

drain in interface ProtonReceiver

Parameters:

timeout - the delay in milliseconds before which the drain attempt should be considered failed, or 0 for no timeout.

completionHandler - handler called when credit hits 0 due to messages arriving, or a 'drain response' flow

Returns:

the receiver

flow

public ProtonReceiver flow(int credits)
                    throws IllegalStateException

Description copied from interface: ProtonReceiver

Grants the given number of message credits to the sender. For use when ProtonReceiver.setPrefetch(int) has been used to disable automatic prefetch credit handling.

Specified by:

flow in interface ProtonReceiver

Parameters:

credits - the credits to flow

Returns:

the receiver

Throws:

IllegalStateException - if prefetch is non-zero, or an existing drain operation is not yet complete

draining

public boolean draining()

setDrain

public ProtonReceiver setDrain(boolean drain)

handler

public ProtonReceiver handler(ProtonMessageHandler handler)

Description copied from interface: ProtonReceiver

Sets the handler to process messages as they arrive. Should be set before opening unless prefetch is disabled and credit is being manually controlled.

Specified by:

handler in interface ProtonReceiver

Parameters:

handler - the handler to process messages

Returns:

the receiver

maxMessageSizeExceededHandler

public ProtonReceiver maxMessageSizeExceededHandler(Handler<ProtonReceiver> handler)

Description copied from interface: ProtonReceiver

Sets a handler to execute when an incoming delivery has exceeded the receivers max-message-size, if one was configured. The handler will be called once the receiver becomes aware of transfer frame(s) arriving for a delivery with accumulated payload exceeding the max-message-size. The delivery payload will be dropped and no further messages delivered. The handler notifies the situation has arisen to allow some reaction and provide awareness of impending subsequent activity, namely the sending peers matching 'response' to the receiver detaching or closing the link. Exceeding an advertised max-message-size is a link-error, resulting in the link being detached or closed with the amqp:link:message-size-exceeded link error. After the handler is executed, if the link has not already been either detached or closed within the handler, then the library will detach it with the amqp:link:message-size-exceeded link error. Whether closed or detached by the handler or after it, note that subsequent behaviour will be the same as if the application called ProtonLink.detach() or ProtonLink.close(), itself normally, i.e the sending peers 'response' is handled as always through use of ProtonLink.detachHandler(Handler) and ProtonLink.closeHandler(Handler).

Specified by:

maxMessageSizeExceededHandler in interface ProtonReceiver

Parameters:

handler - the handler to be notified of max-message-size being exceeded

Returns:

the receiver

isAutoAccept

public boolean isAutoAccept()

Description copied from interface: ProtonReceiver

Get whether the receiver is auto accepting.

Specified by:

isAutoAccept in interface ProtonReceiver

Returns:

whether deliveries are being auto accepted after handling if no disposition was applied

See Also:

ProtonReceiver.setAutoAccept(boolean)

setAutoAccept

public ProtonReceiver setAutoAccept(boolean autoAccept)

Description copied from interface: ProtonReceiver

Sets whether received deliveries should be automatically accepted (and settled) after the message handler runs for them, if no other disposition has been applied during handling. True by default.

Specified by:

setAutoAccept in interface ProtonReceiver

Parameters:

autoAccept - whether deliveries should be auto accepted after handling if no disposition was applied

Returns:

the receiver

setPrefetch

public ProtonReceiver setPrefetch(int messages)

Description copied from interface: ProtonReceiver

Sets the number of message credits the receiver grants and replenishes automatically as messages are delivered. To manage credit manually, you can instead set prefetch to 0 before opening the consumer and then explicitly call ProtonReceiver.flow(int) as needed to manually grant credit.

Specified by:

setPrefetch in interface ProtonReceiver

Parameters:

messages - the message prefetch

Returns:

the receiver

getPrefetch

public int getPrefetch()

Description copied from interface: ProtonReceiver

Get the current prefetch value.

Specified by:

getPrefetch in interface ProtonReceiver

Returns:

the prefetch

See Also:

ProtonReceiver.setPrefetch(int)

open

public ProtonReceiver open()

Description copied from interface: ProtonLink

Opens the AMQP link, i.e. allows the Attach frame to be emitted. Typically used after any additional configuration is performed on the object. For locally initiated links, the ProtonLink.openHandler(Handler) may be used to handle the peer sending their Attach frame.

Specified by:

open in interface ProtonLink<ProtonReceiver>

Returns:

the link

getSession

public ProtonSessionImpl getSession()

Description copied from interface: ProtonLink

Gets the session this link is on.

Specified by:

getSession in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the session

attachments

public org.apache.qpid.proton.engine.Record attachments()

Description copied from interface: ProtonLink

Retrieves the attachments record, upon which application items can be set/retrieved.

Specified by:

attachments in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the attachments

getCondition

public org.apache.qpid.proton.amqp.transport.ErrorCondition getCondition()

Description copied from interface: ProtonLink

Gets the local ErrorCondition object.

Specified by:

getCondition in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the condition

getCredit

public int getCredit()

Description copied from interface: ProtonLink

Retrieves the current amount of credit. For a receiver link, the value returned will still include the credits that will be used by any queued incoming messages, use ProtonLink.getQueued() to assess the number of credits that will be used by queued messages.

Specified by:

getCredit in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the number of credits

getDrain

public boolean getDrain()

Description copied from interface: ProtonLink

Retrieves the current value of link 'drain' flag.

Specified by:

getDrain in interface ProtonLink<T extends ProtonLink<T>>

Returns:

when the link drain flag is set.

getLocalState

public org.apache.qpid.proton.engine.EndpointState getLocalState()

getName

public String getName()

Description copied from interface: ProtonLink

Retrieves the link name

Specified by:

getName in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the link name

getRemoteCondition

public org.apache.qpid.proton.amqp.transport.ErrorCondition getRemoteCondition()

Description copied from interface: ProtonLink

Gets the remote ErrorCondition object.

Specified by:

getRemoteCondition in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the condition

getRemoteCredit

public int getRemoteCredit()

getRemoteState

public org.apache.qpid.proton.engine.EndpointState getRemoteState()

getRemoteTarget

public org.apache.qpid.proton.amqp.transport.Target getRemoteTarget()

Description copied from interface: ProtonLink

Gets the current remote target config. Only useful to call after the link has remotely opened.

Specified by:

getRemoteTarget in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the target

getTarget

public org.apache.qpid.proton.amqp.transport.Target getTarget()

Description copied from interface: ProtonLink

Gets the current local target config.

Specified by:

getTarget in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the target

setTarget

public T setTarget(org.apache.qpid.proton.amqp.transport.Target target)

Description copied from interface: ProtonLink

Sets the current local target config. Only useful to call before the link has locally opened.

Specified by:

setTarget in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

target - the target

Returns:

the link

getRemoteSource

public org.apache.qpid.proton.amqp.transport.Source getRemoteSource()

Description copied from interface: ProtonLink

Gets the current remote source config. Only useful to call after the link has remotely opened.

Specified by:

getRemoteSource in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the target

getSource

public org.apache.qpid.proton.amqp.transport.Source getSource()

Description copied from interface: ProtonLink

Gets the current local source config.

Specified by:

getSource in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the source

setSource

public T setSource(org.apache.qpid.proton.amqp.transport.Source source)

Description copied from interface: ProtonLink

Sets the current local source config. Only useful to call before the link has locally opened.

Specified by:

setSource in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

source - the source

Returns:

the link

getUnsettled

public int getUnsettled()

getQueued

public int getQueued()

Description copied from interface: ProtonLink

Retrieves the current number of queued messages. For a receiver link, this is the number of messages that have already arrived locally but not yet been processed.

Specified by:

getQueued in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the number of queues messages

advance

public boolean advance()

drained

public int drained()

detached

public boolean detached()

delivery

public org.apache.qpid.proton.engine.Delivery delivery(byte[] tag,
                                                       int offset,
                                                       int length)

current

public org.apache.qpid.proton.engine.Delivery current()

setCondition

public T setCondition(org.apache.qpid.proton.amqp.transport.ErrorCondition condition)

Description copied from interface: ProtonLink

Sets the local ErrorCondition object.

Specified by:

setCondition in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

condition - the condition to set

Returns:

the link

delivery

public org.apache.qpid.proton.engine.Delivery delivery(byte[] tag)

close

public T close()

Description copied from interface: ProtonLink

Closes the AMQP link, i.e. allows the Detach frame to be emitted with closed=true set. If the closure is being locally initiated, the ProtonLink.closeHandler(Handler) should be used to handle the peer sending their Detach frame with closed=true (and ProtonLink.detachHandler(Handler) can be used to handle the peer sending their Detach frame with closed=false). When use of the link is complete, i.e it is locally and remotely closed, ProtonLink.free() must be called to ensure related resources can be tidied up.

Specified by:

close in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the link

detach

public T detach()

Description copied from interface: ProtonLink

Detaches the AMQP link, i.e. allows the Detach frame to be emitted with closed=false. If the detach is being locally initiated, the ProtonLink.detachHandler(Handler) should be used to handle the peer sending their Detach frame with closed=false (and ProtonLink.closeHandler(Handler) can be used to handle the peer sending their Detach frame with closed=true). When use of the link is complete, i.e it is locally and remotely detached, ProtonLink.free() must be called to ensure related resources can be tidied up.

Specified by:

detach in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the link

openHandler

public T openHandler(Handler<AsyncResult<T>> openHandler)

Description copied from interface: ProtonLink

Sets a handler for when an AMQP Attach frame is received from the remote peer. Typically used by clients, servers rely on ProtonConnection.senderOpenHandler(Handler) and ProtonConnection.receiverOpenHandler(Handler).

Specified by:

openHandler in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

openHandler - the handler

Returns:

the link

closeHandler

public T closeHandler(Handler<AsyncResult<T>> closeHandler)

Description copied from interface: ProtonLink

Sets a handler for when an AMQP Detach frame with closed=true is received from the remote peer.

Specified by:

closeHandler in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

closeHandler - the handler

Returns:

the link

detachHandler

public T detachHandler(Handler<AsyncResult<T>> detachHandler)

Description copied from interface: ProtonLink

Sets a handler for when an AMQP Detach frame with closed=false is received from the remote peer.

Specified by:

detachHandler in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

detachHandler - the handler

Returns:

the link

isOpen

public boolean isOpen()

Description copied from interface: ProtonLink

Check whether the link is locally open.

Specified by:

isOpen in interface ProtonLink<T extends ProtonLink<T>>

Returns:

whether the link is locally open.

getQoS

public ProtonQoS getQoS()

Description copied from interface: ProtonLink

Gets the local QOS config.

Specified by:

getQoS in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the QOS config

getRemoteQoS

public ProtonQoS getRemoteQoS()

Description copied from interface: ProtonLink

Gets the remote QOS config.

Specified by:

getRemoteQoS in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the QOS config

setQoS

public T setQoS(ProtonQoS qos)

Description copied from interface: ProtonLink

Sets the local QOS config.

Specified by:

setQoS in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

qos - the QOS to configure

Returns:

the link

getMaxMessageSize

public org.apache.qpid.proton.amqp.UnsignedLong getMaxMessageSize()

Description copied from interface: ProtonLink

Gets the local link max message size.

Specified by:

getMaxMessageSize in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the local max message size, or null if none was set. 0 also means no limit.

See Also:

ProtonLink.setMaxMessageSize(UnsignedLong)

setMaxMessageSize

public void setMaxMessageSize(org.apache.qpid.proton.amqp.UnsignedLong maxMessageSize)

Description copied from interface: ProtonLink

Sets the local link max message size, to be conveyed to the peer via the Attach frame when attaching the link to the session. Null or 0 means no limit. Must be called during link setup, i.e. before calling the ProtonLink.open() method. Receivers setting this can use the ProtonReceiver.maxMessageSizeExceededHandler(Handler) to be made aware if the limit is exceeded by the sending peer. See the handler doc for additional detail on the resulting behaviour.

Specified by:

setMaxMessageSize in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

maxMessageSize - the local max message size value, or null to clear. 0 also means no limit.

getRemoteMaxMessageSize

public org.apache.qpid.proton.amqp.UnsignedLong getRemoteMaxMessageSize()

Description copied from interface: ProtonLink

Gets the remote link max message size, as conveyed from the peer via the Attach frame when attaching the link to the session.

Specified by:

getRemoteMaxMessageSize in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the remote max message size conveyed by the peer, or null if none was set. 0 also means no limit.

getRemoteProperties

public Map<org.apache.qpid.proton.amqp.Symbol,Object> getRemoteProperties()

Description copied from interface: ProtonLink

Gets the remote link properties, as conveyed from the peer via the Attach frame when attaching the link to the session.

Specified by:

getRemoteProperties in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the remote link properties conveyed by the peer, or null if none was set.

setProperties

public void setProperties(Map<org.apache.qpid.proton.amqp.Symbol,Object> properties)

Description copied from interface: ProtonLink

Sets the link properties, to be conveyed to the peer via the Attach frame when attaching the link to the session. Must be called during link setup, i.e. before calling the ProtonLink.open() method.

Specified by:

setProperties in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

properties - the properties of the link to be coveyed to the remote peer.

setOfferedCapabilities

public void setOfferedCapabilities(org.apache.qpid.proton.amqp.Symbol[] capabilities)

Description copied from interface: ProtonLink

Sets the offered capabilities, to be conveyed to the peer via the Attach frame when attaching the link to the session. Must be called during link setup, i.e. before calling the ProtonLink.open() method.

Specified by:

setOfferedCapabilities in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

capabilities - the capabilities offered to the remote peer.

getRemoteOfferedCapabilities

public org.apache.qpid.proton.amqp.Symbol[] getRemoteOfferedCapabilities()

Description copied from interface: ProtonLink

Gets the remote offered capabilities, as conveyed from the peer via the Attach frame when attaching the link to the session.

Specified by:

getRemoteOfferedCapabilities in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the remote offered capabilities conveyed by the peer, or null if none was set.

setDesiredCapabilities

public void setDesiredCapabilities(org.apache.qpid.proton.amqp.Symbol[] capabilities)

Description copied from interface: ProtonLink

Sets the desired capabilities, to be conveyed to the peer via the Attach frame when attaching the link to the session. Must be called during link setup, i.e. before calling the ProtonLink.open() method.

Specified by:

setDesiredCapabilities in interface ProtonLink<T extends ProtonLink<T>>

Parameters:

capabilities - the capabilities desired of the remote peer.

getRemoteDesiredCapabilities

public org.apache.qpid.proton.amqp.Symbol[] getRemoteDesiredCapabilities()

Description copied from interface: ProtonLink

Gets the remote desired capabilities, as conveyed from the peer via the Attach frame when attaching the link to the session.

Specified by:

getRemoteDesiredCapabilities in interface ProtonLink<T extends ProtonLink<T>>

Returns:

the remote desired capabilities conveyed by the peer, or null if none was set.

free

public void free()

Description copied from interface: ProtonLink

Tidies up related link resources when complete with use. Call only after the link is finished with, e.g. locally and remotely closed.

Specified by:

free in interface ProtonLink<T extends ProtonLink<T>>