| <!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.ReceiverOptions 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&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html">ReceiverOptions</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.ReceiverOptions Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.ReceiverOptions:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.png" usemap="#Apache.Qpid.Proton.Client.ReceiverOptions_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.ReceiverOptions_map" name="Apache.Qpid.Proton.Client.ReceiverOptions_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html" alt="Apache.Qpid.Proton.Client.StreamReceiverOptions" shape="rect" coords="0,112,301,136"/> |
| </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:a1ea360d3be9415475c769b99541fd472"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a1ea360d3be9415475c769b99541fd472">ReceiverOptions</a> ()</td></tr> |
| <tr class="memdesc:a1ea360d3be9415475c769b99541fd472"><td class="mdescLeft"> </td><td class="mdescRight">Creates a default receiver options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a1ea360d3be9415475c769b99541fd472">More...</a><br /></td></tr> |
| <tr class="separator:a1ea360d3be9415475c769b99541fd472"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa53fa24cdf6f68fc09f807fb44ca361c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#aa53fa24cdf6f68fc09f807fb44ca361c">ReceiverOptions</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html">ReceiverOptions</a> other)</td></tr> |
| <tr class="memdesc:aa53fa24cdf6f68fc09f807fb44ca361c"><td class="mdescLeft"> </td><td class="mdescRight">Create a new receiver options instance whose settings are copied from the instance provided. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#aa53fa24cdf6f68fc09f807fb44ca361c">More...</a><br /></td></tr> |
| <tr class="separator:aa53fa24cdf6f68fc09f807fb44ca361c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a011b8460791cce733f7becec352cb803"><td class="memItemLeft" align="right" valign="top">virtual object </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a011b8460791cce733f7becec352cb803">Clone</a> ()</td></tr> |
| <tr class="memdesc:a011b8460791cce733f7becec352cb803"><td class="mdescLeft"> </td><td class="mdescRight">Clone this options instance, changes to the cloned options are not reflected in this options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a011b8460791cce733f7becec352cb803">More...</a><br /></td></tr> |
| <tr class="separator:a011b8460791cce733f7becec352cb803"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a8ad59d96b7b28d27fd4913b1b85b56a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SourceOptions.html">SourceOptions</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a8ad59d96b7b28d27fd4913b1b85b56a7">SourceOptions</a> = new <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SourceOptions.html">SourceOptions</a>()<code> [get]</code></td></tr> |
| <tr class="memdesc:a8ad59d96b7b28d27fd4913b1b85b56a7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the source options configuration instance for these Receiver options <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a8ad59d96b7b28d27fd4913b1b85b56a7">More...</a><br /></td></tr> |
| <tr class="separator:a8ad59d96b7b28d27fd4913b1b85b56a7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a608cbb1028db68bdd7fa25992588d6dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TargetOptions.html">TargetOptions</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a608cbb1028db68bdd7fa25992588d6dd">TargetOptions</a> = new <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TargetOptions.html">TargetOptions</a>()<code> [get]</code></td></tr> |
| <tr class="memdesc:a608cbb1028db68bdd7fa25992588d6dd"><td class="mdescLeft"> </td><td class="mdescRight">Gets the target options configuration instance for these Receiver options <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a608cbb1028db68bdd7fa25992588d6dd">More...</a><br /></td></tr> |
| <tr class="separator:a608cbb1028db68bdd7fa25992588d6dd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab174b3eef74428afbc846ba9a8a89b71"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#ab174b3eef74428afbc846ba9a8a89b71">LinkName</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:ab174b3eef74428afbc846ba9a8a89b71"><td class="mdescLeft"> </td><td class="mdescRight">Configures the link name that is assigned to the receiver created from these options. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#ab174b3eef74428afbc846ba9a8a89b71">More...</a><br /></td></tr> |
| <tr class="separator:ab174b3eef74428afbc846ba9a8a89b71"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9d69b2a35c3909139435aa04b8617e1b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a9d69b2a35c3909139435aa04b8617e1b">AutoAccept</a> = true<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a9d69b2a35c3909139435aa04b8617e1b"><td class="mdescLeft"> </td><td class="mdescRight">Controls if receivers created with these options will automatically accept deliveries after they have been delivered to an applications. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a9d69b2a35c3909139435aa04b8617e1b">More...</a><br /></td></tr> |
| <tr class="separator:a9d69b2a35c3909139435aa04b8617e1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a17540e4141bf305e4f8003a1f95e0bd6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a17540e4141bf305e4f8003a1f95e0bd6">AutoSettle</a> = true<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a17540e4141bf305e4f8003a1f95e0bd6"><td class="mdescLeft"> </td><td class="mdescRight">Controls if receivers created with these options will automatically settle deliveries after they have been delivered to an applications. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a17540e4141bf305e4f8003a1f95e0bd6">More...</a><br /></td></tr> |
| <tr class="separator:a17540e4141bf305e4f8003a1f95e0bd6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7b7d758aced96a7adda5992c21af4faf"><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a7b7d758aced96a7adda5992c21af4faf">CreditWindow</a> = 10<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a7b7d758aced96a7adda5992c21af4faf"><td class="mdescLeft"> </td><td class="mdescRight">A credit window value that will be used to maintain an window of credit for Receiver instances that are created from these options. The receiver will allow up to the credit window amount of incoming deliveries to be queued and as they are read from the receiver the window will be extended to maintain a consistent backlog of deliveries. The default is to configure a credit window of 10. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a7b7d758aced96a7adda5992c21af4faf">More...</a><br /></td></tr> |
| <tr class="separator:a7b7d758aced96a7adda5992c21af4faf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5dfbfaca7e288587e386f2785676fa91"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#aa324b7f96b19f0e9bf251a72fd68bd0c">DeliveryMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a5dfbfaca7e288587e386f2785676fa91">DeliveryMode</a> = <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#aa324b7f96b19f0e9bf251a72fd68bd0caf6d671c71857fbf356655879cd21f5ea">DeliveryMode.AtLeastOnce</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a5dfbfaca7e288587e386f2785676fa91"><td class="mdescLeft"> </td><td class="mdescRight">Configures the delivery mode used by receivers created using these options. By default the receivers will use a delivery mode of at least once. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a5dfbfaca7e288587e386f2785676fa91">More...</a><br /></td></tr> |
| <tr class="separator:a5dfbfaca7e288587e386f2785676fa91"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a612519f09e4e2ae4035823f37b7b489a"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a612519f09e4e2ae4035823f37b7b489a">DrainTimeout</a> = ConnectionOptions.DEFAULT_DRAIN_TIMEOUT<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a612519f09e4e2ae4035823f37b7b489a"><td class="mdescLeft"> </td><td class="mdescRight">Configures the drain timeout that is used by all receivers created from these options. This value controls how long a receiver waits for the remote to answer a drain request before considering the drain operation to have failed. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a612519f09e4e2ae4035823f37b7b489a">More...</a><br /></td></tr> |
| <tr class="separator:a612519f09e4e2ae4035823f37b7b489a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d8d8a89650771e6843cbd0cc9b255a6"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a1d8d8a89650771e6843cbd0cc9b255a6">RequestTimeout</a> = ConnectionOptions.DEFAULT_REQUEST_TIMEOUT<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a1d8d8a89650771e6843cbd0cc9b255a6"><td class="mdescLeft"> </td><td class="mdescRight">Configures the request timeout for each receiver created using these options. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a1d8d8a89650771e6843cbd0cc9b255a6">More...</a><br /></td></tr> |
| <tr class="separator:a1d8d8a89650771e6843cbd0cc9b255a6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aae53b09a0dec82085a5941579858c71f"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#aae53b09a0dec82085a5941579858c71f">OpenTimeout</a> = ConnectionOptions.DEFAULT_OPEN_TIMEOUT<code> [get, set]</code></td></tr> |
| <tr class="memdesc:aae53b09a0dec82085a5941579858c71f"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the receiver open timeout value which will be used as the for all senders created using these options. Controls how long a client will wait for a remote to respond to the open of a resource before signalling that the open has failed. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#aae53b09a0dec82085a5941579858c71f">More...</a><br /></td></tr> |
| <tr class="separator:aae53b09a0dec82085a5941579858c71f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd4f9cc289333a623afa252b2ffcc5c9"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#acd4f9cc289333a623afa252b2ffcc5c9">CloseTimeout</a> = ConnectionOptions.DEFAULT_CLOSE_TIMEOUT<code> [get, set]</code></td></tr> |
| <tr class="memdesc:acd4f9cc289333a623afa252b2ffcc5c9"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the receiver close timeout value which will be used as the for all senders created using these options. Controls how long a client will wait for a remote to respond to the open of a resource before signalling that the close has failed. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#acd4f9cc289333a623afa252b2ffcc5c9">More...</a><br /></td></tr> |
| <tr class="separator:acd4f9cc289333a623afa252b2ffcc5c9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a61689e5c2ddd49843202734351169e95"><td class="memItemLeft" align="right" valign="top">string[] </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a61689e5c2ddd49843202734351169e95">OfferedCapabilities</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a61689e5c2ddd49843202734351169e95"><td class="mdescLeft"> </td><td class="mdescRight">Configures the set of capabilities that a new receiver will advertise to the remote. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a61689e5c2ddd49843202734351169e95">More...</a><br /></td></tr> |
| <tr class="separator:a61689e5c2ddd49843202734351169e95"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a53805a1ab394e48a0aa975a0f4f34b58"><td class="memItemLeft" align="right" valign="top">string[] </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a53805a1ab394e48a0aa975a0f4f34b58">DesiredCapabilities</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a53805a1ab394e48a0aa975a0f4f34b58"><td class="mdescLeft"> </td><td class="mdescRight">Sets the collection of capabilities to request from the remote for a new receiver. The desired capabilities inform the remote peer of the various capabilities the sender requires and the remote should return those that it supports in its offered capabilities. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a53805a1ab394e48a0aa975a0f4f34b58">More...</a><br /></td></tr> |
| <tr class="separator:a53805a1ab394e48a0aa975a0f4f34b58"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a95243e6ae0d67f793ee311e4c9aae664"><td class="memItemLeft" align="right" valign="top">IReadOnlyDictionary< string, object > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a95243e6ae0d67f793ee311e4c9aae664">Properties</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a95243e6ae0d67f793ee311e4c9aae664"><td class="mdescLeft"> </td><td class="mdescRight">Configures a collection of property values that are sent to the remote upon opening a new receiver. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a95243e6ae0d67f793ee311e4c9aae664">More...</a><br /></td></tr> |
| <tr class="separator:a95243e6ae0d67f793ee311e4c9aae664"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a1ea360d3be9415475c769b99541fd472"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1ea360d3be9415475c769b99541fd472">◆ </a></span>ReceiverOptions() <span class="overload">[1/2]</span></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.ReceiverOptions.ReceiverOptions </td> |
| <td>(</td> |
| <td class="paramname"></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 default receiver options instance. </p> |
| |
| </div> |
| </div> |
| <a id="aa53fa24cdf6f68fc09f807fb44ca361c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa53fa24cdf6f68fc09f807fb44ca361c">◆ </a></span>ReceiverOptions() <span class="overload">[2/2]</span></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.ReceiverOptions.ReceiverOptions </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html">ReceiverOptions</a> </td> |
| <td class="paramname"><em>other</em></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>Create a new receiver options instance whose settings are copied from the instance provided. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">other</td><td>The sender options instance to copy</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a011b8460791cce733f7becec352cb803"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a011b8460791cce733f7becec352cb803">◆ </a></span>Clone()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual object Apache.Qpid.Proton.Client.ReceiverOptions.Clone </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Clone this options instance, changes to the cloned options are not reflected in this options instance. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A deep copy of this options instance.</dd></dl> |
| |
| <p>Reimplemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html#a767f0c85b1a18c9a7d5d8145528c5685">Apache.Qpid.Proton.Client.StreamReceiverOptions</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a9d69b2a35c3909139435aa04b8617e1b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9d69b2a35c3909139435aa04b8617e1b">◆ </a></span>AutoAccept</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Client.ReceiverOptions.AutoAccept = true</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Controls if receivers created with these options will automatically accept deliveries after they have been delivered to an applications. </p> |
| |
| </div> |
| </div> |
| <a id="a17540e4141bf305e4f8003a1f95e0bd6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a17540e4141bf305e4f8003a1f95e0bd6">◆ </a></span>AutoSettle</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Client.ReceiverOptions.AutoSettle = true</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Controls if receivers created with these options will automatically settle deliveries after they have been delivered to an applications. </p> |
| |
| </div> |
| </div> |
| <a id="acd4f9cc289333a623afa252b2ffcc5c9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acd4f9cc289333a623afa252b2ffcc5c9">◆ </a></span>CloseTimeout</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">long Apache.Qpid.Proton.Client.ReceiverOptions.CloseTimeout = ConnectionOptions.DEFAULT_CLOSE_TIMEOUT</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets or sets the receiver close timeout value which will be used as the for all senders created using these options. Controls how long a client will wait for a remote to respond to the open of a resource before signalling that the close has failed. </p> |
| |
| </div> |
| </div> |
| <a id="a7b7d758aced96a7adda5992c21af4faf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7b7d758aced96a7adda5992c21af4faf">◆ </a></span>CreditWindow</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint Apache.Qpid.Proton.Client.ReceiverOptions.CreditWindow = 10</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A credit window value that will be used to maintain an window of credit for Receiver instances that are created from these options. The receiver will allow up to the credit window amount of incoming deliveries to be queued and as they are read from the receiver the window will be extended to maintain a consistent backlog of deliveries. The default is to configure a credit window of 10. </p> |
| <p>To disable credit windowing and allow the client application to control the credit on the receiver link the credit window value should be set to zero.</p> |
| |
| </div> |
| </div> |
| <a id="a5dfbfaca7e288587e386f2785676fa91"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5dfbfaca7e288587e386f2785676fa91">◆ </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"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#aa324b7f96b19f0e9bf251a72fd68bd0c">DeliveryMode</a> Apache.Qpid.Proton.Client.ReceiverOptions.DeliveryMode = <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#aa324b7f96b19f0e9bf251a72fd68bd0caf6d671c71857fbf356655879cd21f5ea">DeliveryMode.AtLeastOnce</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures the delivery mode used by receivers created using these options. By default the receivers will use a delivery mode of at least once. </p> |
| |
| </div> |
| </div> |
| <a id="a53805a1ab394e48a0aa975a0f4f34b58"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a53805a1ab394e48a0aa975a0f4f34b58">◆ </a></span>DesiredCapabilities</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.ReceiverOptions.DesiredCapabilities</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the collection of capabilities to request from the remote for a new receiver. The desired capabilities inform the remote peer of the various capabilities the sender requires and the remote should return those that it supports in its offered capabilities. </p> |
| |
| </div> |
| </div> |
| <a id="a612519f09e4e2ae4035823f37b7b489a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a612519f09e4e2ae4035823f37b7b489a">◆ </a></span>DrainTimeout</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">long Apache.Qpid.Proton.Client.ReceiverOptions.DrainTimeout = ConnectionOptions.DEFAULT_DRAIN_TIMEOUT</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures the drain timeout that is used by all receivers created from these options. This value controls how long a receiver waits for the remote to answer a drain request before considering the drain operation to have failed. </p> |
| |
| </div> |
| </div> |
| <a id="ab174b3eef74428afbc846ba9a8a89b71"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab174b3eef74428afbc846ba9a8a89b71">◆ </a></span>LinkName</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.ReceiverOptions.LinkName</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures the link name that is assigned to the receiver created from these options. </p> |
| |
| </div> |
| </div> |
| <a id="a61689e5c2ddd49843202734351169e95"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a61689e5c2ddd49843202734351169e95">◆ </a></span>OfferedCapabilities</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.ReceiverOptions.OfferedCapabilities</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures the set of capabilities that a new receiver will advertise to the remote. </p> |
| |
| </div> |
| </div> |
| <a id="aae53b09a0dec82085a5941579858c71f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aae53b09a0dec82085a5941579858c71f">◆ </a></span>OpenTimeout</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">long Apache.Qpid.Proton.Client.ReceiverOptions.OpenTimeout = ConnectionOptions.DEFAULT_OPEN_TIMEOUT</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets or sets the receiver open timeout value which will be used as the for all senders created using these options. Controls how long a client will wait for a remote to respond to the open of a resource before signalling that the open has failed. </p> |
| |
| </div> |
| </div> |
| <a id="a95243e6ae0d67f793ee311e4c9aae664"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a95243e6ae0d67f793ee311e4c9aae664">◆ </a></span>Properties</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IReadOnlyDictionary<string, object> Apache.Qpid.Proton.Client.ReceiverOptions.Properties</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures a collection of property values that are sent to the remote upon opening a new receiver. </p> |
| |
| </div> |
| </div> |
| <a id="a1d8d8a89650771e6843cbd0cc9b255a6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1d8d8a89650771e6843cbd0cc9b255a6">◆ </a></span>RequestTimeout</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">long Apache.Qpid.Proton.Client.ReceiverOptions.RequestTimeout = ConnectionOptions.DEFAULT_REQUEST_TIMEOUT</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Configures the request timeout for each receiver created using these options. </p> |
| |
| </div> |
| </div> |
| <a id="a8ad59d96b7b28d27fd4913b1b85b56a7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8ad59d96b7b28d27fd4913b1b85b56a7">◆ </a></span>SourceOptions</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SourceOptions.html">SourceOptions</a> Apache.Qpid.Proton.Client.ReceiverOptions.SourceOptions = new <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SourceOptions.html">SourceOptions</a>()</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>Gets the source options configuration instance for these Receiver options </p> |
| |
| </div> |
| </div> |
| <a id="a608cbb1028db68bdd7fa25992588d6dd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a608cbb1028db68bdd7fa25992588d6dd">◆ </a></span>TargetOptions</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TargetOptions.html">TargetOptions</a> Apache.Qpid.Proton.Client.ReceiverOptions.TargetOptions = new <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TargetOptions.html">TargetOptions</a>()</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>Gets the target options configuration instance for these Receiver options </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/ReceiverOptions.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |
