Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / input / releases / qpid-proton-dotnet-1.0.0-M10 / api / classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html
blob: 39d0d57563677c228309ea17e093f7fdadf415b0 [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.OutputStreamOptions 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_1OutputStreamOptions.html">OutputStreamOptions</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_1OutputStreamOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.OutputStreamOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Options class that controls various aspects of a write only stream instance created to write the contents of a section of a stream sender message.
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Client.OutputStreamOptions:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.png" alt=""/>
</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:a9b2b80912c4d1dfa903ff4991154a051"><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_1OutputStreamOptions.html#a9b2b80912c4d1dfa903ff4991154a051">OutputStreamOptions</a> ()</td></tr>
<tr class="memdesc:a9b2b80912c4d1dfa903ff4991154a051"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a default output stream options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html#a9b2b80912c4d1dfa903ff4991154a051">More...</a><br /></td></tr>
<tr class="separator:a9b2b80912c4d1dfa903ff4991154a051"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f866bcf11d7ae35b06224ddbe3ed18f"><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_1OutputStreamOptions.html#a0f866bcf11d7ae35b06224ddbe3ed18f">OutputStreamOptions</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html">OutputStreamOptions</a> other)</td></tr>
<tr class="memdesc:a0f866bcf11d7ae35b06224ddbe3ed18f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new output stream options instance whose settings are copied from the instance provided. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html#a0f866bcf11d7ae35b06224ddbe3ed18f">More...</a><br /></td></tr>
<tr class="separator:a0f866bcf11d7ae35b06224ddbe3ed18f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4373e098c70e0041636432ec5bb26f87"><td class="memItemLeft" align="right" valign="top">virtual object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html#a4373e098c70e0041636432ec5bb26f87">Clone</a> ()</td></tr>
<tr class="memdesc:a4373e098c70e0041636432ec5bb26f87"><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_1OutputStreamOptions.html#a4373e098c70e0041636432ec5bb26f87">More...</a><br /></td></tr>
<tr class="separator:a4373e098c70e0041636432ec5bb26f87"><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:a3da0adbdc8786626ac68c84130706b77"><td class="memItemLeft" align="right" valign="top"><a id="a3da0adbdc8786626ac68c84130706b77"></a>
static readonly bool&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_COMPLETE_SEND_ON_CLOSE</b> = true</td></tr>
<tr class="separator:a3da0adbdc8786626ac68c84130706b77"><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:af374b1d2e10ff602143c6e04b78af777"><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_1OutputStreamOptions.html#af374b1d2e10ff602143c6e04b78af777">CompleteSendOnClose</a> = DEFAULT_COMPLETE_SEND_ON_CLOSE<code> [get, set]</code></td></tr>
<tr class="memdesc:af374b1d2e10ff602143c6e04b78af777"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures if the close of the <a class="el" href="">OutputStream</a> should result in a completion of the parent stream sender message (default is true). If there is a configured stream size and the stream is closed the parent stream sender message will always be aborted as the send would be incomplete, but the close of an Stream may not always be the desired outcome. In the case the user wishes to add a footer to the message transmitted by the stream sender message this option should be set to false and the user should complete the stream manually. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html#af374b1d2e10ff602143c6e04b78af777">More...</a><br /></td></tr>
<tr class="separator:af374b1d2e10ff602143c6e04b78af777"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa07a3604e27168a14e78d4953acf69e9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html#aa07a3604e27168a14e78d4953acf69e9">BodyLength</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aa07a3604e27168a14e78d4953acf69e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the overall stream size for this associated <a class="el" href="">OutputStream</a> that the options are applied to. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html#aa07a3604e27168a14e78d4953acf69e9">More...</a><br /></td></tr>
<tr class="separator:aa07a3604e27168a14e78d4953acf69e9"><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>Options class that controls various aspects of a write only stream instance created to write the contents of a section of a stream sender message. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9b2b80912c4d1dfa903ff4991154a051"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b2b80912c4d1dfa903ff4991154a051">&#9670;&nbsp;</a></span>OutputStreamOptions() <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.OutputStreamOptions.OutputStreamOptions </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 output stream options instance. </p>
</div>
</div>
<a id="a0f866bcf11d7ae35b06224ddbe3ed18f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f866bcf11d7ae35b06224ddbe3ed18f">&#9670;&nbsp;</a></span>OutputStreamOptions() <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.OutputStreamOptions.OutputStreamOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1OutputStreamOptions.html">OutputStreamOptions</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 output stream 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="a4373e098c70e0041636432ec5bb26f87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4373e098c70e0041636432ec5bb26f87">&#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">virtual object Apache.Qpid.Proton.Client.OutputStreamOptions.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>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="aa07a3604e27168a14e78d4953acf69e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa07a3604e27168a14e78d4953acf69e9">&#9670;&nbsp;</a></span>BodyLength</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Qpid.Proton.Client.OutputStreamOptions.BodyLength</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 stream size for this associated <a class="el" href="">OutputStream</a> that the options are applied to. </p>
<p>When set this option indicates the number of bytes that can be written to the stream before an error would be thrown indicating that this value was exceeded. Conversely if the stream is closed before the number of bytes indicated is written the send will be aborted and an error will be thrown to the caller. </p>
</div>
</div>
<a id="af374b1d2e10ff602143c6e04b78af777"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af374b1d2e10ff602143c6e04b78af777">&#9670;&nbsp;</a></span>CompleteSendOnClose</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.OutputStreamOptions.CompleteSendOnClose = DEFAULT_COMPLETE_SEND_ON_CLOSE</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 if the close of the <a class="el" href="">OutputStream</a> should result in a completion of the parent stream sender message (default is true). If there is a configured stream size and the stream is closed the parent stream sender message will always be aborted as the send would be incomplete, but the close of an Stream may not always be the desired outcome. In the case the user wishes to add a footer to the message transmitted by the stream sender message this option should be set to false and the user should complete the stream manually. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/OutputStreamOptions.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>