| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>IOContext (Qpid ProtonJ2 Parent 1.0.0-M18 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.client.transport, interface: IOContext"> |
| <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/IOContext.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.client.transport</a></div> |
| <h1 title="Interface IOContext" class="title">Interface IOContext</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="netty4/Netty4IOContext.html" title="class in org.apache.qpid.protonj2.client.transport.netty4">Netty4IOContext</a></code>, <code><a href="netty5/Netty5IOContext.html" title="class in org.apache.qpid.protonj2.client.transport.netty5">Netty5IOContext</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IOContext</span></div> |
| <div class="block">An I/O context used to abstract the implementation of the IO layer in use.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab1"><code>static <a href="IOContext.html" title="interface in org.apache.qpid.protonj2.client.transport">IOContext</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#create(org.apache.qpid.protonj2.client.TransportOptions,org.apache.qpid.protonj2.client.SslOptions,java.lang.String)" class="member-name-link">create</a><wbr>(<a href="../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a> options, |
| <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> sslOptions, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ioThreadName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Create an IOContext from the available options.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../engine/Scheduler.html" title="interface in org.apache.qpid.protonj2.engine">Scheduler</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#ioScheduler()" class="member-name-link">ioScheduler</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newTransport()" class="member-name-link">newTransport</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#shutdown()" class="member-name-link">shutdown</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Shutdown the event loop synchronously with a grace period for work that might be in-bound |
| at the time of termination.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#shutdownAsync()" class="member-name-link">shutdownAsync</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Shutdown the event loop asynchronously with a grace period for work that might be in-bound |
| at the time of termination.</div> |
| </div> |
| </div> |
| </div> |
| </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="shutdown()"> |
| <h3>shutdown</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">shutdown</span>()</div> |
| <div class="block">Shutdown the event loop synchronously with a grace period for work that might be in-bound |
| at the time of termination. This is not safe to call from inside the event loop as it blocks |
| until the shutdown has completed.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdownAsync()"> |
| <h3>shutdownAsync</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">shutdownAsync</span>()</div> |
| <div class="block">Shutdown the event loop asynchronously with a grace period for work that might be in-bound |
| at the time of termination. This is safe to call from inside the event loop where the |
| standard blocking shutdown API is not.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ioScheduler()"> |
| <h3>ioScheduler</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../engine/Scheduler.html" title="interface in org.apache.qpid.protonj2.engine">Scheduler</a></span> <span class="element-name">ioScheduler</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the single threaded IO work scheduler for this <a href="IOContext.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>IOContext</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newTransport()"> |
| <h3>newTransport</h3> |
| <div class="member-signature"><span class="return-type"><a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport">Transport</a></span> <span class="element-name">newTransport</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a new <a href="Transport.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>Transport</code></a> instance that is tied to this <a href="IOContext.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>IOContext</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(org.apache.qpid.protonj2.client.TransportOptions,org.apache.qpid.protonj2.client.SslOptions,java.lang.String)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="IOContext.html" title="interface in org.apache.qpid.protonj2.client.transport">IOContext</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="../TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a> options, |
| <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a> sslOptions, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> ioThreadName)</span></div> |
| <div class="block">Create an IOContext from the available options.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>options</code> - The <a href="../TransportOptions.html" title="class in org.apache.qpid.protonj2.client"><code>TransportOptions</code></a> that configure the IO Transport the context creates.</dd> |
| <dd><code>sslOptions</code> - The <a href="../SslOptions.html" title="class in org.apache.qpid.protonj2.client"><code>SslOptions</code></a> that configure the SSL layer of the IO Transport the context creates.</dd> |
| <dd><code>ioThreadName</code> - The name to given the single IO Thread the context must provide.</dd> |
| <dt>Returns:</dt> |
| <dd>a new <a href="IOContext.html" title="interface in org.apache.qpid.protonj2.client.transport"><code>IOContext</code></a> from available options.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |