Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / content / releases / qpid-proton-dotnet-1.0.0-M10 / api / classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html
blob: b3699c5a61e7b6f3c6bf796de27d2c5c2a9d6f5b [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Proton DotNet: Apache.Qpid.Proton.Client.StreamSenderOptions Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Proton DotNet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html">StreamSenderOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.StreamSenderOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Special sender options that are applied the streaming senders which allow transmission of large message payloads.
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Client.StreamSenderOptions:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.png" usemap="#Apache.Qpid.Proton.Client.StreamSenderOptions_map" alt=""/>
<map id="Apache.Qpid.Proton.Client.StreamSenderOptions_map" name="Apache.Qpid.Proton.Client.StreamSenderOptions_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html" alt="Apache.Qpid.Proton.Client.SenderOptions" shape="rect" coords="0,56,291,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:a80c95827d87b1826ff7f4cc5ba96485a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a80c95827d87b1826ff7f4cc5ba96485a">StreamSenderOptions</a> ()</td></tr>
<tr class="memdesc:a80c95827d87b1826ff7f4cc5ba96485a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a default stream sender options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a80c95827d87b1826ff7f4cc5ba96485a">More...</a><br /></td></tr>
<tr class="separator:a80c95827d87b1826ff7f4cc5ba96485a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a706ea592407454afc23ca2f24a591b4a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a706ea592407454afc23ca2f24a591b4a">StreamSenderOptions</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html">StreamSenderOptions</a> other)</td></tr>
<tr class="memdesc:a706ea592407454afc23ca2f24a591b4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new stream sender options instance whose settings are copied from the instance provided. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a706ea592407454afc23ca2f24a591b4a">More...</a><br /></td></tr>
<tr class="separator:a706ea592407454afc23ca2f24a591b4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80782b99fec11dcc7fc2932d5e545b37"><td class="memItemLeft" align="right" valign="top">override object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a80782b99fec11dcc7fc2932d5e545b37">Clone</a> ()</td></tr>
<tr class="memdesc:a80782b99fec11dcc7fc2932d5e545b37"><td class="mdescLeft">&#160;</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_1StreamSenderOptions.html#a80782b99fec11dcc7fc2932d5e545b37">More...</a><br /></td></tr>
<tr class="separator:a80782b99fec11dcc7fc2932d5e545b37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html">Apache.Qpid.Proton.Client.SenderOptions</a></td></tr>
<tr class="memitem:a9b504cc2a3f7d58e41dd2041540d90a2 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">&#160;</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 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9053f65402ea24e6642d1b8574a0c103 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">&#160;</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 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</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:a52f11981d2290a001788dc93432d0baa"><td class="memItemLeft" align="right" valign="top">static readonly uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a52f11981d2290a001788dc93432d0baa">DEFAULT_PENDING_WRITES_BUFFER_SIZE</a> = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SessionOptions.html#a4ad9ae8098b470e919f29a0f411dce0a">SessionOptions.DEFAULT_SESSION_OUTGOING_CAPACITY</a></td></tr>
<tr class="memdesc:a52f11981d2290a001788dc93432d0baa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the default pending write buffering size which is used to control how much outgoing data can be buffered for local writing before the sender has back pressured applied to avoid out of memory conditions due to overly large pending batched writes. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a52f11981d2290a001788dc93432d0baa">More...</a><br /></td></tr>
<tr class="separator:a52f11981d2290a001788dc93432d0baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b384148dc4b435fa0671945c0e5e4b9"><td class="memItemLeft" align="right" valign="top">static readonly uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a9b384148dc4b435fa0671945c0e5e4b9">MIN_BUFFER_SIZE_LIMIT</a> = 256</td></tr>
<tr class="memdesc:a9b384148dc4b435fa0671945c0e5e4b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the default minimum size that the context write buffer will allocate which drives the interval auto flushing of written data for this context. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a9b384148dc4b435fa0671945c0e5e4b9">More...</a><br /></td></tr>
<tr class="separator:a9b384148dc4b435fa0671945c0e5e4b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a8b6871cb5528560e179f5f39276741c4"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a8b6871cb5528560e179f5f39276741c4">WriteBufferSize</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a8b6871cb5528560e179f5f39276741c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the overall number of bytes the stream sender will buffer before automatically flushing the currently buffered bytes. By default the stream sender implementation chooses a value for this buffer limit based on the configured frame size limits of the connection. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a8b6871cb5528560e179f5f39276741c4">More...</a><br /></td></tr>
<tr class="separator:a8b6871cb5528560e179f5f39276741c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b958121de243546a6e1414b5d6128be"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a1b958121de243546a6e1414b5d6128be">PendingWriteBufferSize</a> = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a52f11981d2290a001788dc93432d0baa">DEFAULT_PENDING_WRITES_BUFFER_SIZE</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a1b958121de243546a6e1414b5d6128be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the overall number of bytes the stream sender will allow to be pending for write before applying back pressure to the stream write caller. By default the stream sender implementation chooses a value for this pending write limit based on the configured frame size limits of the connection. This is an advanced option and should not be used unless the impact of doing so is understood by the user. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a1b958121de243546a6e1414b5d6128be">More...</a><br /></td></tr>
<tr class="separator:a1b958121de243546a6e1414b5d6128be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td colspan="2" onclick="javascript:toggleInherit('properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html">Apache.Qpid.Proton.Client.SenderOptions</a></td></tr>
<tr class="memitem:ae718882748d002c67b3cec6b60169536 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SourceOptions.html">SourceOptions</a>&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27c9f9762d0c18d2455da30e922e0406 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1TargetOptions.html">TargetOptions</a>&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1636a8b23e717955a1f8bbbe1c097c4c inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a1636a8b23e717955a1f8bbbe1c097c4c">LinkName</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a1636a8b23e717955a1f8bbbe1c097c4c inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeca60710833681542491bdddd113c2a5 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html#aa324b7f96b19f0e9bf251a72fd68bd0c">DeliveryMode</a>&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a931604d0b84167ba4fcf6246ae244e3a inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">bool&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a246afb21ab0639c6691ca091376c3c91 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">long&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a896fcd3ef824888a88032d6d35b305 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">long&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed8760dc0c5d4a5f8c98140b10f18208 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">long&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff5bd64d499aebec07c29c91885563b9 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">long&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5db774cdf05cf470c78fe7c53e9190c inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">string[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#ae5db774cdf05cf470c78fe7c53e9190c">OfferedCapabilities</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ae5db774cdf05cf470c78fe7c53e9190c inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bd7cd9a4ae580f31445a12e8cc57816 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">string[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions.html#a9bd7cd9a4ae580f31445a12e8cc57816">DesiredCapabilities</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a9bd7cd9a4ae580f31445a12e8cc57816 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add36f42484efcf9a80a3bdbdb435bc87 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">IDictionary&lt; string, object &gt;&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e0b0818e6e63ec6af531a2adc17b29d inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memItemLeft" align="right" valign="top">Func&lt; <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IDeliveryTagGenerator.html">IDeliveryTagGenerator</a> &gt;&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="mdescLeft">&#160;</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 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Client_1_1SenderOptions"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Special sender options that are applied the streaming senders which allow transmission of large message payloads. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a80c95827d87b1826ff7f4cc5ba96485a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80c95827d87b1826ff7f4cc5ba96485a">&#9670;&nbsp;</a></span>StreamSenderOptions() <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.StreamSenderOptions.StreamSenderOptions </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 sender options instance. </p>
</div>
</div>
<a id="a706ea592407454afc23ca2f24a591b4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a706ea592407454afc23ca2f24a591b4a">&#9670;&nbsp;</a></span>StreamSenderOptions() <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.StreamSenderOptions.StreamSenderOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html">StreamSenderOptions</a>&#160;</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 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 stream sender options instance to copy</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a80782b99fec11dcc7fc2932d5e545b37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80782b99fec11dcc7fc2932d5e545b37">&#9670;&nbsp;</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.StreamSenderOptions.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_1SenderOptions.html#afd5f48c9427801e4a5fce2169c0657cf">Apache.Qpid.Proton.Client.SenderOptions</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a52f11981d2290a001788dc93432d0baa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52f11981d2290a001788dc93432d0baa">&#9670;&nbsp;</a></span>DEFAULT_PENDING_WRITES_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.StreamSenderOptions.DEFAULT_PENDING_WRITES_BUFFER_SIZE = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SessionOptions.html#a4ad9ae8098b470e919f29a0f411dce0a">SessionOptions.DEFAULT_SESSION_OUTGOING_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 pending write buffering size which is used to control how much outgoing data can be buffered for local writing before the sender has back pressured applied to avoid out of memory conditions due to overly large pending batched writes. </p>
</div>
</div>
<a id="a9b384148dc4b435fa0671945c0e5e4b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b384148dc4b435fa0671945c0e5e4b9">&#9670;&nbsp;</a></span>MIN_BUFFER_SIZE_LIMIT</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.StreamSenderOptions.MIN_BUFFER_SIZE_LIMIT = 256</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 minimum size that the context write buffer will allocate which drives the interval auto flushing of written data for this context. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a1b958121de243546a6e1414b5d6128be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b958121de243546a6e1414b5d6128be">&#9670;&nbsp;</a></span>PendingWriteBufferSize</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.StreamSenderOptions.PendingWriteBufferSize = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1StreamSenderOptions.html#a52f11981d2290a001788dc93432d0baa">DEFAULT_PENDING_WRITES_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>Sets the overall number of bytes the stream sender will allow to be pending for write before applying back pressure to the stream write caller. By default the stream sender implementation chooses a value for this pending write limit based on the configured frame size limits of the connection. This is an advanced option and should not be used unless the impact of doing so is understood by the user. </p>
</div>
</div>
<a id="a8b6871cb5528560e179f5f39276741c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b6871cb5528560e179f5f39276741c4">&#9670;&nbsp;</a></span>WriteBufferSize</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.StreamSenderOptions.WriteBufferSize</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 overall number of bytes the stream sender will buffer before automatically flushing the currently buffered bytes. By default the stream sender implementation chooses a value for this buffer limit based on the configured frame size limits of the connection. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/StreamSenderOptions.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>