blob: bf3905a161ad81c8390e0c65dfbd1f45c3b73d8e [file] [log] [blame]
<!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.Implementation.ClientLinkType&lt; LinkType, ProtonLinkType &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Proton DotNet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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_1Implementation.html">Implementation</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientLinkType.html">ClientLinkType</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientLinkType-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.Implementation.ClientLinkType&lt; LinkType, ProtonLinkType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Client.Implementation.ClientLinkType&lt; LinkType, ProtonLinkType &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientLinkType.png" alt=""/>
</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:a866b73ad6e9b5b3f06c2738dd52db03c"><td class="memItemLeft" align="right" valign="top"><a id="a866b73ad6e9b5b3f06c2738dd52db03c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Close</b> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> error=null)</td></tr>
<tr class="separator:a866b73ad6e9b5b3f06c2738dd52db03c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81926e9f46e7fa6916933a2790ad47a5"><td class="memItemLeft" align="right" valign="top"><a id="a81926e9f46e7fa6916933a2790ad47a5"></a>
Task&lt; LinkType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>CloseAsync</b> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> error=null)</td></tr>
<tr class="separator:a81926e9f46e7fa6916933a2790ad47a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cc11431fffb848e34af4594adbc5d8a"><td class="memItemLeft" align="right" valign="top"><a id="a7cc11431fffb848e34af4594adbc5d8a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Detach</b> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> error=null)</td></tr>
<tr class="separator:a7cc11431fffb848e34af4594adbc5d8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a086524a2be76987df2c653b49999ef41"><td class="memItemLeft" align="right" valign="top"><a id="a086524a2be76987df2c653b49999ef41"></a>
Task&lt; LinkType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>DetachAsync</b> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> error=null)</td></tr>
<tr class="separator:a086524a2be76987df2c653b49999ef41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f229e5c4121cee449b87f9aa184b496"><td class="memItemLeft" align="right" valign="top"><a id="a3f229e5c4121cee449b87f9aa184b496"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Dispose</b> ()</td></tr>
<tr class="separator:a3f229e5c4121cee449b87f9aa184b496"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aa483494e05dae1ce26dd6bb165ac66ac"><td class="memItemLeft" align="right" valign="top"><a id="aa483494e05dae1ce26dd6bb165ac66ac"></a>
virtual Task&lt; LinkType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>DoCloseOrDetach</b> (bool close, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> error)</td></tr>
<tr class="separator:aa483494e05dae1ce26dd6bb165ac66ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe6ed39b7758e51cab0286656627da02"><td class="memItemLeft" align="right" valign="top"><a id="afe6ed39b7758e51cab0286656627da02"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>CheckClosedOrFailed</b> ()</td></tr>
<tr class="separator:afe6ed39b7758e51cab0286656627da02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf0a581710b318c1492cc68ee2a8df4d"><td class="memItemLeft" align="right" valign="top"><a id="acf0a581710b318c1492cc68ee2a8df4d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>WaitForOpenToComplete</b> ()</td></tr>
<tr class="separator:acf0a581710b318c1492cc68ee2a8df4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72eb3b8edeecf339eb8604a56f4d9109"><td class="memItemLeft" align="right" valign="top"><a id="a72eb3b8edeecf339eb8604a56f4d9109"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>NotClosedOrFailed&lt; T &gt;</b> (TaskCompletionSource&lt; T &gt; request)</td></tr>
<tr class="separator:a72eb3b8edeecf339eb8604a56f4d9109"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d8daa32bae09ea2ad45778992b2bf7e"><td class="memItemLeft" align="right" valign="top"><a id="a2d8daa32bae09ea2ad45778992b2bf7e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>NotClosedOrFailed&lt; T &gt;</b> (TaskCompletionSource&lt; T &gt; request, ProtonLinkType sender)</td></tr>
<tr class="separator:a2d8daa32bae09ea2ad45778992b2bf7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a86c105ae82ee8fee9b35a310a73003f5"><td class="memItemLeft" align="right" valign="top"><a id="a86c105ae82ee8fee9b35a310a73003f5"></a>
readonly <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html">AtomicBoolean</a>&#160;</td><td class="memItemRight" valign="bottom"><b>closed</b> = new()</td></tr>
<tr class="separator:a86c105ae82ee8fee9b35a310a73003f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a633b59f40a286919aef19a12b4f02a1d"><td class="memItemLeft" align="right" valign="top"><a id="a633b59f40a286919aef19a12b4f02a1d"></a>
readonly <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientSession.html">ClientSession</a>&#160;</td><td class="memItemRight" valign="bottom"><b>session</b></td></tr>
<tr class="separator:a633b59f40a286919aef19a12b4f02a1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5579324c29f4a497ce16cf8c4e53ad86"><td class="memItemLeft" align="right" valign="top"><a id="a5579324c29f4a497ce16cf8c4e53ad86"></a>
<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Exceptions_1_1ClientException.html">ClientException</a>&#160;</td><td class="memItemRight" valign="bottom"><b>failureCause</b></td></tr>
<tr class="separator:a5579324c29f4a497ce16cf8c4e53ad86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7309bf9dbcdc5498b659b2dac3e46970"><td class="memItemLeft" align="right" valign="top">readonly TaskCompletionSource&lt; LinkType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>openFuture</b></td></tr>
<tr class="separator:a7309bf9dbcdc5498b659b2dac3e46970"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab50d6573c786017ac7c57b9efdfd0d73"><td class="memItemLeft" align="right" valign="top">readonly TaskCompletionSource&lt; LinkType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>closeFuture</b></td></tr>
<tr class="separator:ab50d6573c786017ac7c57b9efdfd0d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a911e738dc96f560c6e588eb5d677b4e2"><td class="memItemLeft" align="right" valign="top"><a id="a911e738dc96f560c6e588eb5d677b4e2"></a>
volatile <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISource.html">ISource</a>&#160;</td><td class="memItemRight" valign="bottom"><b>remoteSource</b></td></tr>
<tr class="separator:a911e738dc96f560c6e588eb5d677b4e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae65405329e8cf1c52551c9aa427f7c99"><td class="memItemLeft" align="right" valign="top"><a id="ae65405329e8cf1c52551c9aa427f7c99"></a>
volatile <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITarget.html">ITarget</a>&#160;</td><td class="memItemRight" valign="bottom"><b>remoteTarget</b></td></tr>
<tr class="separator:ae65405329e8cf1c52551c9aa427f7c99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62d2b6704c781af15bee2028566963af"><td class="memItemLeft" align="right" valign="top"><a id="a62d2b6704c781af15bee2028566963af"></a>
ProtonLinkType&#160;</td><td class="memItemRight" valign="bottom"><b>protonLink</b></td></tr>
<tr class="separator:a62d2b6704c781af15bee2028566963af"><td class="memSeparator" colspan="2">&#160;</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:aa0698b5e3b221b538f4f6c4e63f68905"><td class="memItemLeft" align="right" valign="top"><a id="aa0698b5e3b221b538f4f6c4e63f68905"></a>
<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IClient.html">IClient</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Client</b><code> [get]</code></td></tr>
<tr class="separator:aa0698b5e3b221b538f4f6c4e63f68905"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2dfd84e72776156d9aa41969f4b72030"><td class="memItemLeft" align="right" valign="top"><a id="a2dfd84e72776156d9aa41969f4b72030"></a>
<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IConnection.html">IConnection</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Connection</b><code> [get]</code></td></tr>
<tr class="separator:a2dfd84e72776156d9aa41969f4b72030"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5165ece1c6c804bd53cea4615f73f6d"><td class="memItemLeft" align="right" valign="top"><a id="ab5165ece1c6c804bd53cea4615f73f6d"></a>
<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISession.html">ISession</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Session</b><code> [get]</code></td></tr>
<tr class="separator:ab5165ece1c6c804bd53cea4615f73f6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addde91c16ded4c80e1fc2cddb0b2d06f"><td class="memItemLeft" align="right" valign="top"><a id="addde91c16ded4c80e1fc2cddb0b2d06f"></a>
Task&lt; LinkType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>OpenTask</b><code> [get]</code></td></tr>
<tr class="separator:addde91c16ded4c80e1fc2cddb0b2d06f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fa7ce61d04df768212766323d216d0e"><td class="memItemLeft" align="right" valign="top"><a id="a3fa7ce61d04df768212766323d216d0e"></a>
string???&#160;</td><td class="memItemRight" valign="bottom"><b>Address</b><code> [get]</code></td></tr>
<tr class="separator:a3fa7ce61d04df768212766323d216d0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4930cf8a7455487c32db24941bf4630"><td class="memItemLeft" align="right" valign="top"><a id="ac4930cf8a7455487c32db24941bf4630"></a>
<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISource.html">ISource</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Source</b><code> [get]</code></td></tr>
<tr class="separator:ac4930cf8a7455487c32db24941bf4630"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b78625ebfd551a904f6427c62092bcb"><td class="memItemLeft" align="right" valign="top"><a id="a0b78625ebfd551a904f6427c62092bcb"></a>
<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITarget.html">ITarget</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Target</b><code> [get]</code></td></tr>
<tr class="separator:a0b78625ebfd551a904f6427c62092bcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7963368c85c511ac0c3c29f08679848"><td class="memItemLeft" align="right" valign="top"><a id="aa7963368c85c511ac0c3c29f08679848"></a>
IReadOnlyDictionary&lt; string, object &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Properties</b><code> [get]</code></td></tr>
<tr class="separator:aa7963368c85c511ac0c3c29f08679848"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adab1865e6438085ffb3f529550f6b7c0"><td class="memItemLeft" align="right" valign="top"><a id="adab1865e6438085ffb3f529550f6b7c0"></a>
IReadOnlyCollection&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>OfferedCapabilities</b><code> [get]</code></td></tr>
<tr class="separator:adab1865e6438085ffb3f529550f6b7c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13216c6bcd6a09428c74dc743c948813"><td class="memItemLeft" align="right" valign="top"><a id="a13216c6bcd6a09428c74dc743c948813"></a>
IReadOnlyCollection&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>DesiredCapabilities</b><code> [get]</code></td></tr>
<tr class="separator:a13216c6bcd6a09428c74dc743c948813"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab50d6573c786017ac7c57b9efdfd0d73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab50d6573c786017ac7c57b9efdfd0d73">&#9670;&nbsp;</a></span>closeFuture</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly TaskCompletionSource&lt;LinkType&gt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientLinkType.html">Apache.Qpid.Proton.Client.Implementation.ClientLinkType</a>&lt; LinkType, ProtonLinkType &gt;.closeFuture</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> <span class="keyword">new</span>(TaskCreationOptions.RunContinuationsAsynchronously)</div>
</div><!-- fragment -->
</div>
</div>
<a id="a7309bf9dbcdc5498b659b2dac3e46970"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7309bf9dbcdc5498b659b2dac3e46970">&#9670;&nbsp;</a></span>openFuture</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly TaskCompletionSource&lt;LinkType&gt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientLinkType.html">Apache.Qpid.Proton.Client.Implementation.ClientLinkType</a>&lt; LinkType, ProtonLinkType &gt;.openFuture</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> <span class="keyword">new</span>(TaskCreationOptions.RunContinuationsAsynchronously)</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/Implementation/ClientLinkType.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>