Skip to content
This repository has been archived by the owner on Jan 23, 2023. It is now read-only.
/ corefx Public archive

Fix XML comments in ManagedWebSocket #10792

Merged
merged 1 commit into from
Aug 15, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ internal sealed class ManagedWebSocket : WebSocket
/// <param name="stream">The connected Stream.</param>
/// <param name="isServer">true if this is the server-side of the connection; false if this is the client-side of the connection.</param>
/// <param name="subprotocol">The agreed upon subprotocol for the connection.</param>
/// <param name="state">The current state of the websocket connection.</param>
/// <param name="keepAliveIntervalSeconds">The interval to use for keep-alive pings.</param>
/// <param name="receiveBufferSize">The buffer size to use for received data.</param>
/// <returns>The created <see cref="ManagedWebSocket"/> instance.</returns>
Expand Down Expand Up @@ -877,7 +876,7 @@ private async Task CloseWithReceiveErrorAndThrowAsync(
}

/// <summary>Parses a message header from the buffer. This assumes the header is in the buffer.</summary>
/// <param name="header">The read header.</param>
/// <param name="resultHeader">The read header.</param>
/// <returns>true if a header was read; false if the header was invalid.</returns>
private bool TryParseMessageHeaderFromReceiveBuffer(out MessageHeader resultHeader)
{
Expand Down Expand Up @@ -1035,7 +1034,7 @@ private async Task CloseAsyncPrivate(WebSocketCloseStatus closeStatus, string st

/// <summary>Sends a close message to the server.</summary>
/// <param name="closeStatus">The close status to send.</param>
/// <param name="statusDescription">The close status description to send.</param>
/// <param name="closeStatusDescription">The close status description to send.</param>
/// <param name="cancellationToken">The CancellationToken to use to cancel the websocket.</param>
private async Task SendCloseFrameAsync(WebSocketCloseStatus closeStatus, string closeStatusDescription, CancellationToken cancellationToken)
{
Expand Down Expand Up @@ -1151,9 +1150,9 @@ private static int ApplyMask(byte[] toMask, int toMaskOffset, byte[] mask, int m
/// <param name="toMask">The buffer to which the mask should be applied.</param>
/// <param name="toMaskOffset">The offset into <paramref name="toMask"/> at which the mask should start to be applied.</param>
/// <param name="mask">The four-byte mask, stored as an Int32.</param>
/// <param name="maskOffsetIndex">The index into the mas</param>
/// <param name="maskIndex">The index into the mask.</param>
/// <param name="count">The number of bytes to mask.</param>
/// <returns></returns>
/// <returns>The next index into the mask to be used for future applications of the mask.</returns>
private static unsafe int ApplyMask(byte[] toMask, int toMaskOffset, int mask, int maskIndex, long count)
{
Debug.Assert(toMaskOffset <= toMask.Length - count, $"Unexpected inputs: {toMaskOffset}, {toMask.Length}, {count}");
Expand Down