blob: b39aef1769ae27044e9bac58b4ef9b999186c4c3 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Qpid::Proton::Disposition::State
&mdash; Qpid Proton Ruby API
</title>
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Qpid::Proton::Disposition::State";
relpath = '../../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Qpid.html" title="Qpid (module)">Qpid</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Disposition.html" title="Qpid::Proton::Disposition (class)">Disposition</a></span></span>
&raquo;
<span class="title">State</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Qpid::Proton::Disposition::State
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd><span class='object_link'><a href="State/ClassMethods.html" title="Qpid::Proton::Disposition::State::ClassMethods (module)">ClassMethods</a></span></dd>
</dl>
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../Disposition.html" title="Qpid::Proton::Disposition (class)">Qpid::Proton::Disposition</a></span>, <span class='object_link'><a href="../Transfer.html" title="Qpid::Proton::Transfer (class)">Transfer</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/core/disposition.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>States of a message transfer</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="State/ClassMethods.html" title="Qpid::Proton::Disposition::State::ClassMethods (module)">ClassMethods</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="ACCEPTED-constant" class="">ACCEPTED =
<div class="docstring">
<div class="discussion">
<p>Message was successfully processed by the receiver</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_ACCEPTED</span></pre></dd>
<dt id="REJECTED-constant" class="">REJECTED =
<div class="docstring">
<div class="discussion">
<p>Message rejected as invalid and unprocessable by the receiver.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_REJECTED</span></pre></dd>
<dt id="RELEASED-constant" class="">RELEASED =
<div class="docstring">
<div class="discussion">
<p>Message was not (and will not be) processed by the receiver, but may be acceptable if re-delivered to another receiver</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_RELEASED</span></pre></dd>
<dt id="MODIFIED-constant" class="">MODIFIED =
<div class="docstring">
<div class="discussion">
<p>Like <span class='object_link'><a href="#RELEASED-constant" title="Qpid::Proton::Disposition::State::RELEASED (constant)">RELEASED</a></span>, but there are modifications (see <span class='object_link'><a href="../Tracker.html#modifications-instance_method" title="Qpid::Proton::Tracker#modifications (method)">Tracker#modifications</a></span>) that must be applied to the message by the <span class='object_link'><a href="../Sender.html" title="Qpid::Proton::Sender (class)">Sender</a></span> before re-delivering it.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_MODIFIED</span></pre></dd>
<dt id="RECEIVED-constant" class="">RECEIVED =
<div class="docstring">
<div class="discussion">
<p>Partial message data received. Only used during link recovery.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Cproton</span><span class='op'>::</span><span class='const'>PN_RECEIVED</span></pre></dd>
</dl>
<h2>Method Summary</h2>
<h3 class="inherited">Methods included from <span class='object_link'><a href="State/ClassMethods.html" title="Qpid::Proton::Disposition::State::ClassMethods (module)">ClassMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="State/ClassMethods.html#name_of-instance_method" title="Qpid::Proton::Disposition::State::ClassMethods#name_of (method)">name_of</a></span></p>
</div>
<div id="footer">
Generated on Wed Nov 11 12:57:52 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.24 (ruby-2.7.2).
</div>
</div>
</body>
</html>