| <!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.IEndpoint< T > Interface Template 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_1IEndpoint.html">IEndpoint</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_1IEndpoint-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Engine.IEndpoint< T > Interface Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Represents an AMQP Connection which is owned by a single engine instance |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Engine.IEndpoint< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.png" usemap="#Apache.Qpid.Proton.Engine.IEndpoint_3C_20T_20_3E_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Engine.IEndpoint_3C_20T_20_3E_map" name="Apache.Qpid.Proton.Engine.IEndpoint_3C_20T_20_3E_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="388,56,766,80"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html" title="Base endpoint class that provides some of the most common endpoint implementations and some API for i..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >" shape="rect" coords="1164,56,1542,80"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IReceiver.html" title="AMQP Receiver link resource." alt="Apache.Qpid.Proton.Engine.IReceiver" shape="rect" coords="0,112,378,136"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html" title="AMQP Sender link resource." alt="Apache.Qpid.Proton.Engine.ISender" shape="rect" coords="388,112,766,136"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonLink.html" title="Common base for Sender and Receiver links which provides services that both endpoints require that ar..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonLink< T >" shape="rect" coords="776,112,1154,136"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonLink.html" title="Common base for Sender and Receiver links which provides services that both endpoints require that ar..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonLink< T >" shape="rect" coords="1164,112,1542,136"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonReceiver.html" title="Proton Receiver link implementation which manages the receipt of new deliveries and credit associated..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonReceiver" shape="rect" coords="0,168,378,192"/> |
| <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="388,168,766,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:ae4e9579365862c944a0cd79fa218d183"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a15b7acdd0d22c2ade430a336a7678a41"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a036cf0b0c5d588a086e24699a0a52b59"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f769d3342763f21fb9a5bcd62ab0aee"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a007ae977fc124ddc836f315d018ab05d"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9a36c96c71b9b677340dcb5476146c82"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad985e08f80b4efc7d4e9ec236c3b3612"><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"><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"><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:acf2de4c97690fa4fd673461dcbb37db5"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac2fb9813280c594a67f269c99b127686"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a25bdf8458c47a47339a23de1b5667540"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a483d1c5582cbeeec1b97be0ba0da8f0a"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4578fff3125a050d7126952b7fde08b2"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6395c22a29e16f3f90f67729b2bc9d1a"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab33b409da9ba52367721407ab4bbd31f"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a94174c5f25e62b8b95492a92c6f4e63a"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac4457742b6167578c6cfffdc0bec405b"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aca301979e4ab47a2ff142966e073ccfd"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa5a2b6e00125c05df60fe373c1368366"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adc18f13e8a13f1cb9c891f0a89479db5"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5b30574efe967b7c8b2be36fce5c086b"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afb420de3356b1ca05f2f9f109262916b"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7bef5964f1a780579627bbc569a05028"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Represents an AMQP Connection which is owned by a single engine instance </p> |
| <div class="typeconstraint"> |
| <dl><dt><b>Type Constraints</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"><em>T</em></td><td> :</td><td valign="top"><em><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">IEndpoint</a><T></em></td><td> </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a15b7acdd0d22c2ade430a336a7678a41"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a15b7acdd0d22c2ade430a336a7678a41">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Close.html">Close</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This endpoint instance.</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">EngineStateException</td><td>If the engine state is already failed or shutdown</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonLink.html#a8bfab840f0bb1b21461d10687d1cae35">Apache.Qpid.Proton.Engine.Implementation.ProtonLink< T ></a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#aa4d7f0bbfd24c409f5191d3c93d61d45">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a9a36c96c71b9b677340dcb5476146c82"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9a36c96c71b9b677340dcb5476146c82">◆ </a></span>CloseHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.CloseHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< T > </td> |
| <td class="paramname"><em>localCloseHandler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets a EventHandler for when an AMQP closing frame is received from the remote peer. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">localCloseHandler</td><td>The handler to invoke when the event occurs</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This Endpoint instance.</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#ad3e9c87b36bdb6e169ec485eb3f72884">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad985e08f80b4efc7d4e9ec236c3b3612"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad985e08f80b4efc7d4e9ec236c3b3612">◆ </a></span>EngineShutdownHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.EngineShutdownHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngine.html">IEngine</a> > </td> |
| <td class="paramname"><em>shutdownHandler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">shutdownHandler</td><td>The handler to invoke when the event occurs</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This Endpoint instance.</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a8a46cc6f1dd8479bf32a47c644f33bec">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a0f769d3342763f21fb9a5bcd62ab0aee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0f769d3342763f21fb9a5bcd62ab0aee">◆ </a></span>LocalCloseHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.LocalCloseHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< T > </td> |
| <td class="paramname"><em>localCloseHandler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">localCloseHandler</td><td>The handler to invoke when the event occurs</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This Endpoint instance.</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#aa3f4977d6cb8f8bade883945d3e73851">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a036cf0b0c5d588a086e24699a0a52b59"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a036cf0b0c5d588a086e24699a0a52b59">◆ </a></span>LocalOpenHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.LocalOpenHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< T > </td> |
| <td class="paramname"><em>localOpenHandler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">localOpenHandler</td><td>The handler to invoke when the event occurs</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This Endpoint instance.</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#ab5ffcfdd397d5cda95b085139bdf3dc9">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae4e9579365862c944a0cd79fa218d183"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae4e9579365862c944a0cd79fa218d183">◆ </a></span>Open()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1Open.html">Open</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This endpoint instance.</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">EngineStateException</td><td>If the engine state is already failed or shutdown</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonLink.html#a1180d23f941a04c30026ae181906eca0">Apache.Qpid.Proton.Engine.Implementation.ProtonLink< T ></a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a5063410f811adb769bec83a6c2ddf048">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a007ae977fc124ddc836f315d018ab05d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a007ae977fc124ddc836f315d018ab05d">◆ </a></span>OpenHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.OpenHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< T > </td> |
| <td class="paramname"><em>localOpenHandler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">localOpenHandler</td><td>The handler to invoke when the event occurs</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This Endpoint instance.</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a4baf3da525c8358701c18d6b813258fa">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="ac2fb9813280c594a67f269c99b127686"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac2fb9813280c594a67f269c99b127686">◆ </a></span>Attachments</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_1IAttachments.html">IAttachments</a> <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.Attachments</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>Access the attachments instance that is associated with this resource where the application can store data relevant to the endpoint for later use. </p> |
| |
| </div> |
| </div> |
| <a id="aa5a2b6e00125c05df60fe373c1368366"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa5a2b6e00125c05df60fe373c1368366">◆ </a></span>DesiredCapabilities</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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> [] <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.DesiredCapabilities</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>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. </p> |
| |
| </div> |
| </div> |
| <a id="acf2de4c97690fa4fd673461dcbb37db5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acf2de4c97690fa4fd673461dcbb37db5">◆ </a></span>Engine</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_1IEngine.html">IEngine</a> <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.Engine</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>Provides access to the engine instance that owns the resources of this endpoint and its parent. </p> |
| |
| </div> |
| </div> |
| <a id="a483d1c5582cbeeec1b97be0ba0da8f0a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a483d1c5582cbeeec1b97be0ba0da8f0a">◆ </a></span>ErrorCondition</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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1ErrorCondition.html">ErrorCondition</a> <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1ErrorCondition.html">ErrorCondition</a></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>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. </p> |
| |
| </div> |
| </div> |
| <a id="ab33b409da9ba52367721407ab4bbd31f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab33b409da9ba52367721407ab4bbd31f">◆ </a></span>IsLocallyClosed</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.IsLocallyClosed</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 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. </p> |
| |
| </div> |
| </div> |
| <a id="a6395c22a29e16f3f90f67729b2bc9d1a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6395c22a29e16f3f90f67729b2bc9d1a">◆ </a></span>IsLocallyOpen</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.IsLocallyOpen</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 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. </p> |
| |
| </div> |
| </div> |
| <a id="ac4457742b6167578c6cfffdc0bec405b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac4457742b6167578c6cfffdc0bec405b">◆ </a></span>IsRemotelyClosed</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.IsRemotelyClosed</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 this endpoint is currently remotely closed meaning that the AMQP performative that completes the close phase of this endpoint's lifetime has arrived. </p> |
| |
| </div> |
| </div> |
| <a id="a94174c5f25e62b8b95492a92c6f4e63a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a94174c5f25e62b8b95492a92c6f4e63a">◆ </a></span>IsRemotelyOpen</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.IsRemotelyOpen</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 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. </p> |
| |
| </div> |
| </div> |
| <a id="a25bdf8458c47a47339a23de1b5667540"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a25bdf8458c47a47339a23de1b5667540">◆ </a></span>LinkedResource</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">object <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.LinkedResource</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>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. </p> |
| |
| </div> |
| </div> |
| <a id="aca301979e4ab47a2ff142966e073ccfd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aca301979e4ab47a2ff142966e073ccfd">◆ </a></span>OfferedCapabilities</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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> [] <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.OfferedCapabilities</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>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. </p> |
| |
| </div> |
| </div> |
| <a id="adc18f13e8a13f1cb9c891f0a89479db5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adc18f13e8a13f1cb9c891f0a89479db5">◆ </a></span>Properties</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IReadOnlyDictionary<<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>, object> <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.Properties</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>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. </p> |
| |
| </div> |
| </div> |
| <a id="afb420de3356b1ca05f2f9f109262916b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afb420de3356b1ca05f2f9f109262916b">◆ </a></span>RemoteDesiredCapabilities</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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> [] <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.RemoteDesiredCapabilities</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>The capabilities desired by the remote when it opened its end of the endpoint. </p> |
| |
| </div> |
| </div> |
| <a id="a4578fff3125a050d7126952b7fde08b2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4578fff3125a050d7126952b7fde08b2">◆ </a></span>RemoteErrorCondition</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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1ErrorCondition.html">ErrorCondition</a> <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.RemoteErrorCondition</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>If the remote has closed this endpoint and provided an ErrorCondition as part of the closing AMQP performative then this method will return it. </p> |
| |
| </div> |
| </div> |
| <a id="a5b30574efe967b7c8b2be36fce5c086b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5b30574efe967b7c8b2be36fce5c086b">◆ </a></span>RemoteOfferedCapabilities</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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> [] <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.RemoteOfferedCapabilities</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>The capabilities offered by the remote when it opened its end of the endpoint. </p> |
| |
| </div> |
| </div> |
| <a id="a7bef5964f1a780579627bbc569a05028"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7bef5964f1a780579627bbc569a05028">◆ </a></span>RemoteProperties</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IReadOnlyDictionary<<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>, object> <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint</a>< T >.RemoteProperties</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>The properties sent by the remote when it opened its end of this endpoint. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton/Engine/IEndpoint.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> |
