| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>PagedMessage (ActiveMQ Artemis Website 2.29.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="PagedMessage (ActiveMQ Artemis Website 2.29.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PagedMessage.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.activemq.artemis.core.paging</a></div> |
| <h2 title="Interface PagedMessage" class="title">Interface PagedMessage</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../journal/EncodingSupport.html" title="interface in org.apache.activemq.artemis.core.journal">EncodingSupport</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/PagedMessageImpl.html" title="class in org.apache.activemq.artemis.core.paging.impl">PagedMessageImpl</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">PagedMessage</span> |
| extends <a href="../journal/EncodingSupport.html" title="interface in org.apache.activemq.artemis.core.journal">EncodingSupport</a></pre> |
| <div class="block">A Paged message. |
| <p> |
| We can't just record the ServerMessage as we need other information (such as the TransactionID |
| used during paging)</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessage()">getMessage</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageNumber()">getMessageNumber</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPageNumber()">getPageNumber</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistentSize()">getPersistentSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This is the size of the message when persisted on disk and is used for metrics tracking |
| If a normal message it will be the encoded message size |
| If a large message it will be encoded message size + large message body size</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueueIDs()">getQueueIDs</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The queues that were routed during paging</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStoredSize()">getStoredSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This returns how much the PagedMessage used, or it's going to use |
| from storage.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransactionID()">getTransactionID</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initMessage(org.apache.activemq.artemis.core.persistence.StorageManager)">initMessage</a></span>​(<a href="../persistence/StorageManager.html" title="interface in org.apache.activemq.artemis.core.persistence">StorageManager</a> storageManager)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="cursor/PagePosition.html" title="interface in org.apache.activemq.artemis.core.paging.cursor">PagePosition</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newPositionObject()">newPositionObject</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="PagedMessage.html" title="interface in org.apache.activemq.artemis.core.paging">PagedMessage</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageNumber(int)">setMessageNumber</a></span>​(int messageNr)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="PagedMessage.html" title="interface in org.apache.activemq.artemis.core.paging">PagedMessage</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPageNumber(long)">setPageNumber</a></span>​(long pageNr)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.activemq.artemis.core.journal.EncodingSupport"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.activemq.artemis.core.journal.<a href="../journal/EncodingSupport.html" title="interface in org.apache.activemq.artemis.core.journal">EncodingSupport</a></h3> |
| <code><a href="../journal/EncodingSupport.html#decode(org.apache.activemq.artemis.api.core.ActiveMQBuffer)">decode</a>, <a href="../journal/EncodingSupport.html#encode(org.apache.activemq.artemis.api.core.ActiveMQBuffer)">encode</a>, <a href="../journal/EncodingSupport.html#getEncodeSize()">getEncodeSize</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getMessage()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessage</h4> |
| <pre class="methodSignature"><a href="../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a> getMessage()</pre> |
| </li> |
| </ul> |
| <a id="newPositionObject()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newPositionObject</h4> |
| <pre class="methodSignature"><a href="cursor/PagePosition.html" title="interface in org.apache.activemq.artemis.core.paging.cursor">PagePosition</a> newPositionObject()</pre> |
| </li> |
| </ul> |
| <a id="getQueueIDs()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueueIDs</h4> |
| <pre class="methodSignature">long[] getQueueIDs()</pre> |
| <div class="block">The queues that were routed during paging</div> |
| </li> |
| </ul> |
| <a id="initMessage(org.apache.activemq.artemis.core.persistence.StorageManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initMessage</h4> |
| <pre class="methodSignature">void initMessage​(<a href="../persistence/StorageManager.html" title="interface in org.apache.activemq.artemis.core.persistence">StorageManager</a> storageManager)</pre> |
| </li> |
| </ul> |
| <a id="getTransactionID()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTransactionID</h4> |
| <pre class="methodSignature">long getTransactionID()</pre> |
| </li> |
| </ul> |
| <a id="getPersistentSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistentSize</h4> |
| <pre class="methodSignature">long getPersistentSize() |
| throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre> |
| <div class="block">This is the size of the message when persisted on disk and is used for metrics tracking |
| If a normal message it will be the encoded message size |
| If a large message it will be encoded message size + large message body size</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStoredSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStoredSize</h4> |
| <pre class="methodSignature">int getStoredSize()</pre> |
| <div class="block">This returns how much the PagedMessage used, or it's going to use |
| from storage. |
| We can't calculate the encodeSize as some persisters don't guarantee to re-store the data |
| at the same amount of bytes it used. In some cases it may need to add headers in AMQP |
| or extra data that may affect the outcome of getEncodeSize()</div> |
| </li> |
| </ul> |
| <a id="getPageNumber()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageNumber</h4> |
| <pre class="methodSignature">long getPageNumber()</pre> |
| </li> |
| </ul> |
| <a id="setPageNumber(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPageNumber</h4> |
| <pre class="methodSignature"><a href="PagedMessage.html" title="interface in org.apache.activemq.artemis.core.paging">PagedMessage</a> setPageNumber​(long pageNr)</pre> |
| </li> |
| </ul> |
| <a id="getMessageNumber()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageNumber</h4> |
| <pre class="methodSignature">int getMessageNumber()</pre> |
| </li> |
| </ul> |
| <a id="setMessageNumber(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setMessageNumber</h4> |
| <pre class="methodSignature"><a href="PagedMessage.html" title="interface in org.apache.activemq.artemis.core.paging">PagedMessage</a> setMessageNumber​(int messageNr)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/PagedMessage.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
