Skip to content

Commit a43e88e

Browse files
committed
Note fire-and-forget status of HubConnection event tasks
1 parent f2ea31d commit a43e88e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/SignalR/clients/csharp/Client.Core/src/HubConnection.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ public partial class HubConnection : IAsyncDisposable
9797
/// If this event was triggered from a connection error, the <see cref="Exception"/> that occurred will be passed in as the
9898
/// sole argument to this handler. If this event was triggered intentionally by either the client or server, then
9999
/// the argument will be <see langword="null"/>.
100+
///
101+
/// The <see cref="Task"/> result is fire-and-forget: the <see cref="HubConnection"/> does not wait for it to complete.
100102
/// </remarks>
101103
/// <example>
102104
/// The following example attaches a handler to the <see cref="Closed"/> event, and checks the provided argument to determine
@@ -123,6 +125,8 @@ public partial class HubConnection : IAsyncDisposable
123125
/// </summary>
124126
/// <remarks>
125127
/// The <see cref="Exception"/> that occurred will be passed in as the sole argument to this handler.
128+
///
129+
/// The <see cref="Task"/> result is fire-and-forget: the <see cref="HubConnection"/> does not wait for it to complete.
126130
/// </remarks>
127131
/// <example>
128132
/// The following example attaches a handler to the <see cref="Reconnecting"/> event, and checks the provided argument to log the error.
@@ -141,6 +145,8 @@ public partial class HubConnection : IAsyncDisposable
141145
/// </summary>
142146
/// <remarks>
143147
/// The <see cref="string"/> parameter will be the <see cref="HubConnection"/>'s new ConnectionId or null if negotiation was skipped.
148+
///
149+
/// The <see cref="Task"/> result is fire-and-forget: the <see cref="HubConnection"/> does not wait for it to complete.
144150
/// </remarks>
145151
/// <example>
146152
/// The following example attaches a handler to the <see cref="Reconnected"/> event, and checks the provided argument to log the ConnectionId.

0 commit comments

Comments
 (0)