You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>Entry point is <ahref="struct.ConnectionPool.html" title="struct iroh_blobs::util::connection_pool::ConnectionPool"><code>ConnectionPool</code></a>. You create a connection pool for a specific
3
3
ALPN and <ahref="struct.Options.html" title="struct iroh_blobs::util::connection_pool::Options"><code>Options</code></a>. Then the pool will manage connections for you.</p>
4
4
<p>Access to connections is via the <ahref="struct.ConnectionPool.html#method.get_or_connect" title="method iroh_blobs::util::connection_pool::ConnectionPool::get_or_connect"><code>ConnectionPool::get_or_connect</code></a> method, which
Copy file name to clipboardExpand all lines: pr/187/docs/iroh_blobs/util/connection_pool/struct.ConnectionRef.html
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,14 @@
6
6
</div></details><detailsclass="toggle method-toggle" open><summary><sectionid="method.open_bi" class="method"><h4class="code-header">pub fn <ahref="#method.open_bi" class="fn">open_bi</a>(&self) -> OpenBi<'_></h4></section></summary><divclass="docblock"><p>Initiates a new outgoing bidirectional stream.</p>
7
7
<p>Streams are cheap and instantaneous to open unless blocked by flow control. As a
8
8
consequence, the peer won’t be notified that a stream has been opened until the
9
-
stream is actually used. Calling <ahref="Connection::open_bi"><code>open_bi</code></a> then waiting on the [<code>RecvStream</code>]
10
-
without writing anything to [<code>SendStream</code>] will never succeed.</p>
9
+
stream is actually used. Calling <ahref="Connection::open_bi"><code>open_bi</code></a> then waiting on the <ahref="quinn::RecvStream"><code>RecvStream</code></a>
10
+
without writing anything to <ahref="quinn::SendStream"><code>SendStream</code></a> will never succeed.</p>
11
11
</div></details><detailsclass="toggle method-toggle" open><summary><sectionid="method.accept_uni" class="method"><h4class="code-header">pub fn <ahref="#method.accept_uni" class="fn">accept_uni</a>(&self) -> AcceptUni<'_></h4></section></summary><divclass="docblock"><p>Accepts the next incoming uni-directional stream.</p>
12
12
</div></details><detailsclass="toggle method-toggle" open><summary><sectionid="method.accept_bi" class="method"><h4class="code-header">pub fn <ahref="#method.accept_bi" class="fn">accept_bi</a>(&self) -> AcceptBi<'_></h4></section></summary><divclass="docblock"><p>Accept the next incoming bidirectional stream.</p>
13
-
<p><strong>Important Note</strong>: The peer that calls <ahref="Connection::open_bi"><code>open_bi</code></a> must write to its [<code>SendStream</code>]
13
+
<p><strong>Important Note</strong>: The peer that calls <ahref="Connection::open_bi"><code>open_bi</code></a> must write to its <ahref="quinn::SendStream"><code>SendStream</code></a>
14
14
before the peer <code>Connection</code> is able to accept the stream using
15
-
<code>accept_bi()</code>. Calling <ahref="Connection::open_bi"><code>open_bi</code></a> then waiting on the [<code>RecvStream</code>] without
16
-
writing anything to the connected [<code>SendStream</code>] will never succeed.</p>
15
+
<code>accept_bi()</code>. Calling <ahref="Connection::open_bi"><code>open_bi</code></a> then waiting on the <ahref="quinn::RecvStream"><code>RecvStream</code></a> without
16
+
writing anything to the connected <ahref="quinn::SendStream"><code>SendStream</code></a> will never succeed.</p>
</div></details><detailsclass="toggle method-toggle" open><summary><sectionid="method.closed" class="method"><h4class="code-header">pub async fn <ahref="#method.closed" class="fn">closed</a>(&self) -> ConnectionError</h4></section></summary><divclass="docblock"><p>Wait for the connection to be closed for any reason.</p>
19
19
<p>Despite the return type’s name, closed connections are often not an error condition
<p>The dynamic type returned is determined by the configured <ahref="quinn_proto::crypto::Session"><code>Session</code></a>. For the
69
69
default <code>rustls</code> session, the return value can be <ahref="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html#method.downcast" title="method alloc::boxed::Box::downcast"><code>downcast</code></a> to a
</div></details><detailsclass="toggle method-toggle" open><summary><sectionid="method.remote_id" class="method"><h4class="code-header">pub fn <ahref="#method.remote_id" class="fn">remote_id</a>(&self) -> <aclass="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><PublicKey, RemoteEndpointIdError></h4></section></summary><divclass="docblock"><p>Returns the [<code>EndpointId</code>] from the peer’s TLS certificate.</p>
72
-
<p>The <ahref="iroh_base::PublicKey"><code>PublicKey</code></a> of an endpoint is also known as a [<code>EndpointId</code>]. This <ahref="iroh_base::PublicKey"><code>PublicKey</code></a> is
71
+
</div></details><detailsclass="toggle method-toggle" open><summary><sectionid="method.remote_id" class="method"><h4class="code-header">pub fn <ahref="#method.remote_id" class="fn">remote_id</a>(&self) -> PublicKey</h4></section></summary><divclass="docblock"><p>Returns the [<code>EndpointId</code>] from the peer’s TLS certificate.</p>
72
+
<p>The <ahref="iroh_base::PublicKey"><code>PublicKey</code></a> of an endpoint is also known as an [<code>EndpointId</code>]. This <ahref="iroh_base::PublicKey"><code>PublicKey</code></a> is
73
73
included in the TLS certificate presented during the handshake when connecting.
74
74
This function allows you to get the [<code>EndpointId</code>] of the remote endpoint of this
S: <aclass="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><Dispatch>,</div></h4></section></summary><divclass='docblock'>Attaches the provided <ahref="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
121
121
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details><detailsclass="toggle method-toggle" open><summary><sectionid="method.with_current_subscriber" class="method trait-impl"><ahref="#method.with_current_subscriber" class="anchor">§</a><h4class="code-header">fn <aclass="fn">with_current_subscriber</a>(self) -> WithDispatch<Self></h4></section></summary><divclass='docblock'>Attaches the current <ahref="crate::dispatcher#setting-the-default-subscriber">default</a><ahref="super::Subscriber"><code>Subscriber</code></a> to this type, returning a
122
122
[<code>WithDispatch</code>] wrapper. <a>Read more</a></div></details></div></details><sectionid="impl-ErasedDestructor-for-T" class="impl"><ahref="#impl-ErasedDestructor-for-T" class="anchor">§</a><h3class="code-header">impl<T> ErasedDestructor for T<divclass="where">where
0 commit comments