io.vertx.proton

Interface ProtonLink<T extends ProtonLink<T>>

All Known Subinterfaces:

ProtonReceiver, ProtonSender

public interface ProtonLink<T extends ProtonLink<T>>

Author:

Tim Fox

Method Summary

Modifier and Type	Method and Description
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>> remoteCloseHandler) Sets a handler for when an AMQP Detach frame with closed=true is received from the remote peer.
T	detach() Detaches the AMQP link, i.e.
T	detachHandler(Handler<AsyncResult<T>> remoteDetachHandler) Sets a handler for when an AMQP Detach frame with closed=false is received from the remote peer.
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.amqp.UnsignedLong	getMaxMessageSize() Gets the local link max message size.
String	getName() Retrieves the link name
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.
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.amqp.transport.Target	getRemoteTarget() Gets the current remote target config.
ProtonSession	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.
boolean	isOpen() Check whether the link is locally open.
T	open() Opens the AMQP link, i.e.
T	openHandler(Handler<AsyncResult<T>> remoteOpenHandler) Sets a handler for when an AMQP Attach frame is received from the remote peer.
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.
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.
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.

Method Detail

open

T open()

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 openHandler(Handler) may be used to handle the peer sending their Attach frame.

Returns:

the link

close

T close()

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 closeHandler(Handler) should be used to handle the peer sending their Detach frame with closed=true (and 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, free() must be called to ensure related resources can be tidied up.

Returns:

the link

detach

T detach()

Detaches the AMQP link, i.e. allows the Detach frame to be emitted with closed=false. If the detach is being locally initiated, the detachHandler(Handler) should be used to handle the peer sending their Detach frame with closed=false (and 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, free() must be called to ensure related resources can be tidied up.

Returns:

the link

openHandler

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

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).

Parameters:

remoteOpenHandler - the handler

Returns:

the link

closeHandler

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

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

Parameters:

remoteCloseHandler - the handler

Returns:

the link

detachHandler

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

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

Parameters:

remoteDetachHandler - the handler

Returns:

the link

getQoS

ProtonQoS getQoS()

Gets the local QOS config.

Returns:

the QOS config

setQoS

T setQoS(ProtonQoS qos)

Sets the local QOS config.

Parameters:

qos - the QOS to configure

Returns:

the link

getRemoteQoS

ProtonQoS getRemoteQoS()

Gets the remote QOS config.

Returns:

the QOS config

isOpen

boolean isOpen()

Check whether the link is locally open.

Returns:

whether the link is locally open.

attachments

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

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

Returns:

the attachments

getTarget

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

Gets the current local target config.

Returns:

the target

setTarget

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

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

Parameters:

target - the target

Returns:

the link

getRemoteTarget

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

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

Returns:

the target

getSource

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

Gets the current local source config.

Returns:

the source

setSource

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

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

Parameters:

source - the source

Returns:

the link

getRemoteSource

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

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

Returns:

the target

getSession

ProtonSession getSession()

Gets the session this link is on.

Returns:

the session

getRemoteAddress

String getRemoteAddress()

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

Returns:

the remote address, or null if there was none.

setCondition

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

Sets the local ErrorCondition object.

Parameters:

condition - the condition to set

Returns:

the link

getCondition

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

Gets the local ErrorCondition object.

Returns:

the condition

getRemoteCondition

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

Gets the remote ErrorCondition object.

Returns:

the condition

getCredit

int getCredit()

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 getQueued() to assess the number of credits that will be used by queued messages.

Returns:

the number of credits

getDrain

boolean getDrain()

Retrieves the current value of link 'drain' flag.

Returns:

when the link drain flag is set.

getQueued

int getQueued()

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.

Returns:

the number of queues messages

getName

String getName()

Retrieves the link name

Returns:

the link name

setMaxMessageSize

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. Null or 0 means no limit. Must be called during link setup, i.e. before calling the 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.

Parameters:

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

getMaxMessageSize

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

Gets the local link max message size.

Returns:

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

See Also:

setMaxMessageSize(UnsignedLong)

getRemoteMaxMessageSize

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.

Returns:

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

setProperties

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. Must be called during link setup, i.e. before calling the open() method.

Parameters:

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

getRemoteProperties

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.

Returns:

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

setOfferedCapabilities

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. Must be called during link setup, i.e. before calling the open() method.

Parameters:

capabilities - the capabilities offered to the remote peer.

getRemoteOfferedCapabilities

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.

Returns:

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

setDesiredCapabilities

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. Must be called during link setup, i.e. before calling the open() method.

Parameters:

capabilities - the capabilities desired of the remote peer.

getRemoteDesiredCapabilities

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.

Returns:

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

free

void free()

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