| <!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.SenderOptions 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_1SenderOptions.html">SenderOptions</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_1SenderOptions-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.SenderOptions Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Client.SenderOptions:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.png" usemap="#Apache.Qpid.Proton.Client.SenderOptions_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Client.SenderOptions_map" name="Apache.Qpid.Proton.Client.SenderOptions_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html" title="Special sender options that are applied the streaming senders which allow transmission of large messa..." alt="Apache.Qpid.Proton.Client.StreamSenderOptions" shape="rect" coords="0,112,291,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:a9b504cc2a3f7d58e41dd2041540d90a2"><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_1SenderOptions.html#a9b504cc2a3f7d58e41dd2041540d90a2">SenderOptions</a> ()</td></tr> |
| <tr class="memdesc:a9b504cc2a3f7d58e41dd2041540d90a2"><td class="mdescLeft"> </td><td class="mdescRight">Creates a default sender options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a9b504cc2a3f7d58e41dd2041540d90a2">More...</a><br /></td></tr> |
| <tr class="separator:a9b504cc2a3f7d58e41dd2041540d90a2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9053f65402ea24e6642d1b8574a0c103"><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_1SenderOptions.html#a9053f65402ea24e6642d1b8574a0c103">SenderOptions</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html">SenderOptions</a> other)</td></tr> |
| <tr class="memdesc:a9053f65402ea24e6642d1b8574a0c103"><td class="mdescLeft"> </td><td class="mdescRight">Create a new sender options instance whose settings are copied from the instance provided. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a9053f65402ea24e6642d1b8574a0c103">More...</a><br /></td></tr> |
| <tr class="separator:a9053f65402ea24e6642d1b8574a0c103"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afd5f48c9427801e4a5fce2169c0657cf"><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_1SenderOptions.html#afd5f48c9427801e4a5fce2169c0657cf">Clone</a> ()</td></tr> |
| <tr class="memdesc:afd5f48c9427801e4a5fce2169c0657cf"><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_1SenderOptions.html#afd5f48c9427801e4a5fce2169c0657cf">More...</a><br /></td></tr> |
| <tr class="separator:afd5f48c9427801e4a5fce2169c0657cf"><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:ae718882748d002c67b3cec6b60169536"><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_1SenderOptions.html#ae718882748d002c67b3cec6b60169536">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:ae718882748d002c67b3cec6b60169536"><td class="mdescLeft"> </td><td class="mdescRight">Gets the source options configuration instance for these Sender options <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#ae718882748d002c67b3cec6b60169536">More...</a><br /></td></tr> |
| <tr class="separator:ae718882748d002c67b3cec6b60169536"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a27c9f9762d0c18d2455da30e922e0406"><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_1SenderOptions.html#a27c9f9762d0c18d2455da30e922e0406">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:a27c9f9762d0c18d2455da30e922e0406"><td class="mdescLeft"> </td><td class="mdescRight">Gets the target options configuration instance for these Sender options <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a27c9f9762d0c18d2455da30e922e0406">More...</a><br /></td></tr> |
| <tr class="separator:a27c9f9762d0c18d2455da30e922e0406"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1636a8b23e717955a1f8bbbe1c097c4c"><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_1SenderOptions.html#a1636a8b23e717955a1f8bbbe1c097c4c">LinkName</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a1636a8b23e717955a1f8bbbe1c097c4c"><td class="mdescLeft"> </td><td class="mdescRight">Configures the link name that is assigned to the sender created from these options. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a1636a8b23e717955a1f8bbbe1c097c4c">More...</a><br /></td></tr> |
| <tr class="separator:a1636a8b23e717955a1f8bbbe1c097c4c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeca60710833681542491bdddd113c2a5"><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_1SenderOptions.html#aeca60710833681542491bdddd113c2a5">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:aeca60710833681542491bdddd113c2a5"><td class="mdescLeft"> </td><td class="mdescRight">Configures the delivery mode used by senders created using these options. By default the senders will use a delivery mode of at least once. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#aeca60710833681542491bdddd113c2a5">More...</a><br /></td></tr> |
| <tr class="separator:aeca60710833681542491bdddd113c2a5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a931604d0b84167ba4fcf6246ae244e3a"><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_1SenderOptions.html#a931604d0b84167ba4fcf6246ae244e3a">AutoSettle</a> = true<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a931604d0b84167ba4fcf6246ae244e3a"><td class="mdescLeft"> </td><td class="mdescRight">Configures whether senders created using these options will automatically settle deliveries that were sent once the remote responds that the send was accepted and settled. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a931604d0b84167ba4fcf6246ae244e3a">More...</a><br /></td></tr> |
| <tr class="separator:a931604d0b84167ba4fcf6246ae244e3a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a246afb21ab0639c6691ca091376c3c91"><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_1SenderOptions.html#a246afb21ab0639c6691ca091376c3c91">SendTimeout</a> = ConnectionOptions.DEFAULT_SEND_TIMEOUT<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a246afb21ab0639c6691ca091376c3c91"><td class="mdescLeft"> </td><td class="mdescRight">Configures the send timeout for each sender created using these options. This timeout controls how long a sender will wait for a send to complete before giving up and signalling a send failure. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a246afb21ab0639c6691ca091376c3c91">More...</a><br /></td></tr> |
| <tr class="separator:a246afb21ab0639c6691ca091376c3c91"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0a896fcd3ef824888a88032d6d35b305"><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_1SenderOptions.html#a0a896fcd3ef824888a88032d6d35b305">RequestTimeout</a> = ConnectionOptions.DEFAULT_REQUEST_TIMEOUT<code> [get, set]</code></td></tr> |
| <tr class="memdesc:a0a896fcd3ef824888a88032d6d35b305"><td class="mdescLeft"> </td><td class="mdescRight">Configures the request timeout for each sender created using these options. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a0a896fcd3ef824888a88032d6d35b305">More...</a><br /></td></tr> |
| <tr class="separator:a0a896fcd3ef824888a88032d6d35b305"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed8760dc0c5d4a5f8c98140b10f18208"><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_1SenderOptions.html#aed8760dc0c5d4a5f8c98140b10f18208">OpenTimeout</a> = ConnectionOptions.DEFAULT_OPEN_TIMEOUT<code> [get, set]</code></td></tr> |
| <tr class="memdesc:aed8760dc0c5d4a5f8c98140b10f18208"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the sender 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_1SenderOptions.html#aed8760dc0c5d4a5f8c98140b10f18208">More...</a><br /></td></tr> |
| <tr class="separator:aed8760dc0c5d4a5f8c98140b10f18208"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aff5bd64d499aebec07c29c91885563b9"><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_1SenderOptions.html#aff5bd64d499aebec07c29c91885563b9">CloseTimeout</a> = ConnectionOptions.DEFAULT_CLOSE_TIMEOUT<code> [get, set]</code></td></tr> |
| <tr class="memdesc:aff5bd64d499aebec07c29c91885563b9"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the sender 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_1SenderOptions.html#aff5bd64d499aebec07c29c91885563b9">More...</a><br /></td></tr> |
| <tr class="separator:aff5bd64d499aebec07c29c91885563b9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae5db774cdf05cf470c78fe7c53e9190c"><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_1SenderOptions.html#ae5db774cdf05cf470c78fe7c53e9190c">OfferedCapabilities</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:ae5db774cdf05cf470c78fe7c53e9190c"><td class="mdescLeft"> </td><td class="mdescRight">Configures the set of capabilities that a new sender will advertise to the remote. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#ae5db774cdf05cf470c78fe7c53e9190c">More...</a><br /></td></tr> |
| <tr class="separator:ae5db774cdf05cf470c78fe7c53e9190c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9bd7cd9a4ae580f31445a12e8cc57816"><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_1SenderOptions.html#a9bd7cd9a4ae580f31445a12e8cc57816">DesiredCapabilities</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a9bd7cd9a4ae580f31445a12e8cc57816"><td class="mdescLeft"> </td><td class="mdescRight">Sets the collection of capabilities to request from the remote for a new sender. 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_1SenderOptions.html#a9bd7cd9a4ae580f31445a12e8cc57816">More...</a><br /></td></tr> |
| <tr class="separator:a9bd7cd9a4ae580f31445a12e8cc57816"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:add36f42484efcf9a80a3bdbdb435bc87"><td class="memItemLeft" align="right" valign="top">IDictionary< string, object > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#add36f42484efcf9a80a3bdbdb435bc87">Properties</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:add36f42484efcf9a80a3bdbdb435bc87"><td class="mdescLeft"> </td><td class="mdescRight">Configures a collection of property values that are sent to the remote upon opening a new sender. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#add36f42484efcf9a80a3bdbdb435bc87">More...</a><br /></td></tr> |
| <tr class="separator:add36f42484efcf9a80a3bdbdb435bc87"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8e0b0818e6e63ec6af531a2adc17b29d"><td class="memItemLeft" align="right" valign="top">Func< <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator.html">IDeliveryTagGenerator</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a8e0b0818e6e63ec6af531a2adc17b29d">DeliveryTagGeneratorSupplier</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a8e0b0818e6e63ec6af531a2adc17b29d"><td class="mdescLeft"> </td><td class="mdescRight">Configures a supplier that provides the Delivery Tag Generator instance which the Sender created using these options will use when setting the delivery tag on outgoing deliveries. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a8e0b0818e6e63ec6af531a2adc17b29d">More...</a><br /></td></tr> |
| <tr class="separator:a8e0b0818e6e63ec6af531a2adc17b29d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a9b504cc2a3f7d58e41dd2041540d90a2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9b504cc2a3f7d58e41dd2041540d90a2">◆ </a></span>SenderOptions() <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.SenderOptions.SenderOptions </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 sender options instance. </p> |
| |
| </div> |
| </div> |
| <a id="a9053f65402ea24e6642d1b8574a0c103"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9053f65402ea24e6642d1b8574a0c103">◆ </a></span>SenderOptions() <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.SenderOptions.SenderOptions </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html">SenderOptions</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 sender 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="afd5f48c9427801e4a5fce2169c0657cf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afd5f48c9427801e4a5fce2169c0657cf">◆ </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.SenderOptions.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_1StreamSenderOptions.html#a80782b99fec11dcc7fc2932d5e545b37">Apache.Qpid.Proton.Client.StreamSenderOptions</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a931604d0b84167ba4fcf6246ae244e3a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a931604d0b84167ba4fcf6246ae244e3a">◆ </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.SenderOptions.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>Configures whether senders created using these options will automatically settle deliveries that were sent once the remote responds that the send was accepted and settled. </p> |
| |
| </div> |
| </div> |
| <a id="aff5bd64d499aebec07c29c91885563b9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aff5bd64d499aebec07c29c91885563b9">◆ </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.SenderOptions.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 sender 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="aeca60710833681542491bdddd113c2a5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aeca60710833681542491bdddd113c2a5">◆ </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.SenderOptions.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 senders created using these options. By default the senders will use a delivery mode of at least once. </p> |
| |
| </div> |
| </div> |
| <a id="a8e0b0818e6e63ec6af531a2adc17b29d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8e0b0818e6e63ec6af531a2adc17b29d">◆ </a></span>DeliveryTagGeneratorSupplier</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Func<<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator.html">IDeliveryTagGenerator</a>> Apache.Qpid.Proton.Client.SenderOptions.DeliveryTagGeneratorSupplier</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 supplier that provides the Delivery Tag Generator instance which the Sender created using these options will use when setting the delivery tag on outgoing deliveries. </p> |
| <p>The client sender will use a default delivery tag generator unless a supplier is configured here as such this options is not required to be used. In some cases a client application may want to control exactly what form of delivery tag is used on outgoing deliveries and this mechanism provides that control. The caller is responsible for providing a supplier that will provide unique instance of a tag generator for any sender created with this options instance as the tag generators are not meant to be shared resources. </p> |
| |
| </div> |
| </div> |
| <a id="a9bd7cd9a4ae580f31445a12e8cc57816"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9bd7cd9a4ae580f31445a12e8cc57816">◆ </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.SenderOptions.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 sender. 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="a1636a8b23e717955a1f8bbbe1c097c4c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1636a8b23e717955a1f8bbbe1c097c4c">◆ </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.SenderOptions.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 sender created from these options. </p> |
| |
| </div> |
| </div> |
| <a id="ae5db774cdf05cf470c78fe7c53e9190c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae5db774cdf05cf470c78fe7c53e9190c">◆ </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.SenderOptions.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 sender will advertise to the remote. </p> |
| |
| </div> |
| </div> |
| <a id="aed8760dc0c5d4a5f8c98140b10f18208"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aed8760dc0c5d4a5f8c98140b10f18208">◆ </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.SenderOptions.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 sender 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="add36f42484efcf9a80a3bdbdb435bc87"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#add36f42484efcf9a80a3bdbdb435bc87">◆ </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">IDictionary<string, object> Apache.Qpid.Proton.Client.SenderOptions.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 sender. </p> |
| |
| </div> |
| </div> |
| <a id="a0a896fcd3ef824888a88032d6d35b305"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0a896fcd3ef824888a88032d6d35b305">◆ </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.SenderOptions.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 sender created using these options. </p> |
| |
| </div> |
| </div> |
| <a id="a246afb21ab0639c6691ca091376c3c91"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a246afb21ab0639c6691ca091376c3c91">◆ </a></span>SendTimeout</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.SenderOptions.SendTimeout = ConnectionOptions.DEFAULT_SEND_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 send timeout for each sender created using these options. This timeout controls how long a sender will wait for a send to complete before giving up and signalling a send failure. </p> |
| |
| </div> |
| </div> |
| <a id="ae718882748d002c67b3cec6b60169536"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae718882748d002c67b3cec6b60169536">◆ </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.SenderOptions.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 Sender options </p> |
| |
| </div> |
| </div> |
| <a id="a27c9f9762d0c18d2455da30e922e0406"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a27c9f9762d0c18d2455da30e922e0406">◆ </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.SenderOptions.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 Sender options </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/SenderOptions.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> |
