Skip to content

Commit 767d2ac

Browse files
committed
[Modify] Edit it
1 parent 03622c3 commit 767d2ac

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

websocket-sharp/Server/WebSocketServer.cs

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1095,15 +1095,45 @@ public void AddWebSocketService<TBehaviorWithNew> (string path)
10951095
/// <summary>
10961096
/// Removes a WebSocket service with the specified <paramref name="path"/>.
10971097
/// </summary>
1098+
/// <remarks>
1099+
/// <para>
1100+
/// <paramref name="path"/> is converted to a URL-decoded string and
1101+
/// / is trimmed from the end of the converted string if any.
1102+
/// </para>
1103+
/// <para>
1104+
/// The service is stopped with close status 1001 (going away)
1105+
/// if it has already started.
1106+
/// </para>
1107+
/// </remarks>
10981108
/// <returns>
10991109
/// <c>true</c> if the service is successfully found and removed;
11001110
/// otherwise, <c>false</c>.
11011111
/// </returns>
11021112
/// <param name="path">
11031113
/// A <see cref="string"/> that represents an absolute path to
1104-
/// the service. It will be converted to a URL-decoded string,
1105-
/// and will be removed <c>'/'</c> from tail end if any.
1114+
/// the service to remove.
11061115
/// </param>
1116+
/// <exception cref="ArgumentNullException">
1117+
/// <paramref name="path"/> is <see langword="null"/>.
1118+
/// </exception>
1119+
/// <exception cref="ArgumentException">
1120+
/// <para>
1121+
/// <paramref name="path"/> is empty.
1122+
/// </para>
1123+
/// <para>
1124+
/// -or-
1125+
/// </para>
1126+
/// <para>
1127+
/// <paramref name="path"/> is not an absolute path.
1128+
/// </para>
1129+
/// <para>
1130+
/// -or-
1131+
/// </para>
1132+
/// <para>
1133+
/// <paramref name="path"/> includes either or both
1134+
/// query and fragment components.
1135+
/// </para>
1136+
/// </exception>
11071137
public bool RemoveWebSocketService (string path)
11081138
{
11091139
return _services.RemoveService (path);

0 commit comments

Comments
 (0)