| <!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.Implementation.ProtonEndpoint< T > Class 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="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation.html">Implementation</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html">ProtonEndpoint</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Base endpoint class that provides some of the most common endpoint implementations and some API for internal use when dealing with events. |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.png" usemap="#Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint_3C_20T_20_3E_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint_3C_20T_20_3E_map" name="Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint_3C_20T_20_3E_map"> |
| <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,378,24"/> |
| <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="0,112,378,136"/> |
| </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:a3ca644cfb874a33e0ea761986206963e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a3ca644cfb874a33e0ea761986206963e">ProtonEndpoint</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngine.html">ProtonEngine</a> engine)</td></tr> |
| <tr class="memdesc:a3ca644cfb874a33e0ea761986206963e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new instance of this endpoint implementation which is owned by the provided engine instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a3ca644cfb874a33e0ea761986206963e">More...</a><br /></td></tr> |
| <tr class="separator:a3ca644cfb874a33e0ea761986206963e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4baf3da525c8358701c18d6b813258fa"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a4baf3da525c8358701c18d6b813258fa">OpenHandler</a> (Action< T > openHandler)</td></tr> |
| <tr class="memdesc:a4baf3da525c8358701c18d6b813258fa"><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="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a4baf3da525c8358701c18d6b813258fa">More...</a><br /></td></tr> |
| <tr class="separator:a4baf3da525c8358701c18d6b813258fa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad3e9c87b36bdb6e169ec485eb3f72884"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#ad3e9c87b36bdb6e169ec485eb3f72884">CloseHandler</a> (Action< T > closeHandler)</td></tr> |
| <tr class="memdesc:ad3e9c87b36bdb6e169ec485eb3f72884"><td class="mdescLeft"> </td><td class="mdescRight">Sets a EventHandler for when an AMQP closing frame is received from the remote peer. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#ad3e9c87b36bdb6e169ec485eb3f72884">More...</a><br /></td></tr> |
| <tr class="separator:ad3e9c87b36bdb6e169ec485eb3f72884"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab5ffcfdd397d5cda95b085139bdf3dc9"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#ab5ffcfdd397d5cda95b085139bdf3dc9">LocalOpenHandler</a> (Action< T > localOpenHandler)</td></tr> |
| <tr class="memdesc:ab5ffcfdd397d5cda95b085139bdf3dc9"><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="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#ab5ffcfdd397d5cda95b085139bdf3dc9">More...</a><br /></td></tr> |
| <tr class="separator:ab5ffcfdd397d5cda95b085139bdf3dc9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa3f4977d6cb8f8bade883945d3e73851"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#aa3f4977d6cb8f8bade883945d3e73851">LocalCloseHandler</a> (Action< T > localCloseHandler)</td></tr> |
| <tr class="memdesc:aa3f4977d6cb8f8bade883945d3e73851"><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="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#aa3f4977d6cb8f8bade883945d3e73851">More...</a><br /></td></tr> |
| <tr class="separator:aa3f4977d6cb8f8bade883945d3e73851"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8a46cc6f1dd8479bf32a47c644f33bec"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a8a46cc6f1dd8479bf32a47c644f33bec">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:a8a46cc6f1dd8479bf32a47c644f33bec"><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="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a8a46cc6f1dd8479bf32a47c644f33bec">More...</a><br /></td></tr> |
| <tr class="separator:a8a46cc6f1dd8479bf32a47c644f33bec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa4d7f0bbfd24c409f5191d3c93d61d45"><td class="memItemLeft" align="right" valign="top">abstract T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#aa4d7f0bbfd24c409f5191d3c93d61d45">Close</a> ()</td></tr> |
| <tr class="memdesc:aa4d7f0bbfd24c409f5191d3c93d61d45"><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="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#aa4d7f0bbfd24c409f5191d3c93d61d45">More...</a><br /></td></tr> |
| <tr class="separator:aa4d7f0bbfd24c409f5191d3c93d61d45"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5063410f811adb769bec83a6c2ddf048"><td class="memItemLeft" align="right" valign="top">abstract T </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a5063410f811adb769bec83a6c2ddf048">Open</a> ()</td></tr> |
| <tr class="memdesc:a5063410f811adb769bec83a6c2ddf048"><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="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html#a5063410f811adb769bec83a6c2ddf048">More...</a><br /></td></tr> |
| <tr class="separator:a5063410f811adb769bec83a6c2ddf048"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:a2d7152a053f587de68958d9b84638321"><td class="memItemLeft" align="right" valign="top"><a id="a2d7152a053f587de68958d9b84638321"></a> |
| readonly <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngine.html">ProtonEngine</a> </td><td class="memItemRight" valign="bottom"><b>engine</b></td></tr> |
| <tr class="separator:a2d7152a053f587de68958d9b84638321"><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:a5d419df0ec4965bf9196cc559c6938aa"><td class="memItemLeft" align="right" valign="top"><a id="a5d419df0ec4965bf9196cc559c6938aa"></a> |
| virtual <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngine.html">IEngine</a> </td><td class="memItemRight" valign="bottom"><b>Engine</b><code> [get]</code></td></tr> |
| <tr class="separator:a5d419df0ec4965bf9196cc559c6938aa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a89fbdaa721c58e56a9dabbac9e6e658f"><td class="memItemLeft" align="right" valign="top"><a id="a89fbdaa721c58e56a9dabbac9e6e658f"></a> |
| <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IAttachments.html">IAttachments</a> </td><td class="memItemRight" valign="bottom"><b>Attachments</b><code> [get]</code></td></tr> |
| <tr class="separator:a89fbdaa721c58e56a9dabbac9e6e658f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aff72c495e605636813527927cc73597e"><td class="memItemLeft" align="right" valign="top"><a id="aff72c495e605636813527927cc73597e"></a> |
| object </td><td class="memItemRight" valign="bottom"><b>LinkedResource</b><code> [get, set]</code></td></tr> |
| <tr class="separator:aff72c495e605636813527927cc73597e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8043d481ed3447b29e61580a8d76d0ab"><td class="memItemLeft" align="right" valign="top"><a id="a8043d481ed3447b29e61580a8d76d0ab"></a> |
| virtual <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1ErrorCondition.html">ErrorCondition</a> </td><td class="memItemRight" valign="bottom"><b>ErrorCondition</b><code> [get, set]</code></td></tr> |
| <tr class="separator:a8043d481ed3447b29e61580a8d76d0ab"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ada6d866ef284a4bc1dc5117a1bdbc6d6"><td class="memItemLeft" align="right" valign="top"><a id="ada6d866ef284a4bc1dc5117a1bdbc6d6"></a> |
| virtual <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1ErrorCondition.html">ErrorCondition</a> </td><td class="memItemRight" valign="bottom"><b>RemoteErrorCondition</b><code> [get, set]</code></td></tr> |
| <tr class="separator:ada6d866ef284a4bc1dc5117a1bdbc6d6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4f256dcb43b94ddace2412bcc44e7a25"><td class="memItemLeft" align="right" valign="top"><a id="a4f256dcb43b94ddace2412bcc44e7a25"></a> |
| abstract bool </td><td class="memItemRight" valign="bottom"><b>IsLocallyOpen</b><code> [get]</code></td></tr> |
| <tr class="separator:a4f256dcb43b94ddace2412bcc44e7a25"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3a1037e4d7687bf5839cf3be1a5d41b8"><td class="memItemLeft" align="right" valign="top"><a id="a3a1037e4d7687bf5839cf3be1a5d41b8"></a> |
| abstract bool </td><td class="memItemRight" valign="bottom"><b>IsLocallyClosed</b><code> [get]</code></td></tr> |
| <tr class="separator:a3a1037e4d7687bf5839cf3be1a5d41b8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a737574ba56e5544ac78389777379de3d"><td class="memItemLeft" align="right" valign="top"><a id="a737574ba56e5544ac78389777379de3d"></a> |
| abstract bool </td><td class="memItemRight" valign="bottom"><b>IsRemotelyOpen</b><code> [get]</code></td></tr> |
| <tr class="separator:a737574ba56e5544ac78389777379de3d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0bffa5cb863857e6aef9786b2e35427e"><td class="memItemLeft" align="right" valign="top"><a id="a0bffa5cb863857e6aef9786b2e35427e"></a> |
| abstract bool </td><td class="memItemRight" valign="bottom"><b>IsRemotelyClosed</b><code> [get]</code></td></tr> |
| <tr class="separator:a0bffa5cb863857e6aef9786b2e35427e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abb52d4732e0a34293bab2a0f18777072"><td class="memItemLeft" align="right" valign="top"><a id="abb52d4732e0a34293bab2a0f18777072"></a> |
| abstract <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><b>OfferedCapabilities</b><code> [get, set]</code></td></tr> |
| <tr class="separator:abb52d4732e0a34293bab2a0f18777072"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afaa31c8852b137db85182c79c9e9bc5f"><td class="memItemLeft" align="right" valign="top"><a id="afaa31c8852b137db85182c79c9e9bc5f"></a> |
| abstract <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><b>DesiredCapabilities</b><code> [get, set]</code></td></tr> |
| <tr class="separator:afaa31c8852b137db85182c79c9e9bc5f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a35df5fc295dfc76df57c56ea3144bb82"><td class="memItemLeft" align="right" valign="top"><a id="a35df5fc295dfc76df57c56ea3144bb82"></a> |
| abstract <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><b>RemoteOfferedCapabilities</b><code> [get]</code></td></tr> |
| <tr class="separator:a35df5fc295dfc76df57c56ea3144bb82"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3d83ef41de8941a0f807c39994848378"><td class="memItemLeft" align="right" valign="top"><a id="a3d83ef41de8941a0f807c39994848378"></a> |
| abstract <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><b>RemoteDesiredCapabilities</b><code> [get]</code></td></tr> |
| <tr class="separator:a3d83ef41de8941a0f807c39994848378"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a29bcb3fe21f43341b7e1dbceb208bea1"><td class="memItemLeft" align="right" valign="top"><a id="a29bcb3fe21f43341b7e1dbceb208bea1"></a> |
| abstract IReadOnlyDictionary< <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>, object > </td><td class="memItemRight" valign="bottom"><b>Properties</b><code> [get, set]</code></td></tr> |
| <tr class="separator:a29bcb3fe21f43341b7e1dbceb208bea1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4d5a65ee02d0bae96571e5bac29bd99d"><td class="memItemLeft" align="right" valign="top"><a id="a4d5a65ee02d0bae96571e5bac29bd99d"></a> |
| abstract IReadOnlyDictionary< <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>, object > </td><td class="memItemRight" valign="bottom"><b>RemoteProperties</b><code> [get]</code></td></tr> |
| <tr class="separator:a4d5a65ee02d0bae96571e5bac29bd99d"><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>Base endpoint class that provides some of the most common endpoint implementations and some API for internal use when dealing with events. </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">Constructor & Destructor Documentation</h2> |
| <a id="a3ca644cfb874a33e0ea761986206963e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3ca644cfb874a33e0ea761986206963e">◆ </a></span>ProtonEndpoint()</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_1Engine_1_1Implementation_1_1ProtonEndpoint.html">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint</a>< T >.<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html">ProtonEndpoint</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEngine.html">ProtonEngine</a> </td> |
| <td class="paramname"><em>engine</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a new instance of this endpoint implementation which is owned by the provided engine instance. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">engine</td><td>The engine that owns this endpoint instance.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aa4d7f0bbfd24c409f5191d3c93d61d45"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa4d7f0bbfd24c409f5191d3c93d61d45">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract T <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint</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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a15b7acdd0d22c2ade430a336a7678a41">Apache.Qpid.Proton.Engine.IEndpoint< T ></a>.</p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonTransactionManager.html#a83d7410c2e77d7e21b49eec497f62345">Apache.Qpid.Proton.Engine.Implementation.ProtonTransactionManager</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonTransactionController.html#aa7e6c6975c035d0e6170221070730a64">Apache.Qpid.Proton.Engine.Implementation.ProtonTransactionController</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html#a5d15d31dc993a840336e66a7f6893ec2">Apache.Qpid.Proton.Engine.Implementation.ProtonSession</a>, and <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>.</p> |
| |
| </div> |
| </div> |
| <a id="ad3e9c87b36bdb6e169ec485eb3f72884"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad3e9c87b36bdb6e169ec485eb3f72884">◆ </a></span>CloseHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint</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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a9a36c96c71b9b677340dcb5476146c82">Apache.Qpid.Proton.Engine.IEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a8a46cc6f1dd8479bf32a47c644f33bec"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8a46cc6f1dd8479bf32a47c644f33bec">◆ </a></span>EngineShutdownHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint</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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ad985e08f80b4efc7d4e9ec236c3b3612">Apache.Qpid.Proton.Engine.IEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="aa3f4977d6cb8f8bade883945d3e73851"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa3f4977d6cb8f8bade883945d3e73851">◆ </a></span>LocalCloseHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint</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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a0f769d3342763f21fb9a5bcd62ab0aee">Apache.Qpid.Proton.Engine.IEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="ab5ffcfdd397d5cda95b085139bdf3dc9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab5ffcfdd397d5cda95b085139bdf3dc9">◆ </a></span>LocalOpenHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint</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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a036cf0b0c5d588a086e24699a0a52b59">Apache.Qpid.Proton.Engine.IEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5063410f811adb769bec83a6c2ddf048"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5063410f811adb769bec83a6c2ddf048">◆ </a></span>Open()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract T <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint</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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ae4e9579365862c944a0cd79fa218d183">Apache.Qpid.Proton.Engine.IEndpoint< T ></a>.</p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonTransactionManager.html#a80b60982a577007d918b39e0f31dd0ac">Apache.Qpid.Proton.Engine.Implementation.ProtonTransactionManager</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonTransactionController.html#a2742a564d72b34a22f07cbb97bf9d71c">Apache.Qpid.Proton.Engine.Implementation.ProtonTransactionController</a>, <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html#a208dcc3e9e9dedd6d624fccc48903b5a">Apache.Qpid.Proton.Engine.Implementation.ProtonSession</a>, and <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>.</p> |
| |
| </div> |
| </div> |
| <a id="a4baf3da525c8358701c18d6b813258fa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4baf3da525c8358701c18d6b813258fa">◆ </a></span>OpenHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonEndpoint.html">Apache.Qpid.Proton.Engine.Implementation.ProtonEndpoint</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> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </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>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a007ae977fc124ddc836f315d018ab05d">Apache.Qpid.Proton.Engine.IEndpoint< T ></a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton/Engine/Implementation/ProtonEndpoint.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> |
