| <!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.StreamReceiverOptions 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_1StreamReceiverOptions.html">StreamReceiverOptions</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.StreamReceiverOptions Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.StreamReceiverOptions:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.png" usemap="#Apache.Qpid.Proton.Client.StreamReceiverOptions_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.StreamReceiverOptions_map" name="Apache.Qpid.Proton.Client.StreamReceiverOptions_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html" alt="Apache.Qpid.Proton.Client.ReceiverOptions" shape="rect" coords="0,56,301,80"/> |
| </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:ac302f1757c009a2dfda8477aea790604"><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_1StreamReceiverOptions.html#ac302f1757c009a2dfda8477aea790604">StreamReceiverOptions</a> ()</td></tr> |
| <tr class="memdesc:ac302f1757c009a2dfda8477aea790604"><td class="mdescLeft"> </td><td class="mdescRight">Creates a default stream receiver options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html#ac302f1757c009a2dfda8477aea790604">More...</a><br /></td></tr> |
| <tr class="separator:ac302f1757c009a2dfda8477aea790604"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9ec3466d87fb9d53bb26846c73cad923"><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_1StreamReceiverOptions.html#a9ec3466d87fb9d53bb26846c73cad923">StreamReceiverOptions</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html">StreamReceiverOptions</a> other)</td></tr> |
| <tr class="memdesc:a9ec3466d87fb9d53bb26846c73cad923"><td class="mdescLeft"> </td><td class="mdescRight">Create a new stream receiver options instance whose settings are copied from the instance provided. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html#a9ec3466d87fb9d53bb26846c73cad923">More...</a><br /></td></tr> |
| <tr class="separator:a9ec3466d87fb9d53bb26846c73cad923"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a767f0c85b1a18c9a7d5d8145528c5685"><td class="memItemLeft" align="right" valign="top">override object </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html#a767f0c85b1a18c9a7d5d8145528c5685">Clone</a> ()</td></tr> |
| <tr class="memdesc:a767f0c85b1a18c9a7d5d8145528c5685"><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_1StreamReceiverOptions.html#a767f0c85b1a18c9a7d5d8145528c5685">More...</a><br /></td></tr> |
| <tr class="separator:a767f0c85b1a18c9a7d5d8145528c5685"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html">Apache.Qpid.Proton.Client.ReceiverOptions</a></td></tr> |
| <tr class="memitem:a1ea360d3be9415475c769b99541fd472 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa53fa24cdf6f68fc09f807fb44ca361c inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:aaa71a51018872284dd3c38edfe5020db"><td class="memItemLeft" align="right" valign="top">static readonly uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html#aaa71a51018872284dd3c38edfe5020db">DEFAULT_READ_BUFFER_SIZE</a> = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SessionOptions.html#af57a671b1894704aef66adb6788767b3">SessionOptions.DEFAULT_SESSION_INCOMING_CAPACITY</a></td></tr> |
| <tr class="memdesc:aaa71a51018872284dd3c38edfe5020db"><td class="mdescLeft"> </td><td class="mdescRight">Defines the default read buffering size which is used to control how much incoming data can be buffered before the remote has back pressured applied to avoid out of memory conditions. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html#aaa71a51018872284dd3c38edfe5020db">More...</a><br /></td></tr> |
| <tr class="separator:aaa71a51018872284dd3c38edfe5020db"><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:a34ad4662193ace16dcd199cb48d5690a"><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_1StreamReceiverOptions.html#a34ad4662193ace16dcd199cb48d5690a">ReadBufferSize</a> = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html#aaa71a51018872284dd3c38edfe5020db">DEFAULT_READ_BUFFER_SIZE</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a34ad4662193ace16dcd199cb48d5690a"><td class="mdescLeft"> </td><td class="mdescRight">Configures the incoming buffer capacity (in bytes) that the stream receiver created with these options. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html#a34ad4662193ace16dcd199cb48d5690a">More...</a><br /></td></tr> |
| <tr class="separator:a34ad4662193ace16dcd199cb48d5690a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td colspan="2" onclick="javascript:toggleInherit('properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html">Apache.Qpid.Proton.Client.ReceiverOptions</a></td></tr> |
| <tr class="memitem:a8ad59d96b7b28d27fd4913b1b85b56a7 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a608cbb1028db68bdd7fa25992588d6dd inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab174b3eef74428afbc846ba9a8a89b71 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9d69b2a35c3909139435aa04b8617e1b inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a17540e4141bf305e4f8003a1f95e0bd6 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7b7d758aced96a7adda5992c21af4faf inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5dfbfaca7e288587e386f2785676fa91 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a612519f09e4e2ae4035823f37b7b489a inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d8d8a89650771e6843cbd0cc9b255a6 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aae53b09a0dec82085a5941579858c71f inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd4f9cc289333a623afa252b2ffcc5c9 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a61689e5c2ddd49843202734351169e95 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a53805a1ab394e48a0aa975a0f4f34b58 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a95243e6ae0d67f793ee311e4c9aae664 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="ac302f1757c009a2dfda8477aea790604"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac302f1757c009a2dfda8477aea790604">◆ </a></span>StreamReceiverOptions() <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.StreamReceiverOptions.StreamReceiverOptions </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 stream receiver options instance. </p> |
| |
| </div> |
| </div> |
| <a id="a9ec3466d87fb9d53bb26846c73cad923"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9ec3466d87fb9d53bb26846c73cad923">◆ </a></span>StreamReceiverOptions() <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.StreamReceiverOptions.StreamReceiverOptions </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html">StreamReceiverOptions</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 stream 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 stream receiver options instance to copy</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a767f0c85b1a18c9a7d5d8145528c5685"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a767f0c85b1a18c9a7d5d8145528c5685">◆ </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">override object Apache.Qpid.Proton.Client.StreamReceiverOptions.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 from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1ReceiverOptions.html#a011b8460791cce733f7becec352cb803">Apache.Qpid.Proton.Client.ReceiverOptions</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="aaa71a51018872284dd3c38edfe5020db"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaa71a51018872284dd3c38edfe5020db">◆ </a></span>DEFAULT_READ_BUFFER_SIZE</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">readonly uint Apache.Qpid.Proton.Client.StreamReceiverOptions.DEFAULT_READ_BUFFER_SIZE = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SessionOptions.html#af57a671b1894704aef66adb6788767b3">SessionOptions.DEFAULT_SESSION_INCOMING_CAPACITY</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Defines the default read buffering size which is used to control how much incoming data can be buffered before the remote has back pressured applied to avoid out of memory conditions. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a34ad4662193ace16dcd199cb48d5690a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a34ad4662193ace16dcd199cb48d5690a">◆ </a></span>ReadBufferSize</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.StreamReceiverOptions.ReadBufferSize = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamReceiverOptions.html#aaa71a51018872284dd3c38edfe5020db">DEFAULT_READ_BUFFER_SIZE</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 incoming buffer capacity (in bytes) that the stream receiver created with these options. </p> |
| <p>When the remote peer is sending incoming data for a streamed delivery the amount that is stored in memory before back pressure is applied to the remote is controlled by this option. If the user does not read incoming data as it arrives this limit can prevent out of memory errors that might otherwise arise as the remote attempts to immediately send all contents of very large message payloads. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/StreamReceiverOptions.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> |
