Skip to content

Commit

Permalink
Add remarks to IDuplexConnection (#4106)
Browse files Browse the repository at this point in the history
  • Loading branch information
bernardnormier authored Nov 14, 2024
1 parent 9917416 commit bcec78b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/IceRpc/Transports/IDuplexConnection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ public interface IDuplexConnection : IDisposable
/// <exception cref="InvalidOperationException">Thrown if this connection is connected, connecting or if a previous
/// connection attempt failed.</exception>
/// <exception cref="ObjectDisposedException">Thrown if the connection is disposed.</exception>
/// <remarks>When you call this method on a client connection, the returned task can complete successfully before
/// the server accepts the connection with <see cref="IListener{T}.AcceptAsync" />: a connected client connection
/// may be in the server-side listen backlog when the transport has such a backlog. See for example
/// <see cref="Tcp.TcpServerTransportOptions.ListenBacklog"/>.</remarks>
Task<TransportConnectionInformation> ConnectAsync(CancellationToken cancellationToken);

/// <summary>Reads data from the connection.</summary>
Expand Down

0 comments on commit bcec78b

Please sign in to comment.