Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / input / releases / qpid-proton-dotnet-1.0.0-M10 / api / classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientErrorCondition.html
blob: 4fe38320f8bb718a01b61f73e8d7c815d1ece4d7 [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.ClientErrorCondition Class 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_1ClientErrorCondition.html">ClientErrorCondition</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientErrorCondition-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.Implementation.ClientErrorCondition Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a> error condition implementation which serves as a layer over the proton based version allowing for external implementations and mapping to / from Symbol types which the client tries not to expose.
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientErrorCondition.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Client.Implementation.ClientErrorCondition:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientErrorCondition.png" usemap="#Apache.Qpid.Proton.Client.Implementation.ClientErrorCondition_map" alt=""/>
<map id="Apache.Qpid.Proton.Client.Implementation.ClientErrorCondition_map" name="Apache.Qpid.Proton.Client.Implementation.ClientErrorCondition_map">
<area href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html" title="An immutable error condition that carries information that aids in determining the factors that lead ..." alt="Apache.Qpid.Proton.Client.IErrorCondition" shape="rect" coords="0,0,369,24"/>
</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:a488dd77a652fb776439d914dbde83073"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientErrorCondition.html#a488dd77a652fb776439d914dbde83073">ClientErrorCondition</a> (string condition, string description, IEnumerable&lt; KeyValuePair&lt; string, object &gt;&gt; info=null)</td></tr>
<tr class="memdesc:a488dd77a652fb776439d914dbde83073"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new error condition instance with the given information. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientErrorCondition.html#a488dd77a652fb776439d914dbde83073">More...</a><br /></td></tr>
<tr class="separator:a488dd77a652fb776439d914dbde83073"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5fe1a931949531ebaeadb9509be5f7bf"><td class="memItemLeft" align="right" valign="top"><a id="a5fe1a931949531ebaeadb9509be5f7bf"></a>
static <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Transport_1_1ErrorCondition.html">Types.Transport.ErrorCondition</a>&#160;</td><td class="memItemRight" valign="bottom"><b>AsProtonErrorCondition</b> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a> condition)</td></tr>
<tr class="separator:a5fe1a931949531ebaeadb9509be5f7bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">Apache.Qpid.Proton.Client.IErrorCondition</a></td></tr>
<tr class="memitem:ae1491cf1b2623be8898a6c73b9b1886f inherit pub_static_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae1491cf1b2623be8898a6c73b9b1886f">Create</a> (string condition, string description, IDictionary&lt; string, object &gt; info=null)</td></tr>
<tr class="memdesc:ae1491cf1b2623be8898a6c73b9b1886f inherit pub_static_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an error condition object using the supplied values. The condition string cannot be null however the other attribute can. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae1491cf1b2623be8898a6c73b9b1886f">More...</a><br /></td></tr>
<tr class="separator:ae1491cf1b2623be8898a6c73b9b1886f inherit pub_static_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><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:a8ccce613b5529954bcb6b5aa34742344"><td class="memItemLeft" align="right" valign="top"><a id="a8ccce613b5529954bcb6b5aa34742344"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><b>Condition</b><code> [get]</code></td></tr>
<tr class="separator:a8ccce613b5529954bcb6b5aa34742344"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93c44d235495ff00f3969136dd404f78"><td class="memItemLeft" align="right" valign="top"><a id="a93c44d235495ff00f3969136dd404f78"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><b>Description</b><code> [get]</code></td></tr>
<tr class="separator:a93c44d235495ff00f3969136dd404f78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af70ad6e0ebb8a1471c356abecfd1a095"><td class="memItemLeft" align="right" valign="top"><a id="af70ad6e0ebb8a1471c356abecfd1a095"></a>
IReadOnlyDictionary&lt; string, object &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Info</b><code> [get]</code></td></tr>
<tr class="separator:af70ad6e0ebb8a1471c356abecfd1a095"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">Apache.Qpid.Proton.Client.IErrorCondition</a></td></tr>
<tr class="memitem:ae7a42a43a98e0930c0c2164b8839f5bb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae7a42a43a98e0930c0c2164b8839f5bb">Condition</a><code> [get]</code></td></tr>
<tr class="memdesc:ae7a42a43a98e0930c0c2164b8839f5bb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates the type of error that this condition conveys <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae7a42a43a98e0930c0c2164b8839f5bb">More...</a><br /></td></tr>
<tr class="separator:ae7a42a43a98e0930c0c2164b8839f5bb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3394e64097b231b8c1685881410e125 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae3394e64097b231b8c1685881410e125">Description</a><code> [get]</code></td></tr>
<tr class="memdesc:ae3394e64097b231b8c1685881410e125 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="mdescLeft">&#160;</td><td class="mdescRight">A description of the condition that resulted in this error. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#ae3394e64097b231b8c1685881410e125">More...</a><br /></td></tr>
<tr class="separator:ae3394e64097b231b8c1685881410e125 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af61ebb02a10d9d8f6fca5696285752e0 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="memItemLeft" align="right" valign="top">IReadOnlyDictionary&lt; string, object &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#af61ebb02a10d9d8f6fca5696285752e0">Info</a><code> [get]</code></td></tr>
<tr class="memdesc:af61ebb02a10d9d8f6fca5696285752e0 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional supplementary information that aids in processing this error. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#af61ebb02a10d9d8f6fca5696285752e0">More...</a><br /></td></tr>
<tr class="separator:af61ebb02a10d9d8f6fca5696285752e0 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a> error condition implementation which serves as a layer over the proton based version allowing for external implementations and mapping to / from Symbol types which the client tries not to expose. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a488dd77a652fb776439d914dbde83073"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a488dd77a652fb776439d914dbde83073">&#9670;&nbsp;</a></span>ClientErrorCondition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Apache.Qpid.Proton.Client.Implementation.ClientErrorCondition.ClientErrorCondition </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>condition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IEnumerable&lt; KeyValuePair&lt; string, object &gt;&gt;&#160;</td>
<td class="paramname"><em>info</em> = <code>null</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new error condition instance with the given information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">condition</td><td>The error condition symbolic name</td></tr>
<tr><td class="paramname">description</td><td>The description to provide for the error</td></tr>
<tr><td class="paramname">info</td><td>optional info map to provide with the error</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">ArgumentNullException</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/Implementation/ClientErrorCondition.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>