| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ProtonEngineConfiguration (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.qpid.protonj2.engine.impl, class: ProtonEngineConfiguration"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ProtonEngineConfiguration.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.engine.impl</a></div> |
| <h1 title="Class ProtonEngineConfiguration" class="title">Class ProtonEngineConfiguration</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.qpid.protonj2.engine.impl.ProtonEngineConfiguration</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine">EngineConfiguration</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ProtonEngineConfiguration</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine">EngineConfiguration</a></span></div> |
| <div class="block">Proton engine configuration API</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBufferAllocator()" class="member-name-link">getBufferAllocator</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isTraceFrames()" class="member-name-link">isTraceFrames</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonEngineConfiguration.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngineConfiguration</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBufferAllocator(org.apache.qpid.protonj2.buffer.ProtonBufferAllocator)" class="member-name-link">setBufferAllocator</a><wbr>(<a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a> allocator)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the ProtonBufferAllocator used by this Engine.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine">EngineConfiguration</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTraceFrames(boolean)" class="member-name-link">setTraceFrames</a><wbr>(boolean traceFrames)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Enables AMQP frame tracing from engine to the system output.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getBufferAllocator()"> |
| <h3>getBufferAllocator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></span> <span class="element-name">getBufferAllocator</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EngineConfiguration.html#getBufferAllocator()">getBufferAllocator</a></code> in interface <code><a href="../EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine">EngineConfiguration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the currently assigned <a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBufferAllocator</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBufferAllocator(org.apache.qpid.protonj2.buffer.ProtonBufferAllocator)"> |
| <h3>setBufferAllocator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEngineConfiguration.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngineConfiguration</a></span> <span class="element-name">setBufferAllocator</span><wbr><span class="parameters">(<a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a> allocator)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../EngineConfiguration.html#setBufferAllocator(org.apache.qpid.protonj2.buffer.ProtonBufferAllocator)">EngineConfiguration</a></code></span></div> |
| <div class="block">Sets the ProtonBufferAllocator used by this Engine. |
| <p> |
| When copying data, encoding types or otherwise needing to allocate memory |
| storage the Engine will use the assigned <a href="../../buffer/ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBufferAllocator</code></a>. |
| If no allocator is assigned the Engine will use the default allocator.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EngineConfiguration.html#setBufferAllocator(org.apache.qpid.protonj2.buffer.ProtonBufferAllocator)">setBufferAllocator</a></code> in interface <code><a href="../EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine">EngineConfiguration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>allocator</code> - The Allocator instance to use from this <a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine"><code>Engine</code></a>.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="../EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineConfiguration</code></a> for chaining.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTraceFrames(boolean)"> |
| <h3>setTraceFrames</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine">EngineConfiguration</a></span> <span class="element-name">setTraceFrames</span><wbr><span class="parameters">(boolean traceFrames)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../EngineConfiguration.html#setTraceFrames(boolean)">EngineConfiguration</a></code></span></div> |
| <div class="block">Enables AMQP frame tracing from engine to the system output. Depending |
| on the underlying engine composition frame tracing may not be possible |
| in which case this method will have no effect and the access method |
| <a href="../EngineConfiguration.html#isTraceFrames()"><code>EngineConfiguration.isTraceFrames()</code></a> will return false.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EngineConfiguration.html#setTraceFrames(boolean)">setTraceFrames</a></code> in interface <code><a href="../EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine">EngineConfiguration</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>traceFrames</code> - true to enable engine frame tracing, false to disable it.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="../EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine"><code>EngineConfiguration</code></a> for chaining.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isTraceFrames()"> |
| <h3>isTraceFrames</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isTraceFrames</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EngineConfiguration.html#isTraceFrames()">isTraceFrames</a></code> in interface <code><a href="../EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine">EngineConfiguration</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the engine will emit frames to system output.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
