| <!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.Client.Transport.ITransport 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_1Client.html">Client</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport.html">Transport</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</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_1Client_1_1Transport_1_1ITransport-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.Transport.ITransport Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Base transport interface which defines the API of a wire level IO transport used by the client. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.Transport.ITransport:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.png" usemap="#Apache.Qpid.Proton.Client.Transport.ITransport_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.Transport.ITransport_map" name="Apache.Qpid.Proton.Client.Transport.ITransport_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1TcpTransport.html" title="A TCP only transport implementation that provides extension points for SSL and or WS based transports..." alt="Apache.Qpid.Proton.Client.Transport.TcpTransport" shape="rect" coords="0,56,301,80"/> |
| </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:ad3b5ba31d9b8164a4517489aea4d3956"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#ad3b5ba31d9b8164a4517489aea4d3956">Close</a> ()</td></tr> |
| <tr class="memdesc:ad3b5ba31d9b8164a4517489aea4d3956"><td class="mdescLeft"> </td><td class="mdescRight">Initiates an orderly close of the transport. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#ad3b5ba31d9b8164a4517489aea4d3956">More...</a><br /></td></tr> |
| <tr class="separator:ad3b5ba31d9b8164a4517489aea4d3956"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a15266c41b6e2275715100b398dc27dd3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a15266c41b6e2275715100b398dc27dd3">Connect</a> (string address, int port)</td></tr> |
| <tr class="memdesc:a15266c41b6e2275715100b398dc27dd3"><td class="mdescLeft"> </td><td class="mdescRight">Initiates the IO level connect that will trigger IO events in the transport event loop based on the outcome. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a15266c41b6e2275715100b398dc27dd3">More...</a><br /></td></tr> |
| <tr class="separator:a15266c41b6e2275715100b398dc27dd3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a216b946f29cf5b90d06cf9e33e69652a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a216b946f29cf5b90d06cf9e33e69652a">Write</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer, Action writeCompleteAction)</td></tr> |
| <tr class="memdesc:a216b946f29cf5b90d06cf9e33e69652a"><td class="mdescLeft"> </td><td class="mdescRight">Queues the given buffer for write using this transport and registers a completion action that will be triggered when the write is actually performed. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a216b946f29cf5b90d06cf9e33e69652a">More...</a><br /></td></tr> |
| <tr class="separator:a216b946f29cf5b90d06cf9e33e69652a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a220d2207ba548a0611032ef92da1b1e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a220d2207ba548a0611032ef92da1b1e3">TransportReadHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a>, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> > readHandler)</td></tr> |
| <tr class="memdesc:a220d2207ba548a0611032ef92da1b1e3"><td class="mdescLeft"> </td><td class="mdescRight">Configures the read handler used to process incoming bytes that are read by this transport. The handler is always invoked within the registered event loop. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a220d2207ba548a0611032ef92da1b1e3">More...</a><br /></td></tr> |
| <tr class="separator:a220d2207ba548a0611032ef92da1b1e3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a47866ee0dccbc7ec0781a4f4e0b4e771"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a47866ee0dccbc7ec0781a4f4e0b4e771">TransportConnectedHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> > connectedHandler)</td></tr> |
| <tr class="memdesc:a47866ee0dccbc7ec0781a4f4e0b4e771"><td class="mdescLeft"> </td><td class="mdescRight">Configures the async connected handler that is called when a transport creates a successful connection to the remote. The handler is always invoked within the registered event loop. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a47866ee0dccbc7ec0781a4f4e0b4e771">More...</a><br /></td></tr> |
| <tr class="separator:a47866ee0dccbc7ec0781a4f4e0b4e771"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8a42651c8ff0b5b8b5f917ddf8ee6f5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a8a42651c8ff0b5b8b5f917ddf8ee6f5f">TransportConnectFailedHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a>, Exception > connectFailedHandler)</td></tr> |
| <tr class="memdesc:a8a42651c8ff0b5b8b5f917ddf8ee6f5f"><td class="mdescLeft"> </td><td class="mdescRight">Configures the async connected handler that is called when a transport fails to connect to a remote. The handler is always invoked within the registered event loop. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a8a42651c8ff0b5b8b5f917ddf8ee6f5f">More...</a><br /></td></tr> |
| <tr class="separator:a8a42651c8ff0b5b8b5f917ddf8ee6f5f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a02793e1ca5ce4dd348c07f7a55a1a690"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a02793e1ca5ce4dd348c07f7a55a1a690">TransportDisconnectedHandler</a> (Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> > disconnectedHandler)</td></tr> |
| <tr class="memdesc:a02793e1ca5ce4dd348c07f7a55a1a690"><td class="mdescLeft"> </td><td class="mdescRight">Configures the async disconnected handler that is called when a transport experiences a loss of connectivity with the remote. The handler is always invoked within the registered event loop. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a02793e1ca5ce4dd348c07f7a55a1a690">More...</a><br /></td></tr> |
| <tr class="separator:a02793e1ca5ce4dd348c07f7a55a1a690"><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:a2434b3a9c1b05f48b62a3aa2740abe5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1IEventLoop.html">IEventLoop</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a2434b3a9c1b05f48b62a3aa2740abe5d">EventLoop</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a2434b3a9c1b05f48b62a3aa2740abe5d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the event loop that this transport is registered against, the event loop should never have its lifetime linked to a transport as the client connection will use a single event loop for the duration of its lifetime. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a2434b3a9c1b05f48b62a3aa2740abe5d">More...</a><br /></td></tr> |
| <tr class="separator:a2434b3a9c1b05f48b62a3aa2740abe5d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1771113f7e92925d74feaa1032c6331b"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a1771113f7e92925d74feaa1032c6331b">Host</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1771113f7e92925d74feaa1032c6331b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the originally provided host address this transport was given in the connect method. Returns null if connect was not yet called. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a1771113f7e92925d74feaa1032c6331b">More...</a><br /></td></tr> |
| <tr class="separator:a1771113f7e92925d74feaa1032c6331b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abd56441ab40e27418bccdf60fdad9f76"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#abd56441ab40e27418bccdf60fdad9f76">Port</a><code> [get]</code></td></tr> |
| <tr class="memdesc:abd56441ab40e27418bccdf60fdad9f76"><td class="mdescLeft"> </td><td class="mdescRight">Returns the this transport was given or a default that was used in the connect method. Returns -1 if connect was not yet called. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#abd56441ab40e27418bccdf60fdad9f76">More...</a><br /></td></tr> |
| <tr class="separator:abd56441ab40e27418bccdf60fdad9f76"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac747ee667ba860973b36f7a91ac99c24"><td class="memItemLeft" align="right" valign="top">EndPoint </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#ac747ee667ba860973b36f7a91ac99c24">EndPoint</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac747ee667ba860973b36f7a91ac99c24"><td class="mdescLeft"> </td><td class="mdescRight">Returns the endpoint that his transport connects to. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#ac747ee667ba860973b36f7a91ac99c24">More...</a><br /></td></tr> |
| <tr class="separator:ac747ee667ba860973b36f7a91ac99c24"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3f5047cb5ed1ebb769edae20d8946358"><td class="memItemLeft" align="right" valign="top">IPrincipal </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a3f5047cb5ed1ebb769edae20d8946358">LocalPrincipal</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a3f5047cb5ed1ebb769edae20d8946358"><td class="mdescLeft"> </td><td class="mdescRight">Returns a local principal that was created following successful SSL handshaking with the remote. Before a handshake or in the case of non-SSL transport types this method returns null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html#a3f5047cb5ed1ebb769edae20d8946358">More...</a><br /></td></tr> |
| <tr class="separator:a3f5047cb5ed1ebb769edae20d8946358"><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 transport interface which defines the API of a wire level IO transport used by the client. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ad3b5ba31d9b8164a4517489aea4d3956"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad3b5ba31d9b8164a4517489aea4d3956">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Client.Transport.ITransport.Close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initiates an orderly close of the transport. </p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1TcpTransport.html#a7f73a3cdedfec534ee4b87acd9775633">Apache.Qpid.Proton.Client.Transport.TcpTransport</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a15266c41b6e2275715100b398dc27dd3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a15266c41b6e2275715100b398dc27dd3">◆ </a></span>Connect()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> Apache.Qpid.Proton.Client.Transport.ITransport.Connect </td> |
| <td>(</td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>address</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>port</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initiates the IO level connect that will trigger IO events in the transport event loop based on the outcome. </p> |
| <dl class="section return"><dt>Returns</dt><dd>This transport instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1TcpTransport.html#ad045327c844bc1bb92d87d89891957ca">Apache.Qpid.Proton.Client.Transport.TcpTransport</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a47866ee0dccbc7ec0781a4f4e0b4e771"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a47866ee0dccbc7ec0781a4f4e0b4e771">◆ </a></span>TransportConnectedHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> Apache.Qpid.Proton.Client.Transport.ITransport.TransportConnectedHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> > </td> |
| <td class="paramname"><em>connectedHandler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures the async connected handler that is called when a transport creates a successful connection to the remote. The handler is always invoked within the registered event loop. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">connectedHandler</td><td>Handler that is invoked on connect</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This transport instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1TcpTransport.html#a53a741adbe72ddae6fe9a5aac6c0e2da">Apache.Qpid.Proton.Client.Transport.TcpTransport</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a8a42651c8ff0b5b8b5f917ddf8ee6f5f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8a42651c8ff0b5b8b5f917ddf8ee6f5f">◆ </a></span>TransportConnectFailedHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> Apache.Qpid.Proton.Client.Transport.ITransport.TransportConnectFailedHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a>, Exception > </td> |
| <td class="paramname"><em>connectFailedHandler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures the async connected handler that is called when a transport fails to connect to a remote. The handler is always invoked within the registered event loop. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">connectedHandler</td><td>Handler that is invoked on connect failure</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This transport instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1TcpTransport.html#ad49afc8c8b542b38f2d2dfb6ef40ec27">Apache.Qpid.Proton.Client.Transport.TcpTransport</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a02793e1ca5ce4dd348c07f7a55a1a690"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a02793e1ca5ce4dd348c07f7a55a1a690">◆ </a></span>TransportDisconnectedHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> Apache.Qpid.Proton.Client.Transport.ITransport.TransportDisconnectedHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> > </td> |
| <td class="paramname"><em>disconnectedHandler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures the async disconnected handler that is called when a transport experiences a loss of connectivity with the remote. The handler is always invoked within the registered event loop. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">connectedHandler</td><td>Handler that is invoked on disconnect</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This transport instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1TcpTransport.html#ad1c843ba6faf62d84533da1a49e8ac79">Apache.Qpid.Proton.Client.Transport.TcpTransport</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a220d2207ba548a0611032ef92da1b1e3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a220d2207ba548a0611032ef92da1b1e3">◆ </a></span>TransportReadHandler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> Apache.Qpid.Proton.Client.Transport.ITransport.TransportReadHandler </td> |
| <td>(</td> |
| <td class="paramtype">Action< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a>, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> > </td> |
| <td class="paramname"><em>readHandler</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures the read handler used to process incoming bytes that are read by this transport. The handler is always invoked within the registered event loop. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">readHandler</td><td>Handler that is invoked on read</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This transport instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1TcpTransport.html#a2c7069df73d3540453a5341bb09fa3c3">Apache.Qpid.Proton.Client.Transport.TcpTransport</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a216b946f29cf5b90d06cf9e33e69652a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a216b946f29cf5b90d06cf9e33e69652a">◆ </a></span>Write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1ITransport.html">ITransport</a> Apache.Qpid.Proton.Client.Transport.ITransport.Write </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td> |
| <td class="paramname"><em>buffer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Action </td> |
| <td class="paramname"><em>writeCompleteAction</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Queues the given buffer for write using this transport and registers a completion action that will be triggered when the write is actually performed. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer to write</td></tr> |
| <tr><td class="paramname">writeCompleteAction</td><td>optional action to be performed</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This transport instance</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Transport_1_1TcpTransport.html#ac6a8683e1c7e0591966a651173e2ce27">Apache.Qpid.Proton.Client.Transport.TcpTransport</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="ac747ee667ba860973b36f7a91ac99c24"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac747ee667ba860973b36f7a91ac99c24">◆ </a></span>EndPoint</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">EndPoint Apache.Qpid.Proton.Client.Transport.ITransport.EndPoint</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 the endpoint that his transport connects to. </p> |
| |
| </div> |
| </div> |
| <a id="a2434b3a9c1b05f48b62a3aa2740abe5d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2434b3a9c1b05f48b62a3aa2740abe5d">◆ </a></span>EventLoop</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_1Client_1_1Concurrent_1_1IEventLoop.html">IEventLoop</a> Apache.Qpid.Proton.Client.Transport.ITransport.EventLoop</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 the event loop that this transport is registered against, the event loop should never have its lifetime linked to a transport as the client connection will use a single event loop for the duration of its lifetime. </p> |
| |
| </div> |
| </div> |
| <a id="a1771113f7e92925d74feaa1032c6331b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1771113f7e92925d74feaa1032c6331b">◆ </a></span>Host</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Apache.Qpid.Proton.Client.Transport.ITransport.Host</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 the originally provided host address this transport was given in the connect method. Returns null if connect was not yet called. </p> |
| |
| </div> |
| </div> |
| <a id="a3f5047cb5ed1ebb769edae20d8946358"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3f5047cb5ed1ebb769edae20d8946358">◆ </a></span>LocalPrincipal</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IPrincipal Apache.Qpid.Proton.Client.Transport.ITransport.LocalPrincipal</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 a local principal that was created following successful SSL handshaking with the remote. Before a handshake or in the case of non-SSL transport types this method returns null. </p> |
| |
| </div> |
| </div> |
| <a id="abd56441ab40e27418bccdf60fdad9f76"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abd56441ab40e27418bccdf60fdad9f76">◆ </a></span>Port</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Apache.Qpid.Proton.Client.Transport.ITransport.Port</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 the this transport was given or a default that was used in the connect method. Returns -1 if connect was not yet called. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/Transport/ITransport.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> |
