blob: 5cb7608934944ed9fb57e88035af45db6878529e [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 Namespace 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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ClientOptions.html">ClientOptions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ConnectionEvent.html">ConnectionEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An event object that accompanies events fired to handlers configured in the Connection options which are signaled during specific Connection event points. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ConnectionEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ConnectionOptions.html">ConnectionOptions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1DisconnectionEvent.html">DisconnectionEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An event object that accompanies events fired to handlers configured in the Connection options which are signaled during specific Connection event points. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1DisconnectionEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html">IAdvancedMessage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP Message instance used by senders and receivers to provide a lower level abstraction around an AMQP message than the basic <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IMessage.html" title="A single AMQP Message instance used by senders and receivers to provide a high level abstraction arou...">IMessage</a> type but still provides the <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IMessage.html" title="A single AMQP Message instance used by senders and receivers to provide a high level abstraction arou...">IMessage</a> interface simpler access where needed. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IAdvancedMessage.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IClient.html">IClient</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Container that hosts one ore more AMQP connections that share a given AMQP container Id. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IClient.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IConnection.html">IConnection</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP Connection instance. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IConnection.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html">IDelivery</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP delivery tracker instance. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDelivery.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IDeliveryState.html">IDeliveryState</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html">IErrorCondition</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An immutable error condition that carries information that aids in determining the factors that lead to the error. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IErrorCondition.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html">ILink</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP link which can be a sender or receiver instance but each expose a common set of link properties whose API is presented here. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ILink.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IMessage.html">IMessage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP Message instance used by senders and receivers to provide a high level abstraction around an AMQP message. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IMessage.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html">IReceiver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP receiver instance. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IReceiver.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISender.html">ISender</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP sender instance. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISender.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISession.html">ISession</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP session instance. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISession.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISource.html">ISource</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents the remote Source instance for a sender or receiver link <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ISource.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html">IStreamDelivery</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A specialized delivery type that is returned from the stream receiver which can be used to read incoming large messages that are streamed via multiple incoming AMQP transfer frames. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamDelivery.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamReceiver.html">IStreamReceiver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP stream receiver instance <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamReceiver.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamReceiverMessage.html">IStreamReceiverMessage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A specialized message type that represents a streamed delivery possibly spanning many incoming AMQP transfer frames from the remote peer. It is possible for various calls in this message type to block while awaiting the receipt of sufficient bytes to provide the result. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamReceiverMessage.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSender.html">IStreamSender</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP stream sender instance which can be used to transmit large message payloads to the remote without needing to load the full message contents into memory. The streaming sender will also provide flow control that attempts to provide additional safety values for out of memory situations. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSender.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html">IStreamSenderMessage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A specialized streaming message type used to operate on a streamed message which allows message data to be written in one or more transfer frames to the remote allowing for very large message transmission with limited memory overhead. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamSenderMessage.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamTracker.html">IStreamTracker</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Special streaming sender related tracker that is linked to a stream sender message and provides the tracker functions for those types of messages. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1IStreamTracker.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITarget.html">ITarget</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents the remote Target instance for a sender or receiver link <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITarget.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html">ITracker</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single AMQP delivery tracker instance. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Client_1_1ITracker.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html">OutputStreamOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options class that controls various aspects of a write only stream instance created to write the contents of a section of a stream sender message. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html">ReceiverOptions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html">ReconnectLocation</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a fixed location that can be used for connection by the client should the initially specified connection location be unreachable or become unavailable during the lifetime of the connection. <a href="structApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectLocation.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html">ReconnectOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reconnection options which will control how a connection deals will connection loss and or inability to connect to the host it was provided at create time. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReconnectOptions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html">SaslOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options that control how the SASL authentication process is performed. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html">SenderOptions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SessionOptions.html">SessionOptions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SourceOptions.html">SourceOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options used to configure the source when a terminus is being created. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SourceOptions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html">SslOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options that control the SSL level transport configuration. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SslOptions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html">StreamReceiverOptions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html">StreamSenderOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Special sender options that are applied the streaming senders which allow transmission of large message payloads. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TargetOptions.html">TargetOptions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html">TerminusOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base options type for the terminus configuration for Source and Target types that configure the nodes for Sender and Receiver links. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TerminusOptions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html">TransportOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options that control the I/O level transport configuration. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TransportOptions.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:aa324b7f96b19f0e9bf251a72fd68bd0c"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#aa324b7f96b19f0e9bf251a72fd68bd0c">DeliveryMode</a> { <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#aa324b7f96b19f0e9bf251a72fd68bd0ca3e8892e178cf7853227f4ad0886b3f81">AtMostOnce</a>
, <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#aa324b7f96b19f0e9bf251a72fd68bd0caf6d671c71857fbf356655879cd21f5ea">AtLeastOnce</a>
}</td></tr>
<tr class="memdesc:aa324b7f96b19f0e9bf251a72fd68bd0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the delivery modes that a sender or receiver can be configured with. <a href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#aa324b7f96b19f0e9bf251a72fd68bd0c">More...</a><br /></td></tr>
<tr class="separator:aa324b7f96b19f0e9bf251a72fd68bd0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e8185e0e32f8574f07049842421e732"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a4e8185e0e32f8574f07049842421e732">DeliveryStateType</a> { <br />
&#160;&#160;<b>Accepted</b>
, <b>Rejected</b>
, <b>Modified</b>
, <b>Released</b>
, <br />
&#160;&#160;<b>Transactional</b>
<br />
}</td></tr>
<tr class="memdesc:a4e8185e0e32f8574f07049842421e732"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration of possible delivery state types which can be allied as outcome to an incoming or outgoing delivery. <a href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a4e8185e0e32f8574f07049842421e732">More...</a><br /></td></tr>
<tr class="separator:a4e8185e0e32f8574f07049842421e732"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09fbfb279bed85249277302174da5734"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a09fbfb279bed85249277302174da5734">DistributionMode</a> { <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a09fbfb279bed85249277302174da5734a5fb63579fc981698f97d55bfecb213ea">Copy</a>
, <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a09fbfb279bed85249277302174da5734a6bc362dbf494c61ea117fe3c71ca48a5">Move</a>
, <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a09fbfb279bed85249277302174da5734a6adf97f83acf6453d4a6a4b1070f3754">None</a>
}</td></tr>
<tr class="memdesc:a09fbfb279bed85249277302174da5734"><td class="mdescLeft">&#160;</td><td class="mdescRight">The distribution-mode of a source determines how messages from a distribution node are distributed among its associated links. <a href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a09fbfb279bed85249277302174da5734">More...</a><br /></td></tr>
<tr class="separator:a09fbfb279bed85249277302174da5734"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf270817f0631ad896871638bee2b287"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#abf270817f0631ad896871638bee2b287">DurabilityMode</a> { <b>None</b>
, <b>Configuration</b>
, <b>UnsettledState</b>
}</td></tr>
<tr class="memdesc:abf270817f0631ad896871638bee2b287"><td class="mdescLeft">&#160;</td><td class="mdescRight">Durability policy for a terminus. <a href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#abf270817f0631ad896871638bee2b287">More...</a><br /></td></tr>
<tr class="separator:abf270817f0631ad896871638bee2b287"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a932f30c66b130dc8306611cb01983d8c"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a932f30c66b130dc8306611cb01983d8c">ExpiryPolicy</a> { <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a932f30c66b130dc8306611cb01983d8ca8a074df2949c8445d50c89a27e5e634a">LinkClose</a>
, <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a932f30c66b130dc8306611cb01983d8caa8b1bf6555dd65ba62f0063d5e24c046">SessionClose</a>
, <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a932f30c66b130dc8306611cb01983d8ca32161a38932b8d912c908a6f7b7e7280">ConnectionClose</a>
, <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a932f30c66b130dc8306611cb01983d8ca6e7b34fa59e1bd229b207892956dc41c">Never</a>
}</td></tr>
<tr class="memdesc:a932f30c66b130dc8306611cb01983d8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expiry policy for a terminus. <a href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a932f30c66b130dc8306611cb01983d8c">More...</a><br /></td></tr>
<tr class="separator:a932f30c66b130dc8306611cb01983d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29fcbe719c1b2f22561850a3dc0203ff"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a29fcbe719c1b2f22561850a3dc0203ff">NextReceiverPolicy</a> { <br />
&#160;&#160;<a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a29fcbe719c1b2f22561850a3dc0203ffa91a63281bd2e647fe3b92d1d22cd3380">RoundRobin</a>
, <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a29fcbe719c1b2f22561850a3dc0203ffa64663f4646781c9c0110838b905daa23">Random</a>
, <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a29fcbe719c1b2f22561850a3dc0203ffa235215d0fea7b04bb18198d5e07e2541">FirstAvailable</a>
, <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a29fcbe719c1b2f22561850a3dc0203ffafcf23ba3d6308eca6b3bfb7c0cee66a1">LargestBacklog</a>
, <br />
&#160;&#160;<a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a29fcbe719c1b2f22561850a3dc0203ffa080ec4d9b62ecc037a7fc4b58e9085bf">SmallestBacklog</a>
<br />
}</td></tr>
<tr class="memdesc:a29fcbe719c1b2f22561850a3dc0203ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the behavior of a Session when the next receiver method is called on that session. Each policy provides a contract on the ordering of returned receivers from the next receiver API when there are receivers with locally queued deliveries. When there are no Receiver instances that have locally queued deliveries the next receive API will return the next receiver to receive a complete incoming delivery unless a timeout was given and that time period expires in which case it will return null. <a href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a29fcbe719c1b2f22561850a3dc0203ff">More...</a><br /></td></tr>
<tr class="separator:a29fcbe719c1b2f22561850a3dc0203ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="aa324b7f96b19f0e9bf251a72fd68bd0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa324b7f96b19f0e9bf251a72fd68bd0c">&#9670;&nbsp;</a></span>DeliveryMode</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#aa324b7f96b19f0e9bf251a72fd68bd0c">Apache.Qpid.Proton.Client.DeliveryMode</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Defines the delivery modes that a sender or receiver can be configured with. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa324b7f96b19f0e9bf251a72fd68bd0ca3e8892e178cf7853227f4ad0886b3f81"></a>AtMostOnce&#160;</td><td class="fielddoc"><p>At most once delivery mode which configures the sender or receiver to request pre-settled deliveries. This is lowest level of reliability but the fastest overall mode as it does not require round trips from the remote to accept or settle the delivery. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa324b7f96b19f0e9bf251a72fd68bd0caf6d671c71857fbf356655879cd21f5ea"></a>AtLeastOnce&#160;</td><td class="fielddoc"><p>At least once deliver mode which configures the sender or receiver to require that delivery be settled upon receipt. </p>
</td></tr>
</table>
</div>
</div>
<a id="a4e8185e0e32f8574f07049842421e732"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e8185e0e32f8574f07049842421e732">&#9670;&nbsp;</a></span>DeliveryStateType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a4e8185e0e32f8574f07049842421e732">Apache.Qpid.Proton.Client.DeliveryStateType</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration of possible delivery state types which can be allied as outcome to an incoming or outgoing delivery. </p>
</div>
</div>
<a id="a09fbfb279bed85249277302174da5734"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09fbfb279bed85249277302174da5734">&#9670;&nbsp;</a></span>DistributionMode</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a09fbfb279bed85249277302174da5734">Apache.Qpid.Proton.Client.DistributionMode</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The distribution-mode of a source determines how messages from a distribution node are distributed among its associated links. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a09fbfb279bed85249277302174da5734a5fb63579fc981698f97d55bfecb213ea"></a>Copy&#160;</td><td class="fielddoc"><p>The copy distribution-mode leaves the state of the message unchanged at the distribution node. </p>
</td></tr>
<tr><td class="fieldname"><a id="a09fbfb279bed85249277302174da5734a6bc362dbf494c61ea117fe3c71ca48a5"></a>Move&#160;</td><td class="fielddoc"><p>Causes messages transferred from the distribution node to transition to the ACQUIRED state prior to transfer over the link, and subsequently to the ARCHIVED state when the transfer is settled with a successful outcome. </p>
</td></tr>
<tr><td class="fieldname"><a id="a09fbfb279bed85249277302174da5734a6adf97f83acf6453d4a6a4b1070f3754"></a>None&#160;</td><td class="fielddoc"><p>When used to set a value to send to the remote this value implies that nothing should be configured out the outgoing configuration and when returned from a read of some remote resource this value indicates that the remote sent no value for the distribution mode. </p>
</td></tr>
</table>
</div>
</div>
<a id="abf270817f0631ad896871638bee2b287"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf270817f0631ad896871638bee2b287">&#9670;&nbsp;</a></span>DurabilityMode</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#abf270817f0631ad896871638bee2b287">Apache.Qpid.Proton.Client.DurabilityMode</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Durability policy for a terminus. </p>
</div>
</div>
<a id="a932f30c66b130dc8306611cb01983d8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a932f30c66b130dc8306611cb01983d8c">&#9670;&nbsp;</a></span>ExpiryPolicy</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a932f30c66b130dc8306611cb01983d8c">Apache.Qpid.Proton.Client.ExpiryPolicy</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Expiry policy for a terminus. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a932f30c66b130dc8306611cb01983d8ca8a074df2949c8445d50c89a27e5e634a"></a>LinkClose&#160;</td><td class="fielddoc"><p>Eligible for expiry on Link close. </p>
</td></tr>
<tr><td class="fieldname"><a id="a932f30c66b130dc8306611cb01983d8caa8b1bf6555dd65ba62f0063d5e24c046"></a>SessionClose&#160;</td><td class="fielddoc"><p>Eligible for expiry when the associated Session is closed. </p>
</td></tr>
<tr><td class="fieldname"><a id="a932f30c66b130dc8306611cb01983d8ca32161a38932b8d912c908a6f7b7e7280"></a>ConnectionClose&#160;</td><td class="fielddoc"><p>Eligible for expiry when the associated Connection is closed. </p>
</td></tr>
<tr><td class="fieldname"><a id="a932f30c66b130dc8306611cb01983d8ca6e7b34fa59e1bd229b207892956dc41c"></a>Never&#160;</td><td class="fielddoc"><p>Terminus never expires </p>
</td></tr>
</table>
</div>
</div>
<a id="a29fcbe719c1b2f22561850a3dc0203ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29fcbe719c1b2f22561850a3dc0203ff">&#9670;&nbsp;</a></span>NextReceiverPolicy</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#a29fcbe719c1b2f22561850a3dc0203ff">Apache.Qpid.Proton.Client.NextReceiverPolicy</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the behavior of a Session when the next receiver method is called on that session. Each policy provides a contract on the ordering of returned receivers from the next receiver API when there are receivers with locally queued deliveries. When there are no Receiver instances that have locally queued deliveries the next receive API will return the next receiver to receive a complete incoming delivery unless a timeout was given and that time period expires in which case it will return null. </p>
<p>Should the user perform receive calls on a Receiver directly in multiple threads the behavior of the next receiver API is undefined and it becomes possible that the resulting receiver returned from that API will have no actual pending deliveries due to a race. In most cases the caller can mitigate some risk by using the Receiver tryReceive API and accounting for a null result.</p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a29fcbe719c1b2f22561850a3dc0203ffa91a63281bd2e647fe3b92d1d22cd3380"></a>RoundRobin&#160;</td><td class="fielddoc"><p>Examines the list of currently open receivers in the session and returns the next receiver that has a pending delivery that follows the previously returned receiver (if any) otherwise the first receiver in the session with a pending delivery is returned. The order of receivers returned will likely be creation order however the implementation is not required to follow this pattern so the caller should not be coded to rely on that ordering. </p>
</td></tr>
<tr><td class="fieldname"><a id="a29fcbe719c1b2f22561850a3dc0203ffa64663f4646781c9c0110838b905daa23"></a>Random&#160;</td><td class="fielddoc"><p>Examines the list of currently open receivers in the session and returns a random selection from the set of receivers that have a pending delivery immediately available. This provides a means of selecting receivers which is not prone to sticking to a highly active receiver which can starve out other receivers which receive only limited traffic. </p>
</td></tr>
<tr><td class="fieldname"><a id="a29fcbe719c1b2f22561850a3dc0203ffa235215d0fea7b04bb18198d5e07e2541"></a>FirstAvailable&#160;</td><td class="fielddoc"><p>Examines the list of currently open receivers in the session and returns the first receiver found with an available delivery. This can result in starvation if that receiver has a continuous feed of new deliveries from the remote as it will be repeatedly selected by the next receiver API. </p>
</td></tr>
<tr><td class="fieldname"><a id="a29fcbe719c1b2f22561850a3dc0203ffafcf23ba3d6308eca6b3bfb7c0cee66a1"></a>LargestBacklog&#160;</td><td class="fielddoc"><p>Examines the list of currently open receivers in the session and returns the receiver with the largest backlog of available deliveries. This can result in starvation if that receiver has a continuous feed of new deliveries from the remote as it will likely be repeatedly selected by the next receiver API. </p>
</td></tr>
<tr><td class="fieldname"><a id="a29fcbe719c1b2f22561850a3dc0203ffa080ec4d9b62ecc037a7fc4b58e9085bf"></a>SmallestBacklog&#160;</td><td class="fielddoc"><p>Examines the list of currently open receivers in the session and returns the receiver with the smallest backlog of available deliveries. </p>
</td></tr>
</table>
</div>
</div>
</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>