blob: 848496e1c6ebdef507ed2a83ebc4084423ab4af8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Interface org.apache.qpid.protonj2.engine.Connection (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="use: package: org.apache.qpid.protonj2.engine, interface: Connection">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript"></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><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Class</a></li>
<li class="nav-bar-cell1-rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../help-doc.html#use">Help</a></li>
</ul>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Interface org.apache.qpid.protonj2.engine.Connection" class="title">Uses of Interface<br>org.apache.qpid.protonj2.engine.Connection</h1>
</div>
<div class="caption"><span>Packages that use <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.engine">org.apache.qpid.protonj2.engine</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.qpid.protonj2.engine.impl">org.apache.qpid.protonj2.engine.impl</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.qpid.protonj2.engine">
<h2>Uses of <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.engine</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.engine</a> that return <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></span></div>
<div class="summary-table three-column-summary">
<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"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Engine.</span><code><a href="../Engine.html#connection()" class="member-name-link">connection</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Gets the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> instance that is associated with this <a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine"><code>Engine</code></a> instance.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Link.</span><code><a href="../Link.html#getConnection()" class="member-name-link">getConnection</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Session.</span><code><a href="../Session.html#getConnection()" class="member-name-link">getConnection</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#getParent()" class="member-name-link">getParent</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Session.</span><code><a href="../Session.html#getParent()" class="member-name-link">getParent</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#negotiate()" class="member-name-link">negotiate</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">If not already negotiated this method initiates the AMQP protocol negotiation phase of
the connection process sending the <a href="../../types/transport/AMQPHeader.html" title="class in org.apache.qpid.protonj2.types.transport"><code>AMQPHeader</code></a> to the remote peer.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#negotiate(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">negotiate</a><wbr>(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a>&lt;<a href="../../types/transport/AMQPHeader.html" title="class in org.apache.qpid.protonj2.types.transport">AMQPHeader</a>&gt;&nbsp;remoteAMQPHeaderHandler)</code></div>
<div class="col-last even-row-color">
<div class="block">If not already negotiated this method initiates the AMQP protocol negotiation phase of
the connection process sending the <a href="../../types/transport/AMQPHeader.html" title="class in org.apache.qpid.protonj2.types.transport"><code>AMQPHeader</code></a> to the remote peer.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#receiverOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">receiverOpenHandler</a><wbr>(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a>&lt;<a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine">Receiver</a>&gt;&nbsp;remoteReceiverOpenEventHandler)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets a <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an AMQP Attach frame is received from the remote peer for a receiving link.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#senderOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">senderOpenHandler</a><wbr>(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a>&lt;<a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a>&gt;&nbsp;remoteSenderOpenEventHandler)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets a <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an AMQP Attach frame is received from the remote peer for a sending link.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#sessionOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">sessionOpenHandler</a><wbr>(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a>&lt;<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>&gt;&nbsp;remoteSessionOpenEventHandler)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets a <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an AMQP Begin frame is received from the remote peer.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#setChannelMax(int)" class="member-name-link">setChannelMax</a><wbr>(int&nbsp;channelMax)</code></div>
<div class="col-last even-row-color">
<div class="block">Set the channel max value for this Connection.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#setContainerId(java.lang.String)" class="member-name-link">setContainerId</a><wbr>(<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>&nbsp;containerId)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sets the Container Id to be used when opening this Connection.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#setHostname(java.lang.String)" class="member-name-link">setHostname</a><wbr>(<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>&nbsp;hostname)</code></div>
<div class="col-last even-row-color">
<div class="block">Set the name of the host (either fully qualified or relative) to which this
connection is connecting to.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#setIdleTimeout(long)" class="member-name-link">setIdleTimeout</a><wbr>(long&nbsp;idleTimeout)</code></div>
<div class="col-last odd-row-color">
<div class="block">Set the idle timeout value for this Connection.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#setMaxFrameSize(long)" class="member-name-link">setMaxFrameSize</a><wbr>(long&nbsp;maxFrameSize)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets the maximum frame size allowed for this connection, which is the largest single frame
that the remote can send to this <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> before it will close the connection with
an error condition indicating the violation.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Engine.</span><code><a href="../Engine.html#start()" class="member-name-link">start</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Starts the engine and returns the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> instance that is bound to this Engine.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#tickAuto(java.util.concurrent.ScheduledExecutorService)" class="member-name-link">tickAuto</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ScheduledExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ScheduledExecutorService</a>&nbsp;executor)</code></div>
<div class="col-last even-row-color">
<div class="block">Convenience method which is the same as calling <a href="../Engine.html#tickAuto(java.util.concurrent.ScheduledExecutorService)"><code>Engine.tickAuto(ScheduledExecutorService)</code></a>.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#tickAuto(org.apache.qpid.protonj2.engine.Scheduler)" class="member-name-link">tickAuto</a><wbr>(<a href="../Scheduler.html" title="interface in org.apache.qpid.protonj2.engine">Scheduler</a>&nbsp;scheduler)</code></div>
<div class="col-last odd-row-color">
<div class="block">Convenience method which is the same as calling <a href="../Engine.html#tickAuto(org.apache.qpid.protonj2.engine.Scheduler)"><code>Engine.tickAuto(Scheduler)</code></a>.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#transactionManagerOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">transactionManagerOpenHandler</a><wbr>(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a>&lt;<a href="../TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine">TransactionManager</a>&gt;&nbsp;remoteTxnManagerOpenEventHandler)</code></div>
<div class="col-last even-row-color">
<div class="block">Sets a <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an AMQP Attach frame is received from the remote peer for a transaction
coordination link.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.qpid.protonj2.engine.impl">
<h2>Uses of <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a> in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a></h2>
<div class="caption"><span>Classes in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a> that implement <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../impl/ProtonConnection.html" class="type-name-link" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a></code></div>
<div class="col-last even-row-color">
<div class="block">Implements the proton Connection API</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a> that return <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></span></div>
<div class="summary-table three-column-summary">
<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"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonConnection.</span><code><a href="../impl/ProtonConnection.html#getParent()" class="member-name-link">getParent</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonConnection.</span><code><a href="../impl/ProtonConnection.html#negotiate()" class="member-name-link">negotiate</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonConnection.</span><code><a href="../impl/ProtonConnection.html#negotiate(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">negotiate</a><wbr>(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a>&lt;<a href="../../types/transport/AMQPHeader.html" title="class in org.apache.qpid.protonj2.types.transport">AMQPHeader</a>&gt;&nbsp;remoteAMQPHeaderHandler)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonConnection.</span><code><a href="../impl/ProtonConnection.html#setMaxFrameSize(long)" class="member-name-link">setMaxFrameSize</a><wbr>(long&nbsp;maxFrameSize)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ProtonConnection.</span><code><a href="../impl/ProtonConnection.html#tickAuto(java.util.concurrent.ScheduledExecutorService)" class="member-name-link">tickAuto</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ScheduledExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ScheduledExecutorService</a>&nbsp;executor)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ProtonConnection.</span><code><a href="../impl/ProtonConnection.html#tickAuto(org.apache.qpid.protonj2.engine.Scheduler)" class="member-name-link">tickAuto</a><wbr>(<a href="../Scheduler.html" title="interface in org.apache.qpid.protonj2.engine">Scheduler</a>&nbsp;scheduler)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>