Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / input / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / client / impl / ClientStreamDelivery.html
blob: 03c08f31d9e8e0dda5034bd3be888890ca6174ac [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ClientStreamDelivery (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="ClientStreamDelivery (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/ClientStreamDelivery.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><a href="#field.summary">Field</a>&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.impl</a></div>
<h2 title="Class ClientStreamDelivery" class="title">Class ClientStreamDelivery</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="ClientDeliverable.html" title="class in org.apache.qpid.protonj2.client.impl">org.apache.qpid.protonj2.client.impl.ClientDeliverable</a>&lt;<a href="ClientStreamDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamDelivery</a>,&#8203;<a href="ClientStreamReceiver.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamReceiver</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.client.impl.ClientStreamDelivery</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">ClientStreamDelivery</span>
extends <a href="ClientDeliverable.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDeliverable</a>&lt;<a href="ClientStreamDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamDelivery</a>,&#8203;<a href="ClientStreamReceiver.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamReceiver</a>&gt;
implements <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></pre>
<div class="block">A <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> implementation that provides the mechanics of reading message
types from an incoming split framed transfer.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.qpid.protonj2.client.impl.ClientDeliverable">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.qpid.protonj2.client.impl.<a href="ClientDeliverable.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDeliverable</a></h3>
<code><a href="ClientDeliverable.html#delivery">delivery</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#aborted()">aborted</a></span>()</code></th>
<td class="colLast">
<div class="block">Check if the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> has been marked as aborted by the remote sender.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#annotations()">annotations</a></span>()</code></th>
<td class="colLast">
<div class="block">Decodes the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> payload and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> containing a copy
of any associated <a href="../../types/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>DeliveryAnnotations</code></a> that were transmitted with the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>
payload of this <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a>.</div>
</td>
</tr>
<tr id="i2" 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">
<div class="block">Check if the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> has been marked as complete by the remote sender.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="ClientStreamReceiverMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamReceiverMessage</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#message()">message</a></span>()</code></th>
<td class="colLast">
<div class="block">Decode the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> payload and return an <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rawInputStream()">rawInputStream</a></span>()</code></th>
<td class="colLast">
<div class="block">Create and return an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>InputStream</code></a> that reads the raw payload bytes of the given <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ClientStreamReceiver.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamReceiver</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiver()">receiver</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <a href="ClientStreamDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamDelivery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#self()">self</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.impl.ClientDeliverable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.qpid.protonj2.client.impl.<a href="ClientDeliverable.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDeliverable</a></h3>
<code><a href="ClientDeliverable.html#accept()">accept</a>, <a href="ClientDeliverable.html#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)">disposition</a>, <a href="ClientDeliverable.html#messageFormat()">messageFormat</a>, <a href="ClientDeliverable.html#modified(boolean,boolean)">modified</a>, <a href="ClientDeliverable.html#reject(java.lang.String,java.lang.String)">reject</a>, <a href="ClientDeliverable.html#release()">release</a>, <a href="ClientDeliverable.html#remoteSettled()">remoteSettled</a>, <a href="ClientDeliverable.html#remoteState()">remoteState</a>, <a href="ClientDeliverable.html#settle()">settle</a>, <a href="ClientDeliverable.html#settled()">settled</a>, <a href="ClientDeliverable.html#state()">state</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.client.StreamDelivery">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.protonj2.client.<a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></h3>
<code><a href="../StreamDelivery.html#accept()">accept</a>, <a href="../StreamDelivery.html#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)">disposition</a>, <a href="../StreamDelivery.html#messageFormat()">messageFormat</a>, <a href="../StreamDelivery.html#modified(boolean,boolean)">modified</a>, <a href="../StreamDelivery.html#reject(java.lang.String,java.lang.String)">reject</a>, <a href="../StreamDelivery.html#release()">release</a>, <a href="../StreamDelivery.html#remoteSettled()">remoteSettled</a>, <a href="../StreamDelivery.html#remoteState()">remoteState</a>, <a href="../StreamDelivery.html#settle()">settle</a>, <a href="../StreamDelivery.html#settled()">settled</a>, <a href="../StreamDelivery.html#state()">state</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="self()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>self</h4>
<pre class="methodSignature">protected&nbsp;<a href="ClientStreamDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamDelivery</a>&nbsp;self()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientDeliverable.html#self()">self</a></code>&nbsp;in class&nbsp;<code><a href="ClientDeliverable.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDeliverable</a>&lt;<a href="ClientStreamDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamDelivery</a>,&#8203;<a href="ClientStreamReceiver.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamReceiver</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="receiver()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receiver</h4>
<pre class="methodSignature">public&nbsp;<a href="ClientStreamReceiver.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamReceiver</a>&nbsp;receiver()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../StreamDelivery.html#receiver()">receiver</a></code>&nbsp;in interface&nbsp;<code><a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> that originated this <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a>.</dd>
</dl>
</li>
</ul>
<a id="aborted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aborted</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;aborted()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../StreamDelivery.html#aborted()">StreamDelivery</a></code></span></div>
<div class="block">Check if the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> has been marked as aborted by the remote sender.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../StreamDelivery.html#aborted()">aborted</a></code>&nbsp;in interface&nbsp;<code><a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this context has been marked as aborted previously.</dd>
</dl>
</li>
</ul>
<a id="completed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completed</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;completed()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../StreamDelivery.html#completed()">StreamDelivery</a></code></span></div>
<div class="block">Check if the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> has been marked as complete by the remote sender.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../StreamDelivery.html#completed()">completed</a></code>&nbsp;in interface&nbsp;<code><a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this context has been marked as being the complete.</dd>
</dl>
</li>
</ul>
<a id="message()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>message</h4>
<pre class="methodSignature">public&nbsp;<a href="ClientStreamReceiverMessage.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamReceiverMessage</a>&nbsp;message()
throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../StreamDelivery.html#message()">StreamDelivery</a></code></span></div>
<div class="block">Decode the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> payload and return an <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> object.
<p>
If the incoming message carried any delivery annotations they can be accessed via the
<a href="../StreamDelivery.html#annotations()"><code>StreamDelivery.annotations()</code></a> method. Re-sending the returned message will not also
send the incoming delivery annotations, the sender must include them in the
<a href="../Sender.html#send(org.apache.qpid.protonj2.client.Message,java.util.Map)"><code>Sender.send(Message, Map)</code></a> call if they are to be forwarded onto the next recipient.
<p>
Calling this message claims the payload of the delivery for the returned <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> and
excludes use of the <a href="../StreamDelivery.html#rawInputStream()"><code>StreamDelivery.rawInputStream()</code></a> method of the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> object. Calling
the <a href="../StreamDelivery.html#rawInputStream()"><code>StreamDelivery.rawInputStream()</code></a> method after calling this method throws <a href="../exceptions/ClientIllegalStateException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientIllegalStateException</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../StreamDelivery.html#message()">message</a></code>&nbsp;in interface&nbsp;<code><a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> instance that wraps the decoded payload.</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 decoding the payload.</dd>
</dl>
</li>
</ul>
<a id="annotations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>annotations</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;annotations()
throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../StreamDelivery.html#annotations()">StreamDelivery</a></code></span></div>
<div class="block">Decodes the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> payload and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> containing a copy
of any associated <a href="../../types/messaging/DeliveryAnnotations.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>DeliveryAnnotations</code></a> that were transmitted with the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a>
payload of this <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a>.
<p>
Calling this message claims the payload of the delivery for the returned <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> and the decoded
<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> that can be accessed via the <a href="../StreamDelivery.html#message()"><code>StreamDelivery.message()</code></a> method and excludes use of the
<a href="../StreamDelivery.html#rawInputStream()"><code>StreamDelivery.rawInputStream()</code></a> method of the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> object. Calling the <a href="../StreamDelivery.html#rawInputStream()"><code>StreamDelivery.rawInputStream()</code></a>
method after calling this method throws <a href="../exceptions/ClientIllegalStateException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientIllegalStateException</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../StreamDelivery.html#annotations()">annotations</a></code>&nbsp;in interface&nbsp;<code><a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>copy of the delivery annotations that were transmitted with the <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> payload.</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 decoding the payload.</dd>
</dl>
</li>
</ul>
<a id="rawInputStream()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rawInputStream</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;rawInputStream()
throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../StreamDelivery.html#rawInputStream()">StreamDelivery</a></code></span></div>
<div class="block">Create and return an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>InputStream</code></a> that reads the raw payload bytes of the given <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a>.
<p>
Calling this method claims the payload of the delivery for the returned <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>InputStream</code></a> and excludes
use of the <a href="../StreamDelivery.html#message()"><code>StreamDelivery.message()</code></a> and <a href="../StreamDelivery.html#annotations()"><code>StreamDelivery.annotations()</code></a> methods of the <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> object. Closing
the returned input stream discards any unread bytes from the delivery payload. Calling the <a href="../StreamDelivery.html#message()"><code>StreamDelivery.message()</code></a>
or <a href="../StreamDelivery.html#annotations()"><code>StreamDelivery.annotations()</code></a> methods after calling this method throws <a href="../exceptions/ClientIllegalStateException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientIllegalStateException</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../StreamDelivery.html#rawInputStream()">rawInputStream</a></code>&nbsp;in interface&nbsp;<code><a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></code></dd>
<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/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>InputStream</code></a> instance that can be used to read the raw delivery payload.</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 decoding the payload.</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/ClientStreamDelivery.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><a href="#field.summary">Field</a>&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>