content/releases/qpid-protonj2-1.0.0-M9/api/org/apache/qpid/protonj2/client/StreamSenderMessage.html - qpid-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>StreamSenderMessage (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="StreamSenderMessage (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/StreamSenderMessage.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client</a></div>
 <h2 title="Interface StreamSenderMessage" class="title">Interface StreamSenderMessage</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a>&gt;</code>, <code><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a>&gt;</code></dd>
 </dl>
 <hr>
 <pre>public interface <span class="typeNameLabel">StreamSenderMessage</span>
 extends <a href="AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a>&gt;</pre>
 <div class="block">Streaming Message Tracker object used to operate on and track the state of a streamed message
  at the remote. The <a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSenderMessage</code></a> allows for local settlement and disposition management
  as well as waiting for remote settlement of a streamed message.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code><a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client">StreamSenderMessage</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#abort()">abort</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Marks the currently streaming message as being aborted.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#aborted()">aborted</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#body(org.apache.qpid.protonj2.client.OutputStreamOptions)">body</a></span>&#8203;(<a href="OutputStreamOptions.html" title="class in org.apache.qpid.protonj2.client">OutputStreamOptions</a>&nbsp;options)</code></th>
 <td class="colLast">
 <div class="block">Creates an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> instance configured with the given options which will
  write the bytes as the payload of one or more AMQP <a href="../types/messaging/Data.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Data</code></a> sections based on the
  provided configuration..</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code><a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client">StreamSenderMessage</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#complete()">complete</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Marks the currently streaming message as being complete.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#completed()">completed</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code><a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client">StreamSenderMessage</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#messageFormat(int)">messageFormat</a></span>&#8203;(int&nbsp;messageFormat)</code></th>
 <td class="colLast">
 <div class="block">Sets the configured message format value that will be set on the first outgoing
  AMQP <a href="../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> frame for the delivery that comprises this streamed message.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rawOutputStream()">rawOutputStream</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Creates an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> instance that writes the bytes given without additional
  encoding or transformation.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code><a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sender()">sender</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code><a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tracker()">tracker</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.client.AdvancedMessage">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.qpid.protonj2.client.<a href="AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a></h3>
 <code><a href="AdvancedMessage.html#addBodySection(org.apache.qpid.protonj2.types.messaging.Section)">addBodySection</a>, <a href="AdvancedMessage.html#annotations()">annotations</a>, <a href="AdvancedMessage.html#annotations(org.apache.qpid.protonj2.types.messaging.MessageAnnotations)">annotations</a>, <a href="AdvancedMessage.html#applicationProperties()">applicationProperties</a>, <a href="AdvancedMessage.html#applicationProperties(org.apache.qpid.protonj2.types.messaging.ApplicationProperties)">applicationProperties</a>, <a href="AdvancedMessage.html#bodySections()">bodySections</a>, <a href="AdvancedMessage.html#bodySections(java.util.Collection)">bodySections</a>, <a href="AdvancedMessage.html#clearBodySections()">clearBodySections</a>, <a href="AdvancedMessage.html#encode(java.util.Map)">encode</a>, <a href="AdvancedMessage.html#footer()">footer</a>, <a href="AdvancedMessage.html#footer(org.apache.qpid.protonj2.types.messaging.Footer)">footer</a>, <a href="AdvancedMessage.html#forEachBodySection(java.util.function.Consumer)">forEachBodySection</a>, <a href="AdvancedMessage.html#header()">header</a>, <a href="AdvancedMessage.html#header(org.apache.qpid.protonj2.types.messaging.Header)">header</a>, <a href="AdvancedMessage.html#messageFormat()">messageFormat</a>, <a href="AdvancedMessage.html#properties()">properties</a>, <a href="AdvancedMessage.html#properties(org.apache.qpid.protonj2.types.messaging.Properties)">properties</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.client.Message">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.qpid.protonj2.client.<a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a></h3>
 <code><a href="Message.html#absoluteExpiryTime()">absoluteExpiryTime</a>, <a href="Message.html#absoluteExpiryTime(long)">absoluteExpiryTime</a>, <a href="Message.html#annotation(java.lang.String)">annotation</a>, <a href="Message.html#annotation(java.lang.String,java.lang.Object)">annotation</a>, <a href="Message.html#body()">body</a>, <a href="Message.html#body(E)">body</a>, <a href="Message.html#contentEncoding()">contentEncoding</a>, <a href="Message.html#contentEncoding(java.lang.String)">contentEncoding</a>, <a href="Message.html#contentType()">contentType</a>, <a href="Message.html#contentType(java.lang.String)">contentType</a>, <a href="Message.html#correlationId()">correlationId</a>, <a href="Message.html#correlationId(java.lang.Object)">correlationId</a>, <a href="Message.html#creationTime()">creationTime</a>, <a href="Message.html#creationTime(long)">creationTime</a>, <a href="Message.html#deliveryCount()">deliveryCount</a>, <a href="Message.html#deliveryCount(long)">deliveryCount</a>, <a href="Message.html#durable()">durable</a>, <a href="Message.html#durable(boolean)">durable</a>, <a href="Message.html#firstAcquirer()">firstAcquirer</a>, <a href="Message.html#firstAcquirer(boolean)">firstAcquirer</a>, <a href="Message.html#footer(java.lang.String)">footer</a>, <a href="Message.html#footer(java.lang.String,java.lang.Object)">footer</a>, <a href="Message.html#forEachAnnotation(java.util.function.BiConsumer)">forEachAnnotation</a>, <a href="Message.html#forEachFooter(java.util.function.BiConsumer)">forEachFooter</a>, <a href="Message.html#forEachProperty(java.util.function.BiConsumer)">forEachProperty</a>, <a href="Message.html#groupId()">groupId</a>, <a href="Message.html#groupId(java.lang.String)">groupId</a>, <a href="Message.html#groupSequence()">groupSequence</a>, <a href="Message.html#groupSequence(int)">groupSequence</a>, <a href="Message.html#hasAnnotation(java.lang.String)">hasAnnotation</a>, <a href="Message.html#hasAnnotations()">hasAnnotations</a>, <a href="Message.html#hasFooter(java.lang.String)">hasFooter</a>, <a href="Message.html#hasFooters()">hasFooters</a>, <a href="Message.html#hasProperties()">hasProperties</a>, <a href="Message.html#hasProperty(java.lang.String)">hasProperty</a>, <a href="Message.html#messageId()">messageId</a>, <a href="Message.html#messageId(java.lang.Object)">messageId</a>, <a href="Message.html#priority()">priority</a>, <a href="Message.html#priority(byte)">priority</a>, <a href="Message.html#property(java.lang.String)">property</a>, <a href="Message.html#property(java.lang.String,java.lang.Object)">property</a>, <a href="Message.html#removeAnnotation(java.lang.String)">removeAnnotation</a>, <a href="Message.html#removeFooter(java.lang.String)">removeFooter</a>, <a href="Message.html#removeProperty(java.lang.String)">removeProperty</a>, <a href="Message.html#replyTo()">replyTo</a>, <a href="Message.html#replyTo(java.lang.String)">replyTo</a>, <a href="Message.html#replyToGroupId()">replyToGroupId</a>, <a href="Message.html#replyToGroupId(java.lang.String)">replyToGroupId</a>, <a href="Message.html#subject()">subject</a>, <a href="Message.html#subject(java.lang.String)">subject</a>, <a href="Message.html#timeToLive()">timeToLive</a>, <a href="Message.html#timeToLive(long)">timeToLive</a>, <a href="Message.html#to()">to</a>, <a href="Message.html#to(java.lang.String)">to</a>, <a href="Message.html#toAdvancedMessage()">toAdvancedMessage</a>, <a href="Message.html#userId()">userId</a>, <a href="Message.html#userId(byte%5B%5D)">userId</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="tracker()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>tracker</h4>
 <pre class="methodSignature"><a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a>&nbsp;tracker()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The <a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client"><code>Tracker</code></a> assigned to monitor the life-cycle of this <a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSenderMessage</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="sender()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>sender</h4>
 <pre class="methodSignature"><a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a>&nbsp;sender()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> that was used to send the delivery that is being tracked.</dd>
 </dl>
 </li>
 </ul>
 <a id="messageFormat(int)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>messageFormat</h4>
 <pre class="methodSignature"><a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client">StreamSenderMessage</a>&nbsp;messageFormat&#8203;(int&nbsp;messageFormat)
                            throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Sets the configured message format value that will be set on the first outgoing
  AMQP <a href="../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> frame for the delivery that comprises this streamed message.
  This value can only be updated before write operation is attempted and will throw
  an <a href="exceptions/ClientIllegalStateException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientIllegalStateException</code></a> if any attempt to alter the value is made
  following a write.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="AdvancedMessage.html#messageFormat(int)">messageFormat</a></code>&nbsp;in interface&nbsp;<code><a href="AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a>&gt;</code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>messageFormat</code> - The assigned AMQP message format for this streamed message.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>this <a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSenderMessage</code></a> instance.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while attempting set the message format.</dd>
 </dl>
 </li>
 </ul>
 <a id="complete()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>complete</h4>
 <pre class="methodSignature"><a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client">StreamSenderMessage</a>&nbsp;complete()
                       throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Marks the currently streaming message as being complete.
  <p>
  Marking a message as complete finalizes the streaming send operation and causes a
  final <a href="../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> frame to be sent to the remote indicating that the ongoing
  streaming delivery is done and no more message data will arrive.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>this <a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSenderMessage</code></a> instance.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while initiating the completion operation.</dd>
 </dl>
 </li>
 </ul>
 <a id="completed()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>completed</h4>
 <pre class="methodSignature">boolean&nbsp;completed()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if this message has been marked as being complete.</dd>
 </dl>
 </li>
 </ul>
 <a id="abort()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>abort</h4>
 <pre class="methodSignature"><a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client">StreamSenderMessage</a>&nbsp;abort()
                    throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Marks the currently streaming message as being aborted. Once aborted no further
  writes regardless of whether any writes have yet been performed or not.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>this <a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSenderMessage</code></a> instance.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while initiating the abort operation.</dd>
 </dl>
 </li>
 </ul>
 <a id="aborted()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>aborted</h4>
 <pre class="methodSignature">boolean&nbsp;aborted()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if this <a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSenderMessage</code></a> has been marked as aborted previously.</dd>
 </dl>
 </li>
 </ul>
 <a id="body(org.apache.qpid.protonj2.client.OutputStreamOptions)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>body</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a>&nbsp;body&#8203;(<a href="OutputStreamOptions.html" title="class in org.apache.qpid.protonj2.client">OutputStreamOptions</a>&nbsp;options)
            throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Creates an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> instance configured with the given options which will
  write the bytes as the payload of one or more AMQP <a href="../types/messaging/Data.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Data</code></a> sections based on the
  provided configuration..
  <p>
  The returned <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> can be used to write the payload of an AMQP Message in
  chunks when the source is not readily available in memory or as part of a larger streams
  based component.  The <a href="../types/messaging/Data.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Data</code></a> section based stream allows for control over the AMQP
  message <a href="../types/messaging/Section.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Section</code></a> values that are sent but does the encoding itself.  For stream
  of message data where the content source already consists of an AMQP encoded message refer
  to the <a href="#rawOutputStream()"><code>rawOutputStream()</code></a> method.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>options</code> - The stream options to use to configure the returned <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> instance configured using the given options.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while creating the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a>.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="#rawOutputStream()"><code>rawOutputStream()</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="rawOutputStream()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>rawOutputStream</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a>&nbsp;rawOutputStream()
                       throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Creates an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> instance that writes the bytes given without additional
  encoding or transformation.  Using this stream option disables use of any other <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>
  APIs and the message transfer is completed upon close of this <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a>.
  <p>
  The returned <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> can be used to write the payload of an AMQP Message in
  chunks when the source is not readily available in memory or as part of a larger streams
  based component.  The source of the bytes written to the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> should
  consist of already encoded AMQP <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> data.  For an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> that
  performs the encoding of message data refer to the <a href="#body(org.apache.qpid.protonj2.client.OutputStreamOptions)"><code>body(OutputStreamOptions)</code></a>
  method.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a> instance that performs no encoding.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while creating the <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>OutputStream</code></a>.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="#body(org.apache.qpid.protonj2.client.OutputStreamOptions)"><code>body(org.apache.qpid.protonj2.client.OutputStreamOptions)</code></a>,
 <a href="#body(org.apache.qpid.protonj2.client.OutputStreamOptions)"><code>body(OutputStreamOptions)</code></a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/StreamSenderMessage.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>