| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Proton DotNet: Apache.Qpid.Proton.Engine.ISender Interface Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Proton DotNet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Engine.ISender Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>AMQP Sender link resource. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Engine.ISender:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.png" usemap="#Apache.Qpid.Proton.Engine.ISender_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Engine.ISender_map" name="Apache.Qpid.Proton.Engine.ISender_map"> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html" title="Base API for all AMQP Sender and Receiver links." alt="Apache.Qpid.Proton.Engine.ILink< T >" shape="rect" coords="0,56,339,80"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html" title="Represents an AMQP Connection which is owned by a single engine instance" alt="Apache.Qpid.Proton.Engine.IEndpoint< T >" shape="rect" coords="0,0,339,24"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSender.html" title="Proton Sender link implementation which manages the state of the Sender end of an attached link and p..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonSender" shape="rect" coords="0,168,339,192"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:ae54102d2e5c233a4f1505bd88ce9e87e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#ae54102d2e5c233a4f1505bd88ce9e87e">Drained</a> ()</td></tr> |
| <tr class="memdesc:ae54102d2e5c233a4f1505bd88ce9e87e"><td class="mdescLeft"> </td><td class="mdescRight">Called when the remote receiver has requested a drain of credit and the sender has sent all available messages. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#ae54102d2e5c233a4f1505bd88ce9e87e">More...</a><br /></td></tr> |
| <tr class="separator:ae54102d2e5c233a4f1505bd88ce9e87e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaa2d450dd1b09d9f6e99c4b67515e4fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#aaa2d450dd1b09d9f6e99c4b67515e4fe">Next</a> ()</td></tr> |
| <tr class="memdesc:aaa2d450dd1b09d9f6e99c4b67515e4fe"><td class="mdescLeft"> </td><td class="mdescRight">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 delivery has not been completed by either calling a completing API method then this method will throw an exception to indicate the sender state cannot allow a new delivery to be started. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#aaa2d450dd1b09d9f6e99c4b67515e4fe">More...</a><br /></td></tr> |
| <tr class="separator:aaa2d450dd1b09d9f6e99c4b67515e4fe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8fdb2222d4112c3f3f23f719c1f8fd46"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a8fdb2222d4112c3f3f23f719c1f8fd46">Disposition</a> (Predicate< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> > filter, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> state, bool settle)</td></tr> |
| <tr class="memdesc:a8fdb2222d4112c3f3f23f719c1f8fd46"><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a8fdb2222d4112c3f3f23f719c1f8fd46">More...</a><br /></td></tr> |
| <tr class="separator:a8fdb2222d4112c3f3f23f719c1f8fd46"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16fe08a19c094e38b08c88073e7daa7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a16fe08a19c094e38b08c88073e7daa7b">Settle</a> (Predicate< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> > filter)</td></tr> |
| <tr class="memdesc:a16fe08a19c094e38b08c88073e7daa7b"><td class="mdescLeft"> </td><td class="mdescRight">For each unsettled outgoing delivery that is pending in the sender apply the given predicate and if it matches then settle the delivery. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a16fe08a19c094e38b08c88073e7daa7b">More...</a><br /></td></tr> |
| <tr class="separator:a16fe08a19c094e38b08c88073e7daa7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a3b8d48779acf35dfb4a9d05d2aa9c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a2a3b8d48779acf35dfb4a9d05d2aa9c1">DeliveryStateUpdatedHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> > handler)</td></tr> |
| <tr class="memdesc:a2a3b8d48779acf35dfb4a9d05d2aa9c1"><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a2a3b8d48779acf35dfb4a9d05d2aa9c1">More...</a><br /></td></tr> |
| <tr class="separator:a2a3b8d48779acf35dfb4a9d05d2aa9c1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html">Apache.Qpid.Proton.Engine.ILink< T ></a></td></tr> |
| <tr class="memitem:a3faac9c1ade8fb5ba50fc9e70eefb732 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a3faac9c1ade8fb5ba50fc9e70eefb732">Detach</a> ()</td></tr> |
| <tr class="memdesc:a3faac9c1ade8fb5ba50fc9e70eefb732 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Detaches the local end of the link if not already closed or detached. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a3faac9c1ade8fb5ba50fc9e70eefb732">More...</a><br /></td></tr> |
| <tr class="separator:a3faac9c1ade8fb5ba50fc9e70eefb732 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ada0a643f127fa197c4f4b1bc7db411df inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ada0a643f127fa197c4f4b1bc7db411df">LocalDetachHandler</a> (Action< T > localDetachHandler)</td></tr> |
| <tr class="memdesc:ada0a643f127fa197c4f4b1bc7db411df inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Sets a Action for when an this endpoint is closed locally via a call to Close. This is a convenience event that supplements the normal locally closed event point if set. If no local detached event handler is set the endpoint will route the detached event to the local closed event handler if set and allow it to process the event in one location. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ada0a643f127fa197c4f4b1bc7db411df">More...</a><br /></td></tr> |
| <tr class="separator:ada0a643f127fa197c4f4b1bc7db411df inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a40018e2b958e2e23bdc1a424f19f2e22 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a40018e2b958e2e23bdc1a424f19f2e22">DetachHandler</a> (Action< T > detachHandler)</td></tr> |
| <tr class="memdesc:a40018e2b958e2e23bdc1a424f19f2e22 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Sets a EventHandler for when an AMQP detach frame is received from the remote peer. This is a convenience event that supplements the normal link closed event point if set. If no detached event handler is set the endpoint will route the detached event to the closed event handler if set and allow it to process the event in one location. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a40018e2b958e2e23bdc1a424f19f2e22">More...</a><br /></td></tr> |
| <tr class="separator:a40018e2b958e2e23bdc1a424f19f2e22 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af1b533eeb6a1af97d18faed97c646c91 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#af1b533eeb6a1af97d18faed97c646c91">CreditStateUpdateHandler</a> (Action< T > handler)</td></tr> |
| <tr class="memdesc:af1b533eeb6a1af97d18faed97c646c91 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Handler for link credit updates that occur after a remote flow frame arrives. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#af1b533eeb6a1af97d18faed97c646c91">More...</a><br /></td></tr> |
| <tr class="separator:af1b533eeb6a1af97d18faed97c646c91 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adc2fba593c8fa5f137d069c63c4275f7 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#adc2fba593c8fa5f137d069c63c4275f7">ParentEndpointClosedHandler</a> (Action< T > handler)</td></tr> |
| <tr class="memdesc:adc2fba593c8fa5f137d069c63c4275f7 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Sets a Action delegate for when the parent Session or Connection of this link is locally closed. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#adc2fba593c8fa5f137d069c63c4275f7">More...</a><br /></td></tr> |
| <tr class="separator:adc2fba593c8fa5f137d069c63c4275f7 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint< T ></a></td></tr> |
| <tr class="memitem:ae4e9579365862c944a0cd79fa218d183 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ae4e9579365862c944a0cd79fa218d183">Open</a> ()</td></tr> |
| <tr class="memdesc:ae4e9579365862c944a0cd79fa218d183 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Open the end point locally, sending the Open performative immediately if possible or holding it until SASL negotiations or the AMQP header exchange and other required performative exchanges has completed. The endpoint will signal any registered handler of the remote opening the endpoint once the remote performative that signals open completion arrives. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ae4e9579365862c944a0cd79fa218d183">More...</a><br /></td></tr> |
| <tr class="separator:ae4e9579365862c944a0cd79fa218d183 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a15b7acdd0d22c2ade430a336a7678a41 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a15b7acdd0d22c2ade430a336a7678a41">Close</a> ()</td></tr> |
| <tr class="memdesc:a15b7acdd0d22c2ade430a336a7678a41 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Close the end point locally and send the closing performative immediately if possible or holds it until the Connection / <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a> state allows it. If the engine encounters an error writing the performative or the engine is in a failed state from a previous error then this method will throw an exception. If the engine has been shutdown then this method will close out the local end of the endpoint and clean up any local resources before returning normally. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a15b7acdd0d22c2ade430a336a7678a41">More...</a><br /></td></tr> |
| <tr class="separator:a15b7acdd0d22c2ade430a336a7678a41 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a036cf0b0c5d588a086e24699a0a52b59 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a036cf0b0c5d588a086e24699a0a52b59">LocalOpenHandler</a> (Action< T > localOpenHandler)</td></tr> |
| <tr class="memdesc:a036cf0b0c5d588a086e24699a0a52b59 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Sets a Action for when an this endpoint is opened locally via a call to Open. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined. Typically used by clients as servers will typically listen to some parent resource event handler to determine if the remote is initiating a resource open. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a036cf0b0c5d588a086e24699a0a52b59">More...</a><br /></td></tr> |
| <tr class="separator:a036cf0b0c5d588a086e24699a0a52b59 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f769d3342763f21fb9a5bcd62ab0aee inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a0f769d3342763f21fb9a5bcd62ab0aee">LocalCloseHandler</a> (Action< T > localCloseHandler)</td></tr> |
| <tr class="memdesc:a0f769d3342763f21fb9a5bcd62ab0aee inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Sets a Action for when an this endpoint is closed locally via a call to Close. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a0f769d3342763f21fb9a5bcd62ab0aee">More...</a><br /></td></tr> |
| <tr class="separator:a0f769d3342763f21fb9a5bcd62ab0aee inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a007ae977fc124ddc836f315d018ab05d inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a007ae977fc124ddc836f315d018ab05d">OpenHandler</a> (Action< T > localOpenHandler)</td></tr> |
| <tr class="memdesc:a007ae977fc124ddc836f315d018ab05d inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Sets a Action for when an AMQP Open frame is received from the remote peer. Used to process remotely initiated Connections. Locally initiated sessions have their own Action invoked instead. This method is typically used by servers to listen for the remote peer to open its endpoint, while a client would listen for the server to open its end of the endpoint once a local open has been performed. Typically used by clients as servers will typically listen to some parent resource event handler to determine if the remote is initiating a resource open. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a007ae977fc124ddc836f315d018ab05d">More...</a><br /></td></tr> |
| <tr class="separator:a007ae977fc124ddc836f315d018ab05d inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9a36c96c71b9b677340dcb5476146c82 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a9a36c96c71b9b677340dcb5476146c82">CloseHandler</a> (Action< T > localCloseHandler)</td></tr> |
| <tr class="memdesc:a9a36c96c71b9b677340dcb5476146c82 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Sets a EventHandler for when an AMQP closing frame is received from the remote peer. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a9a36c96c71b9b677340dcb5476146c82">More...</a><br /></td></tr> |
| <tr class="separator:a9a36c96c71b9b677340dcb5476146c82 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad985e08f80b4efc7d4e9ec236c3b3612 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ad985e08f80b4efc7d4e9ec236c3b3612">EngineShutdownHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngine.html">IEngine</a> > shutdownHandler)</td></tr> |
| <tr class="memdesc:ad985e08f80b4efc7d4e9ec236c3b3612 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Sets an Action that is invoked when the engine that supports this endpoint is shutdown which indicates a desire to terminate all engine operations. Any endpoint that has been both locally and remotely closed will not receive this event as it will no longer be tracked by the parent its parent endpoint. A typical use of this event would be from a locally closed endpoint that is awaiting response from the remote. If this event fires then there will never be a remote response to any pending operations and the client or server instance should react accordingly to clean up any related resources etc. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ad985e08f80b4efc7d4e9ec236c3b3612">More...</a><br /></td></tr> |
| <tr class="separator:ad985e08f80b4efc7d4e9ec236c3b3612 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a19a83e1dbc22100ec4fc42ba0b888202"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a19a83e1dbc22100ec4fc42ba0b888202">IsSendable</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a19a83e1dbc22100ec4fc42ba0b888202"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the sender has credit and the session window allows for any bytes to be written currently. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a19a83e1dbc22100ec4fc42ba0b888202">More...</a><br /></td></tr> |
| <tr class="separator:a19a83e1dbc22100ec4fc42ba0b888202"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a027a157615f2ff9c63f5478e1d28f7ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a027a157615f2ff9c63f5478e1d28f7ba">Current</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a027a157615f2ff9c63f5478e1d28f7ba"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current outgoing delivery 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 outgoing delivery stream bytes methods which allows for later writing of additional bytes to the delivery. Once the write bytes method or the complete API 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 abort method of the outgoing delivery API. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a027a157615f2ff9c63f5478e1d28f7ba">More...</a><br /></td></tr> |
| <tr class="separator:a027a157615f2ff9c63f5478e1d28f7ba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae5dbe06e9cc94e1f5eba70d2b62a1d68"><td class="memItemLeft" align="right" valign="top">IReadOnlyCollection< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#ae5dbe06e9cc94e1f5eba70d2b62a1d68">Unsettled</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae5dbe06e9cc94e1f5eba70d2b62a1d68"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the list of unsettled deliveries sent from this sender. The deliveries in the enumerator cannot be written to but can have their settled state and disposition updated. Only when this sender settles on its end are the outgoing delivery instances removed from the unsettled tracking. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#ae5dbe06e9cc94e1f5eba70d2b62a1d68">More...</a><br /></td></tr> |
| <tr class="separator:ae5dbe06e9cc94e1f5eba70d2b62a1d68"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9701da452c5b0600c515930ee8c1b96e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a9701da452c5b0600c515930ee8c1b96e">HasUnsettled</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a9701da452c5b0600c515930ee8c1b96e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the sender link is tracking any unsettled sent deliveries. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#a9701da452c5b0600c515930ee8c1b96e">More...</a><br /></td></tr> |
| <tr class="separator:a9701da452c5b0600c515930ee8c1b96e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa6036143e4efaa5a2135948e1ac6935d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator.html">IDeliveryTagGenerator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#aa6036143e4efaa5a2135948e1ac6935d">DeliveryTagGenerator</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:aa6036143e4efaa5a2135948e1ac6935d"><td class="mdescLeft"> </td><td class="mdescRight">Configures a delivery tag generator that will be used to create and set a delivery tag value on each new outgoing delivery that is created and returned from the sender next delivery method. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html#aa6036143e4efaa5a2135948e1ac6935d">More...</a><br /></td></tr> |
| <tr class="separator:aa6036143e4efaa5a2135948e1ac6935d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html">Apache.Qpid.Proton.Engine.ILink< T ></a></td></tr> |
| <tr class="memitem:ac24b688eb4dfec81ea8b618a335740bc inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ac24b688eb4dfec81ea8b618a335740bc">IsLocallyDetached</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac24b688eb4dfec81ea8b618a335740bc inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the endpoint having been previously locally opened is now detached due to a call the the detach method. This does not reflect the state of the remote endpoint and that should be checked separately. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ac24b688eb4dfec81ea8b618a335740bc">More...</a><br /></td></tr> |
| <tr class="separator:ac24b688eb4dfec81ea8b618a335740bc inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6637864fad61b5f622e94fb466dd0e42 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a6637864fad61b5f622e94fb466dd0e42">IsLocallyClosedOrDetached</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6637864fad61b5f622e94fb466dd0e42 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the endpoint having been previously locally opened is now detached or closed due to a call to either the close method or the detach method. This does not reflect the state of the remote endpoint and that should be checked separately. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a6637864fad61b5f622e94fb466dd0e42">More...</a><br /></td></tr> |
| <tr class="separator:a6637864fad61b5f622e94fb466dd0e42 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a438f92bc696dbafe0cf9256d271e75 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#acbdc8141247342461fc88ea23eac6ad6">LinkState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a5a438f92bc696dbafe0cf9256d271e75">LinkState</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5a438f92bc696dbafe0cf9256d271e75 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current state of the local end of the link object. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a5a438f92bc696dbafe0cf9256d271e75">More...</a><br /></td></tr> |
| <tr class="separator:a5a438f92bc696dbafe0cf9256d271e75 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8cbcbd1237553130405839dd0d96a77a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a8cbcbd1237553130405839dd0d96a77a">Credit</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a8cbcbd1237553130405839dd0d96a77a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Reads the credit that is currently available on or assigned to this link object. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a8cbcbd1237553130405839dd0d96a77a">More...</a><br /></td></tr> |
| <tr class="separator:a8cbcbd1237553130405839dd0d96a77a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8cb0c35d16b23898bb517a01e4c4af33 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a8cb0c35d16b23898bb517a01e4c4af33">IsDraining</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a8cb0c35d16b23898bb517a01e4c4af33 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">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 remote sender consume its outstanding credit. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a8cb0c35d16b23898bb517a01e4c4af33">More...</a><br /></td></tr> |
| <tr class="separator:a8cb0c35d16b23898bb517a01e4c4af33 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab15e51a98bbde46e6fe61b724f80ab17 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport.html#a5f514350b2297fec543826213ed83cd4">Role</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ab15e51a98bbde46e6fe61b724f80ab17">Role</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab15e51a98bbde46e6fe61b724f80ab17 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Reads the role assigned to the local end of the link. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ab15e51a98bbde46e6fe61b724f80ab17">More...</a><br /></td></tr> |
| <tr class="separator:ab15e51a98bbde46e6fe61b724f80ab17 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab8f0c167ebaa289113c6c91ca1e3ee51 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ab8f0c167ebaa289113c6c91ca1e3ee51">IsSender</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab8f0c167ebaa289113c6c91ca1e3ee51 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns if this link is a sender link. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ab8f0c167ebaa289113c6c91ca1e3ee51">More...</a><br /></td></tr> |
| <tr class="separator:ab8f0c167ebaa289113c6c91ca1e3ee51 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5c4a8feccfc607d1cf6d94e4aa710391 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a5c4a8feccfc607d1cf6d94e4aa710391">IsReceiver</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5c4a8feccfc607d1cf6d94e4aa710391 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns if this link is a receiver link. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a5c4a8feccfc607d1cf6d94e4aa710391">More...</a><br /></td></tr> |
| <tr class="separator:a5c4a8feccfc607d1cf6d94e4aa710391 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a288a8100df3231216eec79eb39427a03 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IConnection.html">IConnection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a288a8100df3231216eec79eb39427a03">Connection</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a288a8100df3231216eec79eb39427a03 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the connection that owns this sender endpoint. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a288a8100df3231216eec79eb39427a03">More...</a><br /></td></tr> |
| <tr class="separator:a288a8100df3231216eec79eb39427a03 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab578133eba2e8bd8fb2495714d20d5a2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html">ISession</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ab578133eba2e8bd8fb2495714d20d5a2">Session</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab578133eba2e8bd8fb2495714d20d5a2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the session that owns this sender endpoint. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ab578133eba2e8bd8fb2495714d20d5a2">More...</a><br /></td></tr> |
| <tr class="separator:ab578133eba2e8bd8fb2495714d20d5a2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ade03463cbfde7406b349e2b25922c3d2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ade03463cbfde7406b349e2b25922c3d2">Name</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ade03463cbfde7406b349e2b25922c3d2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Access the name that was given to the link on creation. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ade03463cbfde7406b349e2b25922c3d2">More...</a><br /></td></tr> |
| <tr class="separator:ade03463cbfde7406b349e2b25922c3d2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af753b9e8d30629f6a5904300dab489f0 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">SenderSettleMode </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#af753b9e8d30629f6a5904300dab489f0">SenderSettleMode</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:af753b9e8d30629f6a5904300dab489f0 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Access the sender settle mode. Should only be called during link set-up, i.e. before calling open. If this endpoint is the initiator of the link, this method can be used to set a value other than the default. If this endpoint is not the initiator, this method should be used to set a local value. According to the AMQP spec, the application may choose to accept the sender's suggestion (accessed by calling the remote sender settle mode API) or choose another value. The value has no effect on <a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a>, but may be useful to the application at a later point. In order to be AMQP compliant the application is responsible for honoring the settlement mode. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#af753b9e8d30629f6a5904300dab489f0">More...</a><br /></td></tr> |
| <tr class="separator:af753b9e8d30629f6a5904300dab489f0 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a70d509b08ca4ea75cbf4a4c4462aedc0 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">ReceiverSettleMode </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a70d509b08ca4ea75cbf4a4c4462aedc0">ReceiverSettleMode</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a70d509b08ca4ea75cbf4a4c4462aedc0 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Access the receiver settle mode. Should only be called during link set-up, i.e. before calling open. If this endpoint is the initiator of the link, this method can be used to set a value other than the default. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a70d509b08ca4ea75cbf4a4c4462aedc0">More...</a><br /></td></tr> |
| <tr class="separator:a70d509b08ca4ea75cbf4a4c4462aedc0 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af9c4274e303966d6a803bf44089d9ace inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1Source.html">Source</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#af9c4274e303966d6a803bf44089d9ace">Source</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:af9c4274e303966d6a803bf44089d9ace inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Sets the Source value to assign to the local end of this link. Must be called during link setup, i.e. before calling the open method. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#af9c4274e303966d6a803bf44089d9ace">More...</a><br /></td></tr> |
| <tr class="separator:af9c4274e303966d6a803bf44089d9ace inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1c1720215751f6d9159231d17af4ae31 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1Source.html">Source</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a1c1720215751f6d9159231d17af4ae31">RemoteSource</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1c1720215751f6d9159231d17af4ae31 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Gets the Source value that was assigned by the remote end of the link. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a1c1720215751f6d9159231d17af4ae31">More...</a><br /></td></tr> |
| <tr class="separator:a1c1720215751f6d9159231d17af4ae31 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5c9d3f0e775f3b44a98ae40ce9499256 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1ITerminus.html">ITerminus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a5c9d3f0e775f3b44a98ae40ce9499256">Terminus</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a5c9d3f0e775f3b44a98ae40ce9499256 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Gets the local Target terminus value as a generic terminus instance which the user can then interrogate to determine if it is a Target or a Coordinator instance. When set the value must be one of Target or Coordinator. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a5c9d3f0e775f3b44a98ae40ce9499256">More...</a><br /></td></tr> |
| <tr class="separator:a5c9d3f0e775f3b44a98ae40ce9499256 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1de222a0bc42d2c726ef54dcc7cb776b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1ITerminus.html">ITerminus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a1de222a0bc42d2c726ef54dcc7cb776b">RemoteTerminus</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1de222a0bc42d2c726ef54dcc7cb776b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Get the remote set Terminus either Target or Coordinator that is set once the remote sends its attach frame. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a1de222a0bc42d2c726ef54dcc7cb776b">More...</a><br /></td></tr> |
| <tr class="separator:a1de222a0bc42d2c726ef54dcc7cb776b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aacb8050c3b040628d4aae11765e7b66a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transactions_1_1Coordinator.html">Coordinator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#aacb8050c3b040628d4aae11765e7b66a">Coordinator</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:aacb8050c3b040628d4aae11765e7b66a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Attempt to access the local target terminus value as a Coordinator value. When reading if the target terminus is not a Coordinator the result is null. Must be called during link setup, i.e. before calling the open method. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#aacb8050c3b040628d4aae11765e7b66a">More...</a><br /></td></tr> |
| <tr class="separator:aacb8050c3b040628d4aae11765e7b66a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a375643dc9fd0bb34eca33f5f99dd2dbe inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Messaging_1_1Target.html">Target</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a375643dc9fd0bb34eca33f5f99dd2dbe">Target</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a375643dc9fd0bb34eca33f5f99dd2dbe inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Attempt to access the local target terminus value as a Target value. When reading if the target terminus is not a Target the result is null. Must be called during link setup, i.e. before calling the open method. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a375643dc9fd0bb34eca33f5f99dd2dbe">More...</a><br /></td></tr> |
| <tr class="separator:a375643dc9fd0bb34eca33f5f99dd2dbe inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a08f036e574879fcbdbb9370a15e700eb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">ulong </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a08f036e574879fcbdbb9370a15e700eb">MaxMessageSize</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a08f036e574879fcbdbb9370a15e700eb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a08f036e574879fcbdbb9370a15e700eb">More...</a><br /></td></tr> |
| <tr class="separator:a08f036e574879fcbdbb9370a15e700eb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adc9f6830c1cc5c0fc28db324599f5e22 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#adc9f6830c1cc5c0fc28db324599f5e22">IsRemotelyDetached</a><code> [get]</code></td></tr> |
| <tr class="memdesc:adc9f6830c1cc5c0fc28db324599f5e22 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this link is currently remotely detached meaning the state returned from the remote state accessor is equal to detached. A link is remotely detached after an Detach performative has been received from the remote with the close flag equal to false. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#adc9f6830c1cc5c0fc28db324599f5e22">More...</a><br /></td></tr> |
| <tr class="separator:adc9f6830c1cc5c0fc28db324599f5e22 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae7089cf08e3acb8ea13fc73b48bbd9ff inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ae7089cf08e3acb8ea13fc73b48bbd9ff">IsRemotelyClosedOrDetached</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae7089cf08e3acb8ea13fc73b48bbd9ff inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this link is currently remotely detached or closed meaning the state returned from the remote state accessor is equal to detached or to closed. A link is remotely detached after an Detach performative has been received from the remote with the close flag equal to false otherwise is considered closed.. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#ae7089cf08e3acb8ea13fc73b48bbd9ff">More...</a><br /></td></tr> |
| <tr class="separator:ae7089cf08e3acb8ea13fc73b48bbd9ff inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96b0fc29e007812c692caf0da8c121fd inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#af753b9e8d30629f6a5904300dab489f0">SenderSettleMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a96b0fc29e007812c692caf0da8c121fd">RemoteSenderSettleMode</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a96b0fc29e007812c692caf0da8c121fd inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Gets the remote link sender settlement mode, as conveyed from the peer via the Attach frame when attaching the link to the session. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a96b0fc29e007812c692caf0da8c121fd">More...</a><br /></td></tr> |
| <tr class="separator:a96b0fc29e007812c692caf0da8c121fd inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a06f8730963d22ca5d109ffb26f26bc8f inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a70d509b08ca4ea75cbf4a4c4462aedc0">ReceiverSettleMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a06f8730963d22ca5d109ffb26f26bc8f">RemoteReceiverSettleMode</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a06f8730963d22ca5d109ffb26f26bc8f inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Gets the remote link receiver settlement mode, as conveyed from the peer via the Attach frame when attaching the link to the session. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a06f8730963d22ca5d109ffb26f26bc8f">More...</a><br /></td></tr> |
| <tr class="separator:a06f8730963d22ca5d109ffb26f26bc8f inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7b46c5c0c130712b44c9a3fff811fd95 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#acbdc8141247342461fc88ea23eac6ad6">LinkState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a7b46c5c0c130712b44c9a3fff811fd95">RemoteState</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a7b46c5c0c130712b44c9a3fff811fd95 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current remote link state. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink.html#a7b46c5c0c130712b44c9a3fff811fd95">More...</a><br /></td></tr> |
| <tr class="separator:a7b46c5c0c130712b44c9a3fff811fd95 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ILink"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint< T ></a></td></tr> |
| <tr class="memitem:acf2de4c97690fa4fd673461dcbb37db5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngine.html">IEngine</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#acf2de4c97690fa4fd673461dcbb37db5">Engine</a><code> [get]</code></td></tr> |
| <tr class="memdesc:acf2de4c97690fa4fd673461dcbb37db5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the engine instance that owns the resources of this endpoint and its parent. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#acf2de4c97690fa4fd673461dcbb37db5">More...</a><br /></td></tr> |
| <tr class="separator:acf2de4c97690fa4fd673461dcbb37db5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac2fb9813280c594a67f269c99b127686 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IAttachments.html">IAttachments</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ac2fb9813280c594a67f269c99b127686">Attachments</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac2fb9813280c594a67f269c99b127686 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Access the attachments instance that is associated with this resource where the application can store data relevant to the endpoint for later use. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ac2fb9813280c594a67f269c99b127686">More...</a><br /></td></tr> |
| <tr class="separator:ac2fb9813280c594a67f269c99b127686 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a25bdf8458c47a47339a23de1b5667540 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">object </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a25bdf8458c47a47339a23de1b5667540">LinkedResource</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a25bdf8458c47a47339a23de1b5667540 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Allows the endpoint to have some user defined resource linked to it which can be used to store application state data or other associated object instances with this endpoint. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a25bdf8458c47a47339a23de1b5667540">More...</a><br /></td></tr> |
| <tr class="separator:a25bdf8458c47a47339a23de1b5667540 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a483d1c5582cbeeec1b97be0ba0da8f0a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1ErrorCondition.html">ErrorCondition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a483d1c5582cbeeec1b97be0ba0da8f0a">ErrorCondition</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a483d1c5582cbeeec1b97be0ba0da8f0a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the error condition that should be applied to the AMQP frame that closes or ends this endpoint when the close method is called be the user. Setting this value after closing the endpoint has no effect. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a483d1c5582cbeeec1b97be0ba0da8f0a">More...</a><br /></td></tr> |
| <tr class="separator:a483d1c5582cbeeec1b97be0ba0da8f0a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4578fff3125a050d7126952b7fde08b2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1ErrorCondition.html">ErrorCondition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a4578fff3125a050d7126952b7fde08b2">RemoteErrorCondition</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4578fff3125a050d7126952b7fde08b2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">If the remote has closed this endpoint and provided an ErrorCondition as part of the closing AMQP performative then this method will return it. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a4578fff3125a050d7126952b7fde08b2">More...</a><br /></td></tr> |
| <tr class="separator:a4578fff3125a050d7126952b7fde08b2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6395c22a29e16f3f90f67729b2bc9d1a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a6395c22a29e16f3f90f67729b2bc9d1a">IsLocallyOpen</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6395c22a29e16f3f90f67729b2bc9d1a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the endpoint open was previously called and the close method has not yet been invoked. This only reflects the state on the local end and the user should also check the remote state. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a6395c22a29e16f3f90f67729b2bc9d1a">More...</a><br /></td></tr> |
| <tr class="separator:a6395c22a29e16f3f90f67729b2bc9d1a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab33b409da9ba52367721407ab4bbd31f inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ab33b409da9ba52367721407ab4bbd31f">IsLocallyClosed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab33b409da9ba52367721407ab4bbd31f inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the endpoint having been previously locally opened is now closed due to a call the the close method. This does not reflect the state of the remote endpoint and that should be checked separately. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ab33b409da9ba52367721407ab4bbd31f">More...</a><br /></td></tr> |
| <tr class="separator:ab33b409da9ba52367721407ab4bbd31f inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a94174c5f25e62b8b95492a92c6f4e63a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a94174c5f25e62b8b95492a92c6f4e63a">IsRemotelyOpen</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a94174c5f25e62b8b95492a92c6f4e63a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this endpoint is currently remotely open meaning that the AMQP performative that completes the open phase of this endpoint's lifetime has arrived but the performative that closes it has not. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a94174c5f25e62b8b95492a92c6f4e63a">More...</a><br /></td></tr> |
| <tr class="separator:a94174c5f25e62b8b95492a92c6f4e63a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac4457742b6167578c6cfffdc0bec405b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ac4457742b6167578c6cfffdc0bec405b">IsRemotelyClosed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac4457742b6167578c6cfffdc0bec405b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this endpoint is currently remotely closed meaning that the AMQP performative that completes the close phase of this endpoint's lifetime has arrived. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ac4457742b6167578c6cfffdc0bec405b">More...</a><br /></td></tr> |
| <tr class="separator:ac4457742b6167578c6cfffdc0bec405b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aca301979e4ab47a2ff142966e073ccfd inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#aca301979e4ab47a2ff142966e073ccfd">OfferedCapabilities</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:aca301979e4ab47a2ff142966e073ccfd inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Access the capabilities to be offered on to the remote when this endpoint is opened. The offered capabilities value can only be modified prior to a call to open, once the endpoint has been opened locally an error will be thrown if this method is called. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#aca301979e4ab47a2ff142966e073ccfd">More...</a><br /></td></tr> |
| <tr class="separator:aca301979e4ab47a2ff142966e073ccfd inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa5a2b6e00125c05df60fe373c1368366 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#aa5a2b6e00125c05df60fe373c1368366">DesiredCapabilities</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:aa5a2b6e00125c05df60fe373c1368366 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Access the capabilities that are desired on to the remote when this endpoint is opened. The desired capabilities value can only be modified prior to a call to open, once the endpoint has been opened locally an error will be thrown if this method is called. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#aa5a2b6e00125c05df60fe373c1368366">More...</a><br /></td></tr> |
| <tr class="separator:aa5a2b6e00125c05df60fe373c1368366 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adc18f13e8a13f1cb9c891f0a89479db5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">IReadOnlyDictionary< <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>, object > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#adc18f13e8a13f1cb9c891f0a89479db5">Properties</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:adc18f13e8a13f1cb9c891f0a89479db5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Access the properties that are conveyed to the remote when this endpoint is opened. The properties value can only be modified prior to a call to open, once the endpoint has been opened locally an error will be thrown if this method is called. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#adc18f13e8a13f1cb9c891f0a89479db5">More...</a><br /></td></tr> |
| <tr class="separator:adc18f13e8a13f1cb9c891f0a89479db5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5b30574efe967b7c8b2be36fce5c086b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a5b30574efe967b7c8b2be36fce5c086b">RemoteOfferedCapabilities</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5b30574efe967b7c8b2be36fce5c086b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">The capabilities offered by the remote when it opened its end of the endpoint. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a5b30574efe967b7c8b2be36fce5c086b">More...</a><br /></td></tr> |
| <tr class="separator:a5b30574efe967b7c8b2be36fce5c086b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afb420de3356b1ca05f2f9f109262916b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#afb420de3356b1ca05f2f9f109262916b">RemoteDesiredCapabilities</a><code> [get]</code></td></tr> |
| <tr class="memdesc:afb420de3356b1ca05f2f9f109262916b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">The capabilities desired by the remote when it opened its end of the endpoint. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#afb420de3356b1ca05f2f9f109262916b">More...</a><br /></td></tr> |
| <tr class="separator:afb420de3356b1ca05f2f9f109262916b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7bef5964f1a780579627bbc569a05028 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">IReadOnlyDictionary< <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>, object > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a7bef5964f1a780579627bbc569a05028">RemoteProperties</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a7bef5964f1a780579627bbc569a05028 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">The properties sent by the remote when it opened its end of this endpoint. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a7bef5964f1a780579627bbc569a05028">More...</a><br /></td></tr> |
| <tr class="separator:a7bef5964f1a780579627bbc569a05028 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>AMQP Sender link resource. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a2a3b8d48779acf35dfb4a9d05d2aa9c1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2a3b8d48779acf35dfb4a9d05d2aa9c1">◆ </a></span>DeliveryStateUpdatedHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> Apache.Qpid.Proton.Engine.ISender.DeliveryStateUpdatedHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> > </td> |
| <td class="paramname"><em>handler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handler</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSender.html#a879a57c6970e66c6cb23c8ea33255d9a">Apache.Qpid.Proton.Engine.Implementation.ProtonSender</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a8fdb2222d4112c3f3f23f719c1f8fd46"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8fdb2222d4112c3f3f23f719c1f8fd46">◆ </a></span>Disposition()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> Apache.Qpid.Proton.Engine.ISender.Disposition </td> |
| <td>(</td> |
| <td class="paramtype">Predicate< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> > </td> |
| <td class="paramname"><em>filter</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1IDeliveryState.html">IDeliveryState</a> </td> |
| <td class="paramname"><em>state</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>settle</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">filter</td><td>The filter predicate that controls when disposition is applied</td></tr> |
| <tr><td class="paramname">state</td><td>The delivery state to apply when the predicate matches</td></tr> |
| <tr><td class="paramname">settle</td><td>Should the delivery be settled when the predicate matches.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSender.html#a1023dd957dd2749e8e4fc1929cbb2caa">Apache.Qpid.Proton.Engine.Implementation.ProtonSender</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae54102d2e5c233a4f1505bd88ce9e87e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae54102d2e5c233a4f1505bd88ce9e87e">◆ </a></span>Drained()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> Apache.Qpid.Proton.Engine.ISender.Drained </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Called when the remote receiver has requested a drain of credit and the sender has sent all available messages. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This sender instance</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">InvalidOperationException</td><td>If the link is not draining.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSender.html#afdd93a39e34239f311306613ec532419">Apache.Qpid.Proton.Engine.Implementation.ProtonSender</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aaa2d450dd1b09d9f6e99c4b67515e4fe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaa2d450dd1b09d9f6e99c4b67515e4fe">◆ </a></span>Next()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> Apache.Qpid.Proton.Engine.ISender.Next </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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 delivery has not been completed by either calling a completing API method then this method will throw an exception to indicate the sender state cannot allow a new delivery to be started. </p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">InvalidOperationException</td><td>If a current delivery is still incomplete</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSender.html#a8d97fbaba98e085df2bd41ec795c7842">Apache.Qpid.Proton.Engine.Implementation.ProtonSender</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a16fe08a19c094e38b08c88073e7daa7b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a16fe08a19c094e38b08c88073e7daa7b">◆ </a></span>Settle()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> Apache.Qpid.Proton.Engine.ISender.Settle </td> |
| <td>(</td> |
| <td class="paramtype">Predicate< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> > </td> |
| <td class="paramname"><em>filter</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>For each unsettled outgoing delivery that is pending in the sender apply the given predicate and if it matches then settle the delivery. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">filter</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSender.html#a47afb6c3eab98690063cdd3a51b69c37">Apache.Qpid.Proton.Engine.Implementation.ProtonSender</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a027a157615f2ff9c63f5478e1d28f7ba"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a027a157615f2ff9c63f5478e1d28f7ba">◆ </a></span>Current</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a> Apache.Qpid.Proton.Engine.ISender.Current</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the current outgoing delivery 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 outgoing delivery stream bytes methods which allows for later writing of additional bytes to the delivery. Once the write bytes method or the complete API 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 abort method of the outgoing delivery API. </p> |
| |
| </div> |
| </div> |
| <a id="aa6036143e4efaa5a2135948e1ac6935d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa6036143e4efaa5a2135948e1ac6935d">◆ </a></span>DeliveryTagGenerator</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator.html">IDeliveryTagGenerator</a> Apache.Qpid.Proton.Engine.ISender.DeliveryTagGenerator</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures a delivery tag generator that will be used to create and set a delivery tag value on each new outgoing delivery that is created and returned from the sender next delivery method. </p> |
| |
| </div> |
| </div> |
| <a id="a9701da452c5b0600c515930ee8c1b96e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9701da452c5b0600c515930ee8c1b96e">◆ </a></span>HasUnsettled</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Engine.ISender.HasUnsettled</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns true if the sender link is tracking any unsettled sent deliveries. </p> |
| |
| </div> |
| </div> |
| <a id="a19a83e1dbc22100ec4fc42ba0b888202"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a19a83e1dbc22100ec4fc42ba0b888202">◆ </a></span>IsSendable</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Engine.ISender.IsSendable</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Checks if the sender has credit and the session window allows for any bytes to be written currently. </p> |
| |
| </div> |
| </div> |
| <a id="ae5dbe06e9cc94e1f5eba70d2b62a1d68"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae5dbe06e9cc94e1f5eba70d2b62a1d68">◆ </a></span>Unsettled</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IReadOnlyCollection<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IOutgoingDelivery.html">IOutgoingDelivery</a>> Apache.Qpid.Proton.Engine.ISender.Unsettled</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Retrieves the list of unsettled deliveries sent from this sender. The deliveries in the enumerator cannot be written to but can have their settled state and disposition updated. Only when this sender settles on its end are the outgoing delivery instances removed from the unsettled tracking. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton/Engine/ISender.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |
