ProtonLink

attachments Record attachments(): Retrieves the attachments record, upon which application items can be set/retrieved.
close T close(): Closes the AMQP link, i.e. allows the Detach frame to be emitted with closed=true set.
closeHandler T closeHandler(Handler!T remoteCloseHandler): Sets a handler for when an AMQP Detach frame with closed=true is received from the remote peer.
detach T detach(): Detaches the AMQP link, i.e. allows the Detach frame to be emitted with closed=false.
detachHandler T detachHandler(Handler!T remoteDetachHandler): Sets a handler for when an AMQP Detach frame with closed=false is received from the remote peer.
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.
getCondition ErrorCondition getCondition(): Gets the local ErrorCondition object.
getCredit int getCredit(): Retrieves the current amount of credit.
getDrain bool getDrain(): Retrieves the current value of link 'drain' flag.
getMaxMessageSize UnsignedLong getMaxMessageSize(): Gets the local link max message size.
getName string getName(): Retrieves the link name
getQoS ProtonQoS getQoS(): Gets the local QOS config.
getQueued int getQueued(): Retrieves the current number of queued messages.
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.
getRemoteCondition ErrorCondition getRemoteCondition(): Gets the remote ErrorCondition object.
getRemoteDesiredCapabilities Symbol[] getRemoteDesiredCapabilities(): Gets the remote desired capabilities, as conveyed from the peer via the Attach frame when attaching the link to the session.
getRemoteMaxMessageSize 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.
getRemoteOfferedCapabilities Symbol[] getRemoteOfferedCapabilities(): Gets the remote offered capabilities, as conveyed from the peer via the Attach frame when attaching the link to the session.
getRemoteProperties 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.
getRemoteQoS ProtonQoS getRemoteQoS(): Gets the remote QOS config.
getRemoteSource Source getRemoteSource(): Gets the current remote source config. Only useful to call after the link has remotely opened.
getRemoteTarget Target getRemoteTarget(): Gets the current remote target config. Only useful to call after the link has remotely opened.
getSession ProtonSession getSession(): Gets the session this link is on. @return the session
getSource Source getSource(): Gets the current local source config.
getTarget Target getTarget(): Gets the current local target config.
isOpen bool isOpen(): Check whether the link is locally open.
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.
openHandler T openHandler(Handler!T remoteOpenHandler): Sets a handler for when an AMQP Attach frame is received from the remote peer.
setCondition T setCondition(ErrorCondition condition): Sets the local ErrorCondition object.
setDesiredCapabilities void setDesiredCapabilities(Symbol[] capabilities): Sets the desired capabilities, to be conveyed to the peer via the Attach frame when attaching the link to the session.
setMaxMessageSize void setMaxMessageSize(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.
setOfferedCapabilities void setOfferedCapabilities(Symbol[] capabilities): Sets the offered capabilities, to be conveyed to the peer via the Attach frame when attaching the link to the session.
setProperties void setProperties(Map!(Symbol, Object) properties): Sets the link properties, to be conveyed to the peer via the Attach frame when attaching the link to the session.
setQoS T setQoS(ProtonQoS qos): Sets the local QOS config.
setSource T setSource(Source source): Sets the current local source config. Only useful to call before the link has locally opened.
setTarget T setTarget(Target target): Sets the current local target config. Only useful to call before the link has locally opened.

ProtonLink

Members

Functions

Meta

Source