blob: 8aa1a77ad53548b17afd697cfc6557ea61855f2a [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.ClientRedirect 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_1ClientRedirect.html">ClientRedirect</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.Implementation.ClientRedirect Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Support class that houses the information and API needed to process redirection information sent from a remote.
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#details">More...</a></p>
<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:a9e2946a9f7a3da709ecbe07b0709afb8"><td class="memItemLeft" align="right" valign="top"><a id="a9e2946a9f7a3da709ecbe07b0709afb8"></a>
<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html">ClientRedirect</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Validate</b> ()</td></tr>
<tr class="separator:a9e2946a9f7a3da709ecbe07b0709afb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59bd9fe9b27a9aeeaf072ca46aa648f0"><td class="memItemLeft" align="right" valign="top"><a id="a59bd9fe9b27a9aeeaf072ca46aa648f0"></a>
override string&#160;</td><td class="memItemRight" valign="bottom"><b>ToString</b> ()</td></tr>
<tr class="separator:a59bd9fe9b27a9aeeaf072ca46aa648f0"><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:a24ffb7b6f9590c2563e6aa4b99b1bf4a"><td class="memItemLeft" align="right" valign="top">IReadOnlyDictionary&lt; <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>, object &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a24ffb7b6f9590c2563e6aa4b99b1bf4a">RedirectMap</a><code> [get]</code></td></tr>
<tr class="memdesc:a24ffb7b6f9590c2563e6aa4b99b1bf4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the dictionary with remote supplied redirection information <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a24ffb7b6f9590c2563e6aa4b99b1bf4a">More...</a><br /></td></tr>
<tr class="separator:a24ffb7b6f9590c2563e6aa4b99b1bf4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97e19ca9a3fe6f7de32a4e865a2bc6ff"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a97e19ca9a3fe6f7de32a4e865a2bc6ff">Hostname</a><code> [get]</code></td></tr>
<tr class="memdesc:a97e19ca9a3fe6f7de32a4e865a2bc6ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the supplied host value in the redirection information. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a97e19ca9a3fe6f7de32a4e865a2bc6ff">More...</a><br /></td></tr>
<tr class="separator:a97e19ca9a3fe6f7de32a4e865a2bc6ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fa798bc5a7d5d08c8dad8b4ecd97540"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a2fa798bc5a7d5d08c8dad8b4ecd97540">NetworkHostname</a><code> [get]</code></td></tr>
<tr class="memdesc:a2fa798bc5a7d5d08c8dad8b4ecd97540"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the supplied DNS host value or IP Address in the redirection information. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a2fa798bc5a7d5d08c8dad8b4ecd97540">More...</a><br /></td></tr>
<tr class="separator:a2fa798bc5a7d5d08c8dad8b4ecd97540"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19b7118635a363666a7fa3684435c4b7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a19b7118635a363666a7fa3684435c4b7">Port</a><code> [get]</code></td></tr>
<tr class="memdesc:a19b7118635a363666a7fa3684435c4b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the supplied remote port in the redirection information. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a19b7118635a363666a7fa3684435c4b7">More...</a><br /></td></tr>
<tr class="separator:a19b7118635a363666a7fa3684435c4b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93b5e9b4bf0750628a6c59fb59db0c5f"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a93b5e9b4bf0750628a6c59fb59db0c5f">Scheme</a><code> [get]</code></td></tr>
<tr class="memdesc:a93b5e9b4bf0750628a6c59fb59db0c5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the supplied scheme that the remote indicated the redirect connection should use. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a93b5e9b4bf0750628a6c59fb59db0c5f">More...</a><br /></td></tr>
<tr class="separator:a93b5e9b4bf0750628a6c59fb59db0c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29c86f1773267d929c5930304b45dd29"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a29c86f1773267d929c5930304b45dd29">Path</a><code> [get]</code></td></tr>
<tr class="memdesc:a29c86f1773267d929c5930304b45dd29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the supplied path that the remote indicated the redirect connection should use. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#a29c86f1773267d929c5930304b45dd29">More...</a><br /></td></tr>
<tr class="separator:a29c86f1773267d929c5930304b45dd29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9f241dc6991d20c4bc017a2ded6f38b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#aa9f241dc6991d20c4bc017a2ded6f38b">Address</a><code> [get]</code></td></tr>
<tr class="memdesc:aa9f241dc6991d20c4bc017a2ded6f38b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the supplied address that the remote indicated the redirected link should use. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Implementation_1_1ClientRedirect.html#aa9f241dc6991d20c4bc017a2ded6f38b">More...</a><br /></td></tr>
<tr class="separator:aa9f241dc6991d20c4bc017a2ded6f38b"><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>Support class that houses the information and API needed to process redirection information sent from a remote. </p>
</div><h2 class="groupheader">Property Documentation</h2>
<a id="aa9f241dc6991d20c4bc017a2ded6f38b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9f241dc6991d20c4bc017a2ded6f38b">&#9670;&nbsp;</a></span>Address</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.Implementation.ClientRedirect.Address</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 supplied address that the remote indicated the redirected link should use. </p>
</div>
</div>
<a id="a97e19ca9a3fe6f7de32a4e865a2bc6ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97e19ca9a3fe6f7de32a4e865a2bc6ff">&#9670;&nbsp;</a></span>Hostname</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.Implementation.ClientRedirect.Hostname</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 supplied host value in the redirection information. </p>
</div>
</div>
<a id="a2fa798bc5a7d5d08c8dad8b4ecd97540"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fa798bc5a7d5d08c8dad8b4ecd97540">&#9670;&nbsp;</a></span>NetworkHostname</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.Implementation.ClientRedirect.NetworkHostname</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 supplied DNS host value or IP Address in the redirection information. </p>
</div>
</div>
<a id="a29c86f1773267d929c5930304b45dd29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29c86f1773267d929c5930304b45dd29">&#9670;&nbsp;</a></span>Path</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.Implementation.ClientRedirect.Path</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 supplied path that the remote indicated the redirect connection should use. </p>
</div>
</div>
<a id="a19b7118635a363666a7fa3684435c4b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19b7118635a363666a7fa3684435c4b7">&#9670;&nbsp;</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.Implementation.ClientRedirect.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>Access the supplied remote port in the redirection information. </p>
</div>
</div>
<a id="a24ffb7b6f9590c2563e6aa4b99b1bf4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24ffb7b6f9590c2563e6aa4b99b1bf4a">&#9670;&nbsp;</a></span>RedirectMap</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">IReadOnlyDictionary&lt;<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>, object&gt; Apache.Qpid.Proton.Client.Implementation.ClientRedirect.RedirectMap</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 dictionary with remote supplied redirection information </p>
</div>
</div>
<a id="a93b5e9b4bf0750628a6c59fb59db0c5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93b5e9b4bf0750628a6c59fb59db0c5f">&#9670;&nbsp;</a></span>Scheme</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.Implementation.ClientRedirect.Scheme</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 supplied scheme that the remote indicated the redirect connection should use. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/Implementation/ClientRedirect.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>