blob: eea324d7ff7a1e64f1412025b77d84544c654c28 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Qpid::Proton::Message
&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::Message";
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 (M)</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">Message</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>Class: Qpid::Proton::Message
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Qpid::Proton::Message</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/core/message.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Messsage data and headers that can sent or received on a <span class='object_link'><a href="Link.html" title="Qpid::Proton::Link (class)">Link</a></span></p>
<p><span class='object_link'><a href="#body-instance_method" title="Qpid::Proton::Message#body (method)">#body</a></span> is the main message content. <span class='object_link'><a href="#properties-instance_method" title="Qpid::Proton::Message#properties (method)">#properties</a></span> is a <span class='object_link'>Hash</span> of extra properties that can be attached to the message.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Create a message containing a Unicode string</p>
</div></p>
<pre class="example code"><code><span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span><span class='op'>::</span><span class='const'>Message</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Qpid::Proton::Message#initialize (method)">new</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>this is a string</span><span class='tstring_end'>&quot;</span></span></code></pre>
<p class="example_title"><div class='inline'>
<p>Create a message containing binary data</p>
</div></p>
<pre class="example code"><code><span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span><span class='op'>::</span><span class='const'>Message</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Qpid::Proton::Message#initialize (method)">new</a></span></span>
<span class='id identifier rubyid_msg'>msg</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span><span class='op'>::</span><span class='const'>BinaryString</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_binread'>binread</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/home/qpid/binfile.tar.gz</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span></code></pre>
</div>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#annotations-instance_method" title="#annotations (instance method)">#<strong>annotations</strong> &#x21d2; Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Delivery annotations for this message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#body-instance_method" title="#body (instance method)">#<strong>body</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Body of the message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#instructions-instance_method" title="#instructions (instance method)">#<strong>instructions</strong> &#x21d2; Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Delivery instructions for this message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#properties-instance_method" title="#properties (instance method)">#<strong>properties</strong> &#x21d2; Hash </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Application properties for the message.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#finalize!-class_method" title="finalize! (class method)">.<strong>finalize!</strong>(impl) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Invoked by garbage collection to clean up resources used by the underlying message implementation.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(name) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Equivalent to <tt><a href="name">#properties</a></tt>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#[]=-instance_method" title="#[]= (instance method)">#<strong>[]=</strong>(name, value) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Equivalent to <tt><a href="name">#properties</a> = value</tt>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#clear-instance_method" title="#clear (instance method)">#<strong>clear</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Clears the state of the <code>Message</code>.</p>
</div></span>
</li>
<li class="public deprecated">
<span class="summary_signature">
<a href="#content-instance_method" title="#content (instance method)">#<strong>content</strong> </a>
</span>
<span class="deprecated note title">deprecated</span>
<span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'>
<p>use <span class='object_link'><a href="#body-instance_method" title="Qpid::Proton::Message#body (method)">#body</a></span></p>
</div></span>
</li>
<li class="public deprecated">
<span class="summary_signature">
<a href="#content=-instance_method" title="#content= (instance method)">#<strong>content=</strong>(content) </a>
</span>
<span class="deprecated note title">deprecated</span>
<span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'>
<p>use <span class='object_link'><a href="#body=-instance_method" title="Qpid::Proton::Message#body= (method)">#body=</a></span></p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#content_encoding-instance_method" title="#content_encoding (instance method)">#<strong>content_encoding</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the content encoding type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#content_encoding=-instance_method" title="#content_encoding= (instance method)">#<strong>content_encoding=</strong>(encoding) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the content encoding type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#content_type-instance_method" title="#content_type (instance method)">#<strong>content_type</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the content type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#content_type=-instance_method" title="#content_type= (instance method)">#<strong>content_type=</strong>(content_type) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the content type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#correlation_id-instance_method" title="#correlation_id (instance method)">#<strong>correlation_id</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the correlation id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#correlation_id=-instance_method" title="#correlation_id= (instance method)">#<strong>correlation_id=</strong>(id) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the correlation id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#creation_time-instance_method" title="#creation_time (instance method)">#<strong>creation_time</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the creation time.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#creation_time=-instance_method" title="#creation_time= (instance method)">#<strong>creation_time=</strong>(time) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the creation time.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#decode-instance_method" title="#decode (instance method)">#<strong>decode</strong>(encoded) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Decodes a message from AMQP binary data.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_property-instance_method" title="#delete_property (instance method)">#<strong>delete_property</strong>(name) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Equivalent to <tt>{#properties}.delete(name)</tt>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delivery_count-instance_method" title="#delivery_count (instance method)">#<strong>delivery_count</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the delivery count for the message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delivery_count=-instance_method" title="#delivery_count= (instance method)">#<strong>delivery_count=</strong>(count) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the delivery count for the message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#durable-instance_method" title="#durable (instance method)">#<strong>durable</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the durable property.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#durable=-instance_method" title="#durable= (instance method)">#<strong>durable=</strong>(state) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the durable flag.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#encode-instance_method" title="#encode (instance method)">#<strong>encode</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Encodes the message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#errno-instance_method" title="#errno (instance method)">#<strong>errno</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the most recent error number.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#error-instance_method" title="#error (instance method)">#<strong>error</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the most recent error message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#error%3F-instance_method" title="#error? (instance method)">#<strong>error?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns whether there is currently an error reported.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#expires-instance_method" title="#expires (instance method)">#<strong>expires</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the expiration time.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#expires=-instance_method" title="#expires= (instance method)">#<strong>expires=</strong>(time) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the expiration time.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#first_acquirer=-instance_method" title="#first_acquirer= (instance method)">#<strong>first_acquirer=</strong>(state) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets whether this is the first time the message was acquired.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#first_acquirer%3F-instance_method" title="#first_acquirer? (instance method)">#<strong>first_acquirer?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns whether this is the first acquirer.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#group_id-instance_method" title="#group_id (instance method)">#<strong>group_id</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the group id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#group_id=-instance_method" title="#group_id= (instance method)">#<strong>group_id=</strong>(id) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the group id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#group_sequence-instance_method" title="#group_sequence (instance method)">#<strong>group_sequence</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the group sequence number.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#group_sequence=-instance_method" title="#group_sequence= (instance method)">#<strong>group_sequence=</strong>(seq) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the group sequence number.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the message id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#id=-instance_method" title="#id= (instance method)">#<strong>id=</strong>(id) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the message id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#impl-instance_method" title="#impl (instance method)">#<strong>impl</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the underlying message implementation.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(body = nil, opts = {}) &#x21d2; Message </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Creates a new <code>Message</code> instance.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#priority-instance_method" title="#priority (instance method)">#<strong>priority</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the priority.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#priority=-instance_method" title="#priority= (instance method)">#<strong>priority=</strong>(priority) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the priority.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reply_to-instance_method" title="#reply_to (instance method)">#<strong>reply_to</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the reply-to address.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reply_to=-instance_method" title="#reply_to= (instance method)">#<strong>reply_to=</strong>(address) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the reply-to address.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reply_to_group_id-instance_method" title="#reply_to_group_id (instance method)">#<strong>reply_to_group_id</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the reply-to group id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reply_to_group_id=-instance_method" title="#reply_to_group_id= (instance method)">#<strong>reply_to_group_id=</strong>(id) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the reply-to group id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#subject-instance_method" title="#subject (instance method)">#<strong>subject</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the subject.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#subject=-instance_method" title="#subject= (instance method)">#<strong>subject=</strong>(subject) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the subject.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to-instance_method" title="#to (instance method)">#<strong>to</strong> &#x21d2; String </a>
(also: #address)
</span>
<span class="summary_desc"><div class='inline'>
<p>Get the destination address.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to=-instance_method" title="#to= (instance method)">#<strong>to=</strong>(address) </a>
(also: #address=)
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ttl-instance_method" title="#ttl (instance method)">#<strong>ttl</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the time-to-live, in milliseconds.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ttl=-instance_method" title="#ttl= (instance method)">#<strong>ttl=</strong>(time) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the time-to-live for the message.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user_id-instance_method" title="#user_id (instance method)">#<strong>user_id</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the user id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user_id=-instance_method" title="#user_id= (instance method)">#<strong>user_id=</strong>(id) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets the user id.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(body = nil, opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Qpid::Proton::Message (class)">Message</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates a new <code>Message</code> instance.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>body</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>the body of the message, equivalent to calling m.body=(body)</p>
</div>
</li>
<li>
<span class='name'>opts</span>
<span class='type'>(<tt><span class='object_link'>Hash</span></tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
&mdash;
<div class='inline'>
<p>additional options, equivalent to <tt>Message#key=value</tt> for each <tt>key=&gt;value</tt></p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 85</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='ivar'>@impl</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message'>pn_message</span>
<span class='const'>ObjectSpace</span><span class='period'>.</span><span class='id identifier rubyid_define_finalizer'>define_finalizer</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_finalize!'>finalize!</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='ivar'>@properties</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='ivar'>@instructions</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='ivar'>@annotations</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='ivar'>@body</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_body'>body</span> <span class='kw'>unless</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>then</span>
<span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span>
<span class='id identifier rubyid_setter'>setter</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='op'>+</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span> <span class='id identifier rubyid_setter'>setter</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="annotations=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="annotations-instance_method">
#<strong>annotations</strong> &#x21d2; <tt><span class='object_link'>Hash</span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Delivery annotations for this message.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'>Hash</span></tt>)</span>
&mdash;
<div class='inline'>
<p>Delivery annotations for this message.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
499
500
501</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 499</span>
<span class='kw'>def</span> <span class='id identifier rubyid_annotations'>annotations</span>
<span class='ivar'>@annotations</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="body=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="body-instance_method">
#<strong>body</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns body of the message.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>body of the message.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
502
503
504</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 502</span>
<span class='kw'>def</span> <span class='id identifier rubyid_body'>body</span>
<span class='ivar'>@body</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="instructions=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="instructions-instance_method">
#<strong>instructions</strong> &#x21d2; <tt><span class='object_link'>Hash</span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Delivery instructions for this message.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'>Hash</span></tt>)</span>
&mdash;
<div class='inline'>
<p>Delivery instructions for this message.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
496
497
498</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 496</span>
<span class='kw'>def</span> <span class='id identifier rubyid_instructions'>instructions</span>
<span class='ivar'>@instructions</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="properties=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="properties-instance_method">
#<strong>properties</strong> &#x21d2; <tt><span class='object_link'>Hash</span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Application properties for the message.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'>Hash</span></tt>)</span>
&mdash;
<div class='inline'>
<p>Application properties for the message</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
484
485
486</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 484</span>
<span class='kw'>def</span> <span class='id identifier rubyid_properties'>properties</span>
<span class='ivar'>@properties</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="finalize!-class_method">
.<strong>finalize!</strong>(impl)
</h3><div class="docstring">
<div class="discussion">
<p>Invoked by garbage collection to clean up resources used by the underlying message implementation.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
103
104
105
106
107</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 103</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_finalize!'>finalize!</span><span class='lparen'>(</span><span class='id identifier rubyid_impl'>impl</span><span class='rparen'>)</span> <span class='comment'># :nodoc:
</span> <span class='id identifier rubyid_proc'>proc</span> <span class='lbrace'>{</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_free'>pn_message_free</span><span class='lparen'>(</span><span class='id identifier rubyid_impl'>impl</span><span class='rparen'>)</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="[]-instance_method">
#<strong>[]</strong>(name)
</h3><div class="docstring">
<div class="discussion">
<p>Equivalent to <tt><a href="name">#properties</a></tt></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
490</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 490</span>
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='ivar'>@properties</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="[]=-instance_method">
#<strong>[]=</strong>(name, value)
</h3><div class="docstring">
<div class="discussion">
<p>Equivalent to <tt><a href="name">#properties</a> = value</tt></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
487</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 487</span>
<span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='ivar'>@properties</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="clear-instance_method">
#<strong>clear</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Clears the state of the <code>Message</code>. This allows a single instance of <code>Message</code> to be reused.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
117
118
119
120
121
122
123</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 117</span>
<span class='kw'>def</span> <span class='id identifier rubyid_clear'>clear</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_clear'>pn_message_clear</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='ivar'>@properties</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span> <span class='kw'>unless</span> <span class='ivar'>@properties</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='ivar'>@instructions</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span> <span class='kw'>unless</span> <span class='ivar'>@instructions</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='ivar'>@annotations</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span> <span class='kw'>unless</span> <span class='ivar'>@annotations</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='ivar'>@body</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="content-instance_method">
#<strong>content</strong>
</h3><div class="docstring">
<div class="discussion">
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>
<p>use <span class='object_link'><a href="#body-instance_method" title="Qpid::Proton::Message#body (method)">#body</a></span></p>
</div></div>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 366</span>
<span class='kw'>def</span> <span class='id identifier rubyid_content'>content</span>
<span class='id identifier rubyid_deprecated'>deprecated</span> <span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>body</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_size'>size</span> <span class='op'>=</span> <span class='int'>16</span>
<span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_save'>pn_message_save</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_size'>size</span><span class='rparen'>)</span>
<span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
<span class='kw'>if</span> <span class='id identifier rubyid_error'>error</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span><span class='op'>::</span><span class='const'>Error</span><span class='op'>::</span><span class='const'>OVERFLOW</span>
<span class='id identifier rubyid_size'>size</span> <span class='op'>=</span> <span class='id identifier rubyid_size'>size</span> <span class='op'>*</span> <span class='int'>2</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="content=-instance_method">
#<strong>content=</strong>(content)
</h3><div class="docstring">
<div class="discussion">
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>
<p>use <span class='object_link'><a href="#body=-instance_method" title="Qpid::Proton::Message#body= (method)">#body=</a></span></p>
</div></div>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
360
361
362
363</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 360</span>
<span class='kw'>def</span> <span class='id identifier rubyid_content='>content=</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
<span class='id identifier rubyid_deprecated'>deprecated</span> <span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>body=</span><span class='tstring_end'>&quot;</span></span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_load'>pn_message_load</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="content_encoding-instance_method">
#<strong>content_encoding</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the content encoding type.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
394
395
396</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 394</span>
<span class='kw'>def</span> <span class='id identifier rubyid_content_encoding'>content_encoding</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_content_encoding'>pn_message_get_content_encoding</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="content_encoding=-instance_method">
#<strong>content_encoding=</strong>(encoding)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the content encoding type.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>encoding - the content encoding</p>
</li></ul>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
388
389
390</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 388</span>
<span class='kw'>def</span> <span class='id identifier rubyid_content_encoding='>content_encoding=</span><span class='lparen'>(</span><span class='id identifier rubyid_encoding'>encoding</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_content_encoding'>pn_message_set_content_encoding</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_encoding'>encoding</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="content_type-instance_method">
#<strong>content_type</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the content type</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
355
356
357</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 355</span>
<span class='kw'>def</span> <span class='id identifier rubyid_content_type'>content_type</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_content_type'>pn_message_get_content_type</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="content_type=-instance_method">
#<strong>content_type=</strong>(content_type)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the content type.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>content_type - the content type</p>
</li></ul>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
349
350
351</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 349</span>
<span class='kw'>def</span> <span class='id identifier rubyid_content_type='>content_type=</span><span class='lparen'>(</span><span class='id identifier rubyid_content_type'>content_type</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_content_type'>pn_message_set_content_type</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="correlation_id-instance_method">
#<strong>correlation_id</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the correlation id.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
339
340
341</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 339</span>
<span class='kw'>def</span> <span class='id identifier rubyid_correlation_id'>correlation_id</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_correlation_id'>pn_message_get_correlation_id</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="correlation_id=-instance_method">
#<strong>correlation_id=</strong>(id)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the correlation id.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>id - the correlation id</p>
</li></ul>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
333
334
335</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 333</span>
<span class='kw'>def</span> <span class='id identifier rubyid_correlation_id='>correlation_id=</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_correlation_id'>pn_message_set_correlation_id</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="creation_time-instance_method">
#<strong>creation_time</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the creation time.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
430
431
432</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 430</span>
<span class='kw'>def</span> <span class='id identifier rubyid_creation_time'>creation_time</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_creation_time'>pn_message_get_creation_time</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="creation_time=-instance_method">
#<strong>creation_time=</strong>(time)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the creation time.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>time - the creation time</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>TypeError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
422
423
424
425
426</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 422</span>
<span class='kw'>def</span> <span class='id identifier rubyid_creation_time='>creation_time=</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid time: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_time'>time</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_time'>time</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>ArgumentError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>time cannot be negative</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_time'>time</span> <span class='op'>&lt;</span> <span class='int'>0</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_creation_time'>pn_message_set_creation_time</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="decode-instance_method">
#<strong>decode</strong>(encoded)
</h3><div class="docstring">
<div class="discussion">
<p>Decodes a message from AMQP binary data. @<a href="Integer">return</a> the number of bytes consumed</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>encoded</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>the encoded bytes</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 44</span>
<span class='kw'>def</span> <span class='id identifier rubyid_decode'>decode</span><span class='lparen'>(</span><span class='id identifier rubyid_encoded'>encoded</span><span class='rparen'>)</span>
<span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_decode'>pn_message_decode</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_encoded'>encoded</span><span class='comma'>,</span> <span class='id identifier rubyid_encoded'>encoded</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_post_decode'>post_decode</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_property-instance_method">
#<strong>delete_property</strong>(name)
</h3><div class="docstring">
<div class="discussion">
<p>Equivalent to <tt>{#properties}.delete(name)</tt></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
493</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 493</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_property'>delete_property</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span> <span class='ivar'>@properties</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delivery_count-instance_method">
#<strong>delivery_count</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the delivery count for the message.</p>
<p>This is the number of delivery attempts for the given message.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
239
240
241</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 239</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delivery_count'>delivery_count</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_delivery_count'>pn_message_get_delivery_count</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delivery_count=-instance_method">
#<strong>delivery_count=</strong>(count)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the delivery count for the message.</p>
<p>See ::delivery_count for more details.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>count - the delivery count</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>::ArgumentError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
229
230
231
232
233</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 229</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delivery_count='>delivery_count=</span><span class='lparen'>(</span><span class='id identifier rubyid_count'>count</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>ArgumentError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid count: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_count'>count</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='id identifier rubyid_count'>count</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Numeric</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>RangeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>count out of range: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_count'>count</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>&lt;</span> <span class='int'>0</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_delivery_count'>pn_message_set_delivery_count</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_count'>count</span><span class='period'>.</span><span class='id identifier rubyid_floor'>floor</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="durable-instance_method">
#<strong>durable</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the durable property.</p>
<p>The durable property indicates that the emessage should be held durably by any intermediaries taking responsibility for the message.</p>
<h4 id="label-Examples">Examples</h4>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Qpid::Proton::Message (class)">Message</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Qpid::Proton::Message#initialize (method)">new</a></span></span>
<span class='id identifier rubyid_msg'>msg</span><span class='period'>.</span><span class='id identifier rubyid_durable'>durable</span> <span class='op'>=</span> <span class='kw'>true</span>
</code></pre>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
166
167
168</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 166</span>
<span class='kw'>def</span> <span class='id identifier rubyid_durable'>durable</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_is_durable'>pn_message_is_durable</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="durable=-instance_method">
#<strong>durable=</strong>(state)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the durable flag.</p>
<p>See ::durable for more details on message durability.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>state - the durable state</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>TypeError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
151
152
153
154</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 151</span>
<span class='kw'>def</span> <span class='id identifier rubyid_durable='>durable=</span><span class='lparen'>(</span><span class='id identifier rubyid_state'>state</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>state cannot be nil</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_state'>state</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_durable'>pn_message_set_durable</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_state'>state</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="encode-instance_method">
#<strong>encode</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Encodes the message.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
59
60
61
62
63
64
65
66
67
68
69
70
71</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 59</span>
<span class='kw'>def</span> <span class='id identifier rubyid_encode'>encode</span>
<span class='id identifier rubyid_pre_encode'>pre_encode</span>
<span class='id identifier rubyid_size'>size</span> <span class='op'>=</span> <span class='int'>16</span>
<span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
<span class='id identifier rubyid_error'>error</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>Cproton</span><span class='op'>::</span><span class='id identifier rubyid_pn_message_encode'>pn_message_encode</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_size'>size</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_error'>error</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="../../Qpid.html" title="Qpid (module)">Qpid</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span><span class='op'>::</span><span class='const'>Error</span><span class='op'>::</span><span class='const'>OVERFLOW</span>
<span class='id identifier rubyid_size'>size</span> <span class='op'>*=</span> <span class='int'>2</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span><span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="errno-instance_method">
#<strong>errno</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the most recent error number.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
127
128
129</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 127</span>
<span class='kw'>def</span> <span class='id identifier rubyid_errno'>errno</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_errno'>pn_message_errno</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="error-instance_method">
#<strong>error</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the most recent error message.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
133
134
135</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 133</span>
<span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_error_text'>pn_error_text</span><span class='lparen'>(</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_error'>pn_message_error</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="error?-instance_method">
#<strong>error?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns whether there is currently an error reported.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
139
140
141</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 139</span>
<span class='kw'>def</span> <span class='id identifier rubyid_error?'>error?</span>
<span class='op'>!</span><span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_errno'>pn_message_errno</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_zero?'>zero?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="expires-instance_method">
#<strong>expires</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the expiration time.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
412
413
414</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 412</span>
<span class='kw'>def</span> <span class='id identifier rubyid_expires'>expires</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_expiry_time'>pn_message_get_expiry_time</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="expires=-instance_method">
#<strong>expires=</strong>(time)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the expiration time.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>time - the expiry time</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>TypeError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
404
405
406
407
408</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 404</span>
<span class='kw'>def</span> <span class='id identifier rubyid_expires='>expires=</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid expiry time: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_time'>time</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_time'>time</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='op'>::</span><span class='const'>ArgumentError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>expiry time cannot be negative: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_time'>time</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_time'>time</span> <span class='op'>&lt;</span> <span class='int'>0</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_expiry_time'>pn_message_set_expiry_time</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="first_acquirer=-instance_method">
#<strong>first_acquirer=</strong>(state)
</h3><div class="docstring">
<div class="discussion">
<p>Sets whether this is the first time the message was acquired.</p>
<p>See ::first_acquirer? for more details.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>state - true if claiming the message</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>TypeError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
216
217
218
219</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 216</span>
<span class='kw'>def</span> <span class='id identifier rubyid_first_acquirer='>first_acquirer=</span><span class='lparen'>(</span><span class='id identifier rubyid_state'>state</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid state: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_state'>state</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_state'>state</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='op'>!</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='const'>TrueClass</span><span class='comma'>,</span> <span class='const'>FalseClass</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_state'>state</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_first_acquirer'>pn_message_set_first_acquirer</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_state'>state</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="first_acquirer?-instance_method">
#<strong>first_acquirer?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns whether this is the first acquirer.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
246
247
248</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 246</span>
<span class='kw'>def</span> <span class='id identifier rubyid_first_acquirer?'>first_acquirer?</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_is_first_acquirer'>pn_message_is_first_acquirer</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="group_id-instance_method">
#<strong>group_id</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the group id.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
446
447
448</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 446</span>
<span class='kw'>def</span> <span class='id identifier rubyid_group_id'>group_id</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_group_id'>pn_message_get_group_id</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="group_id=-instance_method">
#<strong>group_id=</strong>(id)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the group id.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>id - the group id</p>
</li></ul>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
440
441
442</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 440</span>
<span class='kw'>def</span> <span class='id identifier rubyid_group_id='>group_id=</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_group_id'>pn_message_set_group_id</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="group_sequence-instance_method">
#<strong>group_sequence</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the group sequence number.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
463
464
465</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 463</span>
<span class='kw'>def</span> <span class='id identifier rubyid_group_sequence'>group_sequence</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_group_sequence'>pn_message_get_group_sequence</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="group_sequence=-instance_method">
#<strong>group_sequence=</strong>(seq)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the group sequence number.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>seq - the sequence number</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>TypeError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
456
457
458
459</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 456</span>
<span class='kw'>def</span> <span class='id identifier rubyid_group_sequence='>group_sequence=</span><span class='lparen'>(</span><span class='id identifier rubyid_seq'>seq</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid seq: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_seq'>seq</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_seq'>seq</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_group_sequence'>pn_message_set_group_sequence</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_seq'>seq</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="id-instance_method">
#<strong>id</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the message id.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
262
263
264</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 262</span>
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_id'>pn_message_get_id</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="id=-instance_method">
#<strong>id=</strong>(id)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the message id.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>id = the id</p>
</li></ul>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
256
257
258</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 256</span>
<span class='kw'>def</span> <span class='id identifier rubyid_id='>id=</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_id'>pn_message_set_id</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="impl-instance_method">
#<strong>impl</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the underlying message implementation.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
110
111
112</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 110</span>
<span class='kw'>def</span> <span class='id identifier rubyid_impl'>impl</span> <span class='comment'># :nodoc:
</span> <span class='ivar'>@impl</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="inspect-instance_method">
#<strong>inspect</strong>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
504</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 504</span>
<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='id identifier rubyid_pre_encode'>pre_encode</span><span class='semicolon'>;</span> <span class='kw'>super</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="priority-instance_method">
#<strong>priority</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the priority.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
186
187
188</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 186</span>
<span class='kw'>def</span> <span class='id identifier rubyid_priority'>priority</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_priority'>pn_message_get_priority</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="priority=-instance_method">
#<strong>priority=</strong>(priority)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the priority.</p>
<p><code>NOTE:</code> Priority values are limited to the range [0,255].</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>priority - the priority value</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>TypeError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
178
179
180
181
182</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 178</span>
<span class='kw'>def</span> <span class='id identifier rubyid_priority='>priority=</span><span class='lparen'>(</span><span class='id identifier rubyid_priority'>priority</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid priority: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_priority'>priority</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='id identifier rubyid_priority'>priority</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Numeric</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>RangeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>priority out of range: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_priority'>priority</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='lparen'>(</span><span class='lparen'>(</span><span class='id identifier rubyid_priority'>priority</span> <span class='op'>&gt;</span> <span class='int'>255</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='id identifier rubyid_priority'>priority</span> <span class='op'>&lt;</span> <span class='int'>0</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_priority'>pn_message_set_priority</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_priority'>priority</span><span class='period'>.</span><span class='id identifier rubyid_floor'>floor</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reply_to-instance_method">
#<strong>reply_to</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the reply-to address</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
323
324
325</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 323</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reply_to'>reply_to</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_reply_to'>pn_message_get_reply_to</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reply_to=-instance_method">
#<strong>reply_to=</strong>(address)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the reply-to address.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>address - the reply-to address</p>
</li></ul>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
317
318
319</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 317</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reply_to='>reply_to=</span><span class='lparen'>(</span><span class='id identifier rubyid_address'>address</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_reply_to'>pn_message_set_reply_to</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_address'>address</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reply_to_group_id-instance_method">
#<strong>reply_to_group_id</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the reply-to group id.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
479
480
481</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 479</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reply_to_group_id'>reply_to_group_id</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_reply_to_group_id'>pn_message_get_reply_to_group_id</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reply_to_group_id=-instance_method">
#<strong>reply_to_group_id=</strong>(id)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the reply-to group id.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>id - the id</p>
</li></ul>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
473
474
475</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 473</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reply_to_group_id='>reply_to_group_id=</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_reply_to_group_id'>pn_message_set_reply_to_group_id</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="subject-instance_method">
#<strong>subject</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the subject</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
307
308
309</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 307</span>
<span class='kw'>def</span> <span class='id identifier rubyid_subject'>subject</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_subject'>pn_message_get_subject</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="subject=-instance_method">
#<strong>subject=</strong>(subject)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the subject.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>subject - the subject</p>
</li></ul>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
301
302
303</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 301</span>
<span class='kw'>def</span> <span class='id identifier rubyid_subject='>subject=</span><span class='lparen'>(</span><span class='id identifier rubyid_subject'>subject</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_subject'>pn_message_set_subject</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_subject'>subject</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to-instance_method">
#<strong>to</strong> &#x21d2; <tt>String</tt>
<span class="aliases">Also known as:
<span class="names"><span id='address-instance_method'>address</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns get the destination address.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>get the destination address.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
289
290
291</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 289</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to'>to</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_address'>pn_message_get_address</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to=-instance_method">
#<strong>to=</strong>(address)
<span class="aliases">Also known as:
<span class="names"><span id='address=-instance_method'>address=</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>address</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>set the destination address</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
283
284
285</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 283</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to='>to=</span><span class='lparen'>(</span><span class='id identifier rubyid_address'>address</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_address'>pn_message_set_address</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_address'>address</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="ttl-instance_method">
#<strong>ttl</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the time-to-live, in milliseconds.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
204
205
206</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 204</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ttl'>ttl</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_ttl'>pn_message_get_ttl</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="ttl=-instance_method">
#<strong>ttl=</strong>(time)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the time-to-live for the message.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>time - the time in milliseconds</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>TypeError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
196
197
198
199
200</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 196</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ttl='>ttl=</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid ttl: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_time'>time</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>not</span> <span class='id identifier rubyid_time'>time</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Numeric</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>RangeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ttl out of range: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_time'>time</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='lparen'>(</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>&lt;</span> <span class='int'>0</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_ttl'>pn_message_set_ttl</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_time'>time</span><span class='period'>.</span><span class='id identifier rubyid_floor'>floor</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="user_id-instance_method">
#<strong>user_id</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the user id.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
278
279
280</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 278</span>
<span class='kw'>def</span> <span class='id identifier rubyid_user_id'>user_id</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_get_user_id'>pn_message_get_user_id</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="user_id=-instance_method">
#<strong>user_id=</strong>(id)
</h3><div class="docstring">
<div class="discussion">
<p>Sets the user id.</p>
<h4 id="label-Options">Options</h4>
<ul><li>
<p>id - the user id</p>
</li></ul>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
272
273
274</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/core/message.rb', line 272</span>
<span class='kw'>def</span> <span class='id identifier rubyid_user_id='>user_id=</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='const'>Cproton</span><span class='period'>.</span><span class='id identifier rubyid_pn_message_set_user_id'>pn_message_set_user_id</span><span class='lparen'>(</span><span class='ivar'>@impl</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</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>