| <!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.ISession Interface Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Proton DotNet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html">ISession</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_1ISession-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Engine.ISession Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The engine pipeline contains a list of handlers that deal with incoming and outgoing AMQP frames such as logging and encoders and decoders. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Engine.ISession:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.png" usemap="#Apache.Qpid.Proton.Engine.ISession_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Engine.ISession_map" name="Apache.Qpid.Proton.Engine.ISession_map"> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html" alt="Apache.Qpid.Proton.Engine.IEndpoint< ISession >" shape="rect" coords="0,0,342,24"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html" title="Implements the mechanics of managing a single AMQP session associated with the provided connection in..." alt="Apache.Qpid.Proton.Engine.Implementation.ProtonSession" shape="rect" coords="0,112,342,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:a6b4412039c69d4acb303e0fd5461353d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a6b4412039c69d4acb303e0fd5461353d">Sender</a> (string name)</td></tr> |
| <tr class="memdesc:a6b4412039c69d4acb303e0fd5461353d"><td class="mdescLeft"> </td><td class="mdescRight">Create a new sender link using the provided name. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a6b4412039c69d4acb303e0fd5461353d">More...</a><br /></td></tr> |
| <tr class="separator:a6b4412039c69d4acb303e0fd5461353d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6feee5e75ad22109753bbf374bd5f272"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IReceiver.html">IReceiver</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a6feee5e75ad22109753bbf374bd5f272">Receiver</a> (string name)</td></tr> |
| <tr class="memdesc:a6feee5e75ad22109753bbf374bd5f272"><td class="mdescLeft"> </td><td class="mdescRight">Create a new receiver link using the provided name. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a6feee5e75ad22109753bbf374bd5f272">More...</a><br /></td></tr> |
| <tr class="separator:a6feee5e75ad22109753bbf374bd5f272"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a70e23cab1554f81f95566d5d6f657bbf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ITransactionController.html">ITransactionController</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a70e23cab1554f81f95566d5d6f657bbf">Coordinator</a> (string name)</td></tr> |
| <tr class="memdesc:a70e23cab1554f81f95566d5d6f657bbf"><td class="mdescLeft"> </td><td class="mdescRight">Create a new transaction controller link using the provided name. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a70e23cab1554f81f95566d5d6f657bbf">More...</a><br /></td></tr> |
| <tr class="separator:a70e23cab1554f81f95566d5d6f657bbf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a38360ddec884a6f8a56b655e18fc752c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html">ISession</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a38360ddec884a6f8a56b655e18fc752c">ReceiverOpenHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IReceiver.html">IReceiver</a> > handler)</td></tr> |
| <tr class="memdesc:a38360ddec884a6f8a56b655e18fc752c"><td class="mdescLeft"> </td><td class="mdescRight">Sets a delegate for when an AMQP Attach frame is received from the remote peer for a sending link attach. Used to process remotely initiated sending link. Locally initiated links have their own handlers invoked instead. This method is Typically used by servers to listen for remote receiver creation. If an event handler for remote sender open is registered on this Session for a link scoped to it then this handler will be invoked instead of the variant in the Connection API. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a38360ddec884a6f8a56b655e18fc752c">More...</a><br /></td></tr> |
| <tr class="separator:a38360ddec884a6f8a56b655e18fc752c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad658927f3cc43aa93364c1dcf9f30bda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html">ISession</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#ad658927f3cc43aa93364c1dcf9f30bda">SenderOpenHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> > handler)</td></tr> |
| <tr class="memdesc:ad658927f3cc43aa93364c1dcf9f30bda"><td class="mdescLeft"> </td><td class="mdescRight">Sets a delegate for when an AMQP Attach frame is received from the remote peer for a receiving link attach. Used to process remotely initiated receiving link. Locally initiated links have their own handlers invoked instead. This method is Typically used by servers to listen for remote sender creation. If an event handler for remote sender open is registered on this Session for a link scoped to it then this handler will be invoked instead of the variant in the Connection API. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#ad658927f3cc43aa93364c1dcf9f30bda">More...</a><br /></td></tr> |
| <tr class="separator:ad658927f3cc43aa93364c1dcf9f30bda"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a67310b6a196f42d17d4141a027a571ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html">ISession</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a67310b6a196f42d17d4141a027a571ba">TransactionManagerOpenedHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ITransactionManager.html">ITransactionManager</a> > handler)</td></tr> |
| <tr class="memdesc:a67310b6a196f42d17d4141a027a571ba"><td class="mdescLeft"> </td><td class="mdescRight">Sets a delegate for when an AMQP Attach frame is received from the remote peer for a transaction manager link attach. Used to process remotely initiated transaction managers. Locally initiated links have their own handlers invoked instead. This method is Typically used by servers to listen for remote resource creation. If an event handler for remote sender open is registered on this Session for a link scoped to it then this handler will be invoked instead of the variant in the Connection API. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a67310b6a196f42d17d4141a027a571ba">More...</a><br /></td></tr> |
| <tr class="separator:a67310b6a196f42d17d4141a027a571ba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afcbb0840272d535bae8120339b51f8b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html">ISession</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#afcbb0840272d535bae8120339b51f8b6">DeliveryReadHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> > handler)</td></tr> |
| <tr class="memdesc:afcbb0840272d535bae8120339b51f8b6"><td class="mdescLeft"> </td><td class="mdescRight">Allows monitoring of incoming deliveries to receivers attached to this <a class="el" href="">Session</a>. The Receiver that is the target of the incoming delivery will be notified first of the incoming delivery and any processing should be done using the Receiver DeliveryReadHandler API. This event point will be trigger only after the Receiver level handler and should be used to monitor deliveries passing through a session for logging or other state related actions performed by the service managing this session. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#afcbb0840272d535bae8120339b51f8b6">More...</a><br /></td></tr> |
| <tr class="separator:afcbb0840272d535bae8120339b51f8b6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html">Apache.Qpid.Proton.Engine.IEndpoint< ISession ></a></td></tr> |
| <tr class="memitem:ae4e9579365862c944a0cd79fa218d183 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ae4e9579365862c944a0cd79fa218d183">Open</a> ()</td></tr> |
| <tr class="memdesc:ae4e9579365862c944a0cd79fa218d183 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Open the end point locally, sending the Open performative immediately if possible or holding it until SASL negotiations or the AMQP header exchange and other required performative exchanges has completed. The endpoint will signal any registered handler of the remote opening the endpoint once the remote performative that signals open completion arrives. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ae4e9579365862c944a0cd79fa218d183">More...</a><br /></td></tr> |
| <tr class="separator:ae4e9579365862c944a0cd79fa218d183 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a15b7acdd0d22c2ade430a336a7678a41 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a15b7acdd0d22c2ade430a336a7678a41">Close</a> ()</td></tr> |
| <tr class="memdesc:a15b7acdd0d22c2ade430a336a7678a41 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Close the end point locally and send the closing performative immediately if possible or holds it until the Connection / Engine state allows it. If the engine encounters an error writing the performative or the engine is in a failed state from a previous error then this method will throw an exception. If the engine has been shutdown then this method will close out the local end of the endpoint and clean up any local resources before returning normally. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a15b7acdd0d22c2ade430a336a7678a41">More...</a><br /></td></tr> |
| <tr class="separator:a15b7acdd0d22c2ade430a336a7678a41 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a036cf0b0c5d588a086e24699a0a52b59 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a036cf0b0c5d588a086e24699a0a52b59">LocalOpenHandler</a> (Action< T > localOpenHandler)</td></tr> |
| <tr class="memdesc:a036cf0b0c5d588a086e24699a0a52b59 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Sets a Action for when an this endpoint is opened locally via a call to Open. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined. Typically used by clients as servers will typically listen to some parent resource event handler to determine if the remote is initiating a resource open. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a036cf0b0c5d588a086e24699a0a52b59">More...</a><br /></td></tr> |
| <tr class="separator:a036cf0b0c5d588a086e24699a0a52b59 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f769d3342763f21fb9a5bcd62ab0aee inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a0f769d3342763f21fb9a5bcd62ab0aee">LocalCloseHandler</a> (Action< T > localCloseHandler)</td></tr> |
| <tr class="memdesc:a0f769d3342763f21fb9a5bcd62ab0aee inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Sets a Action for when an this endpoint is closed locally via a call to Close. Typically used by clients for logging or other state update event processing. Clients should not perform any blocking calls within this context. It is an error for the handler to throw an exception and the outcome of doing so is undefined. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a0f769d3342763f21fb9a5bcd62ab0aee">More...</a><br /></td></tr> |
| <tr class="separator:a0f769d3342763f21fb9a5bcd62ab0aee inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a007ae977fc124ddc836f315d018ab05d inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a007ae977fc124ddc836f315d018ab05d">OpenHandler</a> (Action< T > localOpenHandler)</td></tr> |
| <tr class="memdesc:a007ae977fc124ddc836f315d018ab05d inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Sets a Action for when an AMQP Open frame is received from the remote peer. Used to process remotely initiated Connections. Locally initiated sessions have their own Action invoked instead. This method is typically used by servers to listen for the remote peer to open its endpoint, while a client would listen for the server to open its end of the endpoint once a local open has been performed. Typically used by clients as servers will typically listen to some parent resource event handler to determine if the remote is initiating a resource open. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a007ae977fc124ddc836f315d018ab05d">More...</a><br /></td></tr> |
| <tr class="separator:a007ae977fc124ddc836f315d018ab05d inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9a36c96c71b9b677340dcb5476146c82 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a9a36c96c71b9b677340dcb5476146c82">CloseHandler</a> (Action< T > localCloseHandler)</td></tr> |
| <tr class="memdesc:a9a36c96c71b9b677340dcb5476146c82 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Sets a EventHandler for when an AMQP closing frame is received from the remote peer. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#a9a36c96c71b9b677340dcb5476146c82">More...</a><br /></td></tr> |
| <tr class="separator:a9a36c96c71b9b677340dcb5476146c82 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad985e08f80b4efc7d4e9ec236c3b3612 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ad985e08f80b4efc7d4e9ec236c3b3612">EngineShutdownHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEngine.html">IEngine</a> > shutdownHandler)</td></tr> |
| <tr class="memdesc:ad985e08f80b4efc7d4e9ec236c3b3612 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="mdescLeft"> </td><td class="mdescRight">Sets an Action that is invoked when the engine that supports this endpoint is shutdown which indicates a desire to terminate all engine operations. Any endpoint that has been both locally and remotely closed will not receive this event as it will no longer be tracked by the parent its parent endpoint. A typical use of this event would be from a locally closed endpoint that is awaiting response from the remote. If this event fires then there will never be a remote response to any pending operations and the client or server instance should react accordingly to clean up any related resources etc. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint.html#ad985e08f80b4efc7d4e9ec236c3b3612">More...</a><br /></td></tr> |
| <tr class="separator:ad985e08f80b4efc7d4e9ec236c3b3612 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IEndpoint"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:aab535b770facc55e7f867024cdd4f7e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IConnection.html">IConnection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#aab535b770facc55e7f867024cdd4f7e0">Connection</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aab535b770facc55e7f867024cdd4f7e0"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the connection that owns this session endpoint. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#aab535b770facc55e7f867024cdd4f7e0">More...</a><br /></td></tr> |
| <tr class="separator:aab535b770facc55e7f867024cdd4f7e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a926dbee715827c8d6c15f9ccbba4b420"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#a4cc1373ad3202432a02c710ae7e6e94b">SessionState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a926dbee715827c8d6c15f9ccbba4b420">State</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a926dbee715827c8d6c15f9ccbba4b420"><td class="mdescLeft"> </td><td class="mdescRight">Access the session state for the local end of the session. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a926dbee715827c8d6c15f9ccbba4b420">More...</a><br /></td></tr> |
| <tr class="separator:a926dbee715827c8d6c15f9ccbba4b420"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a18aa11b5771cc96e0b0412c69d690be7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#a4cc1373ad3202432a02c710ae7e6e94b">SessionState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a18aa11b5771cc96e0b0412c69d690be7">RemoteState</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a18aa11b5771cc96e0b0412c69d690be7"><td class="mdescLeft"> </td><td class="mdescRight">Access the session state for the remote end of the session. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a18aa11b5771cc96e0b0412c69d690be7">More...</a><br /></td></tr> |
| <tr class="separator:a18aa11b5771cc96e0b0412c69d690be7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6ebe99016a48c9bd44dd23a2a963d7ec"><td class="memItemLeft" align="right" valign="top">IEnumerable< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IReceiver.html">IReceiver</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a6ebe99016a48c9bd44dd23a2a963d7ec">Receivers</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6ebe99016a48c9bd44dd23a2a963d7ec"><td class="mdescLeft"> </td><td class="mdescRight">Returns an enumerator of all the receivers currently tracked by this session. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a6ebe99016a48c9bd44dd23a2a963d7ec">More...</a><br /></td></tr> |
| <tr class="separator:a6ebe99016a48c9bd44dd23a2a963d7ec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acade25d729ae3f940d482faa0d99ad2e"><td class="memItemLeft" align="right" valign="top">IEnumerable< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#acade25d729ae3f940d482faa0d99ad2e">Senders</a><code> [get]</code></td></tr> |
| <tr class="memdesc:acade25d729ae3f940d482faa0d99ad2e"><td class="mdescLeft"> </td><td class="mdescRight">Returns an enumerator of all the senders currently tracked by this session. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#acade25d729ae3f940d482faa0d99ad2e">More...</a><br /></td></tr> |
| <tr class="separator:acade25d729ae3f940d482faa0d99ad2e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a879e2895fc687fb8af59f929faf5df1c"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a879e2895fc687fb8af59f929faf5df1c">IncomingCapacity</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a879e2895fc687fb8af59f929faf5df1c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum number of bytes this session can be sent from the remote. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a879e2895fc687fb8af59f929faf5df1c">More...</a><br /></td></tr> |
| <tr class="separator:a879e2895fc687fb8af59f929faf5df1c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a47c35b931ef3e4fe4e794b1df28a0d51"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a47c35b931ef3e4fe4e794b1df28a0d51">RemainingIncomingCapacity</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a47c35b931ef3e4fe4e794b1df28a0d51"><td class="mdescLeft"> </td><td class="mdescRight">The remaining session incoming capacity based on how many bytes are currently pending, <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a47c35b931ef3e4fe4e794b1df28a0d51">More...</a><br /></td></tr> |
| <tr class="separator:a47c35b931ef3e4fe4e794b1df28a0d51"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a31b4c8d1beef6f01685db93803e6f7d6"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a31b4c8d1beef6f01685db93803e6f7d6">OutgoingCapacity</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a31b4c8d1beef6f01685db93803e6f7d6"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum number of bytes this session can have written write before blocking additional sends until the written bytes are known to have been flushed to the I/O. This limit is intended to deal with issues of memory allocation when the I/O layer allows for asynchronous writes and finer grained control over the pending write buffers is needed. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a31b4c8d1beef6f01685db93803e6f7d6">More...</a><br /></td></tr> |
| <tr class="separator:a31b4c8d1beef6f01685db93803e6f7d6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae7a25813953c1b24763c853ed6d69c75"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#ae7a25813953c1b24763c853ed6d69c75">RemainingOutgoingCapacity</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae7a25813953c1b24763c853ed6d69c75"><td class="mdescLeft"> </td><td class="mdescRight">The remaining session outgoing capacity based on how many bytes are currently pending, <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#ae7a25813953c1b24763c853ed6d69c75">More...</a><br /></td></tr> |
| <tr class="separator:ae7a25813953c1b24763c853ed6d69c75"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a74ad9d6992686c0edd64fa4776e84951"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a74ad9d6992686c0edd64fa4776e84951">HandleMax</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a74ad9d6992686c0edd64fa4776e84951"><td class="mdescLeft"> </td><td class="mdescRight">Set the handle max value for this Session which is the highest possible link handle that can be open at one time before new attach request are rejected. The handle max value can only be modified prior to a call to session open, once the session has been opened locally an error will be thrown if this method is called. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a74ad9d6992686c0edd64fa4776e84951">More...</a><br /></td></tr> |
| <tr class="separator:a74ad9d6992686c0edd64fa4776e84951"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a27c421b15d3f74bd72616a7cc903509f"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a27c421b15d3f74bd72616a7cc903509f">RemoteHandleMax</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a27c421b15d3f74bd72616a7cc903509f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the remote handle max to determine how many links could be attached before the remote will refuse incoming attach requests. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html#a27c421b15d3f74bd72616a7cc903509f">More...</a><br /></td></tr> |
| <tr class="separator:a27c421b15d3f74bd72616a7cc903509f"><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< ISession ></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>The engine pipeline contains a list of handlers that deal with incoming and outgoing AMQP frames such as logging and encoders and decoders. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a70e23cab1554f81f95566d5d6f657bbf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a70e23cab1554f81f95566d5d6f657bbf">◆ </a></span>Coordinator()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ITransactionController.html">ITransactionController</a> Apache.Qpid.Proton.Engine.ISession.Coordinator </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a new transaction controller link using the provided name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The link name to assign the new sender</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The newly created transaction controller</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">InvalidOperationException</td><td>If the session is closed"</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html#adf9d0c7e8cf7ba53d72118e0d3091808">Apache.Qpid.Proton.Engine.Implementation.ProtonSession</a>.</p> |
| |
| </div> |
| </div> |
| <a id="afcbb0840272d535bae8120339b51f8b6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afcbb0840272d535bae8120339b51f8b6">◆ </a></span>DeliveryReadHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html">ISession</a> Apache.Qpid.Proton.Engine.ISession.DeliveryReadHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IIncomingDelivery.html">IIncomingDelivery</a> > </td> |
| <td class="paramname"><em>handler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allows monitoring of incoming deliveries to receivers attached to this <a class="el" href="">Session</a>. The Receiver that is the target of the incoming delivery will be notified first of the incoming delivery and any processing should be done using the Receiver DeliveryReadHandler API. This event point will be trigger only after the Receiver level handler and should be used to monitor deliveries passing through a session for logging or other state related actions performed by the service managing this session. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handler</td><td>Handler that is signalled that a receiver read a new delivery</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This session instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html#a8c3d44d9017708a785f5eba4b619ea60">Apache.Qpid.Proton.Engine.Implementation.ProtonSession</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a6feee5e75ad22109753bbf374bd5f272"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6feee5e75ad22109753bbf374bd5f272">◆ </a></span>Receiver()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IReceiver.html">IReceiver</a> Apache.Qpid.Proton.Engine.ISession.Receiver </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a new receiver link using the provided name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The link name to assign the new sender</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The newly created receiver instance</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">InvalidOperationException</td><td>If the session is closed"</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html#a9c769a7222976cf00ba6695d525a1d79">Apache.Qpid.Proton.Engine.Implementation.ProtonSession</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a38360ddec884a6f8a56b655e18fc752c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a38360ddec884a6f8a56b655e18fc752c">◆ </a></span>ReceiverOpenHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html">ISession</a> Apache.Qpid.Proton.Engine.ISession.ReceiverOpenHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IReceiver.html">IReceiver</a> > </td> |
| <td class="paramname"><em>handler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets a delegate for when an AMQP Attach frame is received from the remote peer for a sending link attach. Used to process remotely initiated sending link. Locally initiated links have their own handlers invoked instead. This method is Typically used by servers to listen for remote receiver creation. If an event handler for remote sender open is registered on this Session for a link scoped to it then this handler will be invoked instead of the variant in the Connection API. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handler</td><td>The delegate that will handle this event</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This session instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html#afced8a6f378511310717d38fa2613062">Apache.Qpid.Proton.Engine.Implementation.ProtonSession</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a6b4412039c69d4acb303e0fd5461353d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6b4412039c69d4acb303e0fd5461353d">◆ </a></span>Sender()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> Apache.Qpid.Proton.Engine.ISession.Sender </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a new sender link using the provided name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The link name to assign the new sender</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The newly created sender instance</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">InvalidOperationException</td><td>If the session is closed"</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html#a27e5dc24c5f93fe336fa10fe7b97a48c">Apache.Qpid.Proton.Engine.Implementation.ProtonSession</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad658927f3cc43aa93364c1dcf9f30bda"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad658927f3cc43aa93364c1dcf9f30bda">◆ </a></span>SenderOpenHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html">ISession</a> Apache.Qpid.Proton.Engine.ISession.SenderOpenHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a> > </td> |
| <td class="paramname"><em>handler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets a delegate for when an AMQP Attach frame is received from the remote peer for a receiving link attach. Used to process remotely initiated receiving link. Locally initiated links have their own handlers invoked instead. This method is Typically used by servers to listen for remote sender creation. If an event handler for remote sender open is registered on this Session for a link scoped to it then this handler will be invoked instead of the variant in the Connection API. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handler</td><td>The delegate that will handle this event</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This session instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html#a28f38873d06940717fb053738db3508f">Apache.Qpid.Proton.Engine.Implementation.ProtonSession</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a67310b6a196f42d17d4141a027a571ba"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a67310b6a196f42d17d4141a027a571ba">◆ </a></span>TransactionManagerOpenedHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISession.html">ISession</a> Apache.Qpid.Proton.Engine.ISession.TransactionManagerOpenedHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ITransactionManager.html">ITransactionManager</a> > </td> |
| <td class="paramname"><em>handler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets a delegate for when an AMQP Attach frame is received from the remote peer for a transaction manager link attach. Used to process remotely initiated transaction managers. Locally initiated links have their own handlers invoked instead. This method is Typically used by servers to listen for remote resource creation. If an event handler for remote sender open is registered on this Session for a link scoped to it then this handler will be invoked instead of the variant in the Connection API. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handler</td><td>The delegate that will handle this event</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This session instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1ProtonSession.html#a30c7a648440a743a9a7a1f0f7e3b68d3">Apache.Qpid.Proton.Engine.Implementation.ProtonSession</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="aab535b770facc55e7f867024cdd4f7e0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aab535b770facc55e7f867024cdd4f7e0">◆ </a></span>Connection</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_1IConnection.html">IConnection</a> Apache.Qpid.Proton.Engine.ISession.Connection</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 connection that owns this session endpoint. </p> |
| |
| </div> |
| </div> |
| <a id="a74ad9d6992686c0edd64fa4776e84951"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a74ad9d6992686c0edd64fa4776e84951">◆ </a></span>HandleMax</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint Apache.Qpid.Proton.Engine.ISession.HandleMax</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>Set the handle max value for this Session which is the highest possible link handle that can be open at one time before new attach request are rejected. The handle max value can only be modified prior to a call to session open, once the session has been opened locally an error will be thrown if this method is called. </p> |
| |
| </div> |
| </div> |
| <a id="a879e2895fc687fb8af59f929faf5df1c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a879e2895fc687fb8af59f929faf5df1c">◆ </a></span>IncomingCapacity</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint Apache.Qpid.Proton.Engine.ISession.IncomingCapacity</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>Sets the maximum number of bytes this session can be sent from the remote. </p> |
| |
| </div> |
| </div> |
| <a id="a31b4c8d1beef6f01685db93803e6f7d6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a31b4c8d1beef6f01685db93803e6f7d6">◆ </a></span>OutgoingCapacity</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint Apache.Qpid.Proton.Engine.ISession.OutgoingCapacity</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>Sets the maximum number of bytes this session can have written write before blocking additional sends until the written bytes are known to have been flushed to the I/O. This limit is intended to deal with issues of memory allocation when the I/O layer allows for asynchronous writes and finer grained control over the pending write buffers is needed. </p> |
| |
| </div> |
| </div> |
| <a id="a6ebe99016a48c9bd44dd23a2a963d7ec"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6ebe99016a48c9bd44dd23a2a963d7ec">◆ </a></span>Receivers</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IEnumerable<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IReceiver.html">IReceiver</a>> Apache.Qpid.Proton.Engine.ISession.Receivers</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 an enumerator of all the receivers currently tracked by this session. </p> |
| |
| </div> |
| </div> |
| <a id="a47c35b931ef3e4fe4e794b1df28a0d51"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a47c35b931ef3e4fe4e794b1df28a0d51">◆ </a></span>RemainingIncomingCapacity</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint Apache.Qpid.Proton.Engine.ISession.RemainingIncomingCapacity</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 remaining session incoming capacity based on how many bytes are currently pending, </p> |
| |
| </div> |
| </div> |
| <a id="ae7a25813953c1b24763c853ed6d69c75"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae7a25813953c1b24763c853ed6d69c75">◆ </a></span>RemainingOutgoingCapacity</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint Apache.Qpid.Proton.Engine.ISession.RemainingOutgoingCapacity</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 remaining session outgoing capacity based on how many bytes are currently pending, </p> |
| |
| </div> |
| </div> |
| <a id="a27c421b15d3f74bd72616a7cc903509f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a27c421b15d3f74bd72616a7cc903509f">◆ </a></span>RemoteHandleMax</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint Apache.Qpid.Proton.Engine.ISession.RemoteHandleMax</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the remote handle max to determine how many links could be attached before the remote will refuse incoming attach requests. </p> |
| |
| </div> |
| </div> |
| <a id="a18aa11b5771cc96e0b0412c69d690be7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a18aa11b5771cc96e0b0412c69d690be7">◆ </a></span>RemoteState</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="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#a4cc1373ad3202432a02c710ae7e6e94b">SessionState</a> Apache.Qpid.Proton.Engine.ISession.RemoteState</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 session state for the remote end of the session. </p> |
| |
| </div> |
| </div> |
| <a id="acade25d729ae3f940d482faa0d99ad2e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acade25d729ae3f940d482faa0d99ad2e">◆ </a></span>Senders</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IEnumerable<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1ISender.html">ISender</a>> Apache.Qpid.Proton.Engine.ISession.Senders</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 an enumerator of all the senders currently tracked by this session. </p> |
| |
| </div> |
| </div> |
| <a id="a926dbee715827c8d6c15f9ccbba4b420"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a926dbee715827c8d6c15f9ccbba4b420">◆ </a></span>State</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="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#a4cc1373ad3202432a02c710ae7e6e94b">SessionState</a> Apache.Qpid.Proton.Engine.ISession.State</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 session state for the local end of the session. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton/Engine/ISession.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> |
