Skip to content

Commit

Permalink
Merge pull request #23 from nexus4880/main
Browse files Browse the repository at this point in the history 
Ran code cleanup on WebSocketSharp
  • Loading branch information
@seionmoya
seionmoya authored Sep 2, 2024
2 parents 032bed7 + e4f9893 commit feb4b73
Show file tree
Hide file tree
Showing 76 changed files with 28,038 additions and 26,118 deletions.
26 changes: 12 additions & 14 deletions WebSocketSharp/ByteOrder.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,20 @@
*/
#endregion

using System;

namespace WebSocketSharp
{
/// <summary>
/// Specifies the byte order.
/// </summary>
public enum ByteOrder
{
/// <summary>
/// Specifies Little-endian.
/// </summary>
Little,
/// <summary>
/// Specifies Big-endian.
/// Specifies the byte order.
/// </summary>
Big
}
public enum ByteOrder
{
/// <summary>
/// Specifies Little-endian.
/// </summary>
Little,
/// <summary>
/// Specifies Big-endian.
/// </summary>
Big
}
}
156 changes: 81 additions & 75 deletions WebSocketSharp/CloseEventArgs.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,89 +30,95 @@

namespace WebSocketSharp
{
/// <summary>
/// Represents the event data for the <see cref="WebSocket.OnClose"/> event.
/// </summary>
/// <remarks>
/// <para>
/// The close event occurs when the WebSocket connection has been closed.
/// </para>
/// <para>
/// If you would like to get the reason for the connection close,
/// you should access the <see cref="Code"/> or <see cref="Reason"/>
/// property.
/// </para>
/// </remarks>
public class CloseEventArgs : EventArgs
{
#region Private Fields
/// <summary>
/// Represents the event data for the <see cref="WebSocket.OnClose"/> event.
/// </summary>
/// <remarks>
/// <para>
/// The close event occurs when the WebSocket connection has been closed.
/// </para>
/// <para>
/// If you would like to get the reason for the connection close,
/// you should access the <see cref="Code"/> or <see cref="Reason"/>
/// property.
/// </para>
/// </remarks>
public class CloseEventArgs : EventArgs
{
#region Private Fields

private bool _clean;
private PayloadData _payloadData;
private bool _clean;
private PayloadData _payloadData;

#endregion
#endregion

#region Internal Constructors
#region Internal Constructors

internal CloseEventArgs (PayloadData payloadData, bool clean)
{
_payloadData = payloadData;
_clean = clean;
}
internal CloseEventArgs(PayloadData payloadData, bool clean)
{
_payloadData = payloadData;
_clean = clean;
}

#endregion
#endregion

#region Public Properties
#region Public Properties

/// <summary>
/// Gets the status code for the connection close.
/// </summary>
/// <value>
/// <para>
/// A <see cref="ushort"/> that represents the status code for
/// the connection close.
/// </para>
/// <para>
/// 1005 (no status) if not present.
/// </para>
/// </value>
public ushort Code {
get {
return _payloadData.Code;
}
}
/// <summary>
/// Gets the status code for the connection close.
/// </summary>
/// <value>
/// <para>
/// A <see cref="ushort"/> that represents the status code for
/// the connection close.
/// </para>
/// <para>
/// 1005 (no status) if not present.
/// </para>
/// </value>
public ushort Code
{
get
{
return _payloadData.Code;
}
}

/// <summary>
/// Gets the reason for the connection close.
/// </summary>
/// <value>
/// <para>
/// A <see cref="string"/> that represents the reason for
/// the connection close.
/// </para>
/// <para>
/// An empty string if not present.
/// </para>
/// </value>
public string Reason {
get {
return _payloadData.Reason;
}
}
/// <summary>
/// Gets the reason for the connection close.
/// </summary>
/// <value>
/// <para>
/// A <see cref="string"/> that represents the reason for
/// the connection close.
/// </para>
/// <para>
/// An empty string if not present.
/// </para>
/// </value>
public string Reason
{
get
{
return _payloadData.Reason;
}
}

/// <summary>
/// Gets a value indicating whether the connection has been closed cleanly.
/// </summary>
/// <value>
/// <c>true</c> if the connection has been closed cleanly; otherwise,
/// <c>false</c>.
/// </value>
public bool WasClean {
get {
return _clean;
}
}
/// <summary>
/// Gets a value indicating whether the connection has been closed cleanly.
/// </summary>
/// <value>
/// <c>true</c> if the connection has been closed cleanly; otherwise,
/// <c>false</c>.
/// </value>
public bool WasClean
{
get
{
return _clean;
}
}

#endregion
}
#endregion
}
}
172 changes: 85 additions & 87 deletions WebSocketSharp/CloseStatusCode.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,95 +26,93 @@
*/
#endregion

using System;

namespace WebSocketSharp
{
/// <summary>
/// Indicates the status code for the WebSocket connection close.
/// </summary>
/// <remarks>
/// <para>
/// The values of this enumeration are defined in
/// <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
/// Section 7.4</see> of RFC 6455.
/// </para>
/// <para>
/// "Reserved value" cannot be sent as a status code in
/// closing handshake by an endpoint.
/// </para>
/// </remarks>
public enum CloseStatusCode : ushort
{
/// <summary>
/// Equivalent to close status 1000. Indicates normal close.
/// </summary>
Normal = 1000,
/// <summary>
/// Equivalent to close status 1001. Indicates that an endpoint is
/// going away.
/// </summary>
Away = 1001,
/// <summary>
/// Equivalent to close status 1002. Indicates that an endpoint is
/// terminating the connection due to a protocol error.
/// </summary>
ProtocolError = 1002,
/// <summary>
/// Equivalent to close status 1003. Indicates that an endpoint is
/// terminating the connection because it has received a type of
/// data that it cannot accept.
/// </summary>
UnsupportedData = 1003,
/// <summary>
/// Equivalent to close status 1004. Still undefined. A Reserved value.
/// </summary>
Undefined = 1004,
/// <summary>
/// Equivalent to close status 1005. Indicates that no status code was
/// actually present. A Reserved value.
/// </summary>
NoStatus = 1005,
/// <summary>
/// Equivalent to close status 1006. Indicates that the connection was
/// closed abnormally. A Reserved value.
/// </summary>
Abnormal = 1006,
/// <summary>
/// Equivalent to close status 1007. Indicates that an endpoint is
/// terminating the connection because it has received a message that
/// contains data that is not consistent with the type of the message.
/// </summary>
InvalidData = 1007,
/// <summary>
/// Equivalent to close status 1008. Indicates that an endpoint is
/// terminating the connection because it has received a message that
/// violates its policy.
/// </summary>
PolicyViolation = 1008,
/// <summary>
/// Equivalent to close status 1009. Indicates that an endpoint is
/// terminating the connection because it has received a message that
/// is too big to process.
/// </summary>
TooBig = 1009,
/// <summary>
/// Equivalent to close status 1010. Indicates that a client is
/// terminating the connection because it has expected the server to
/// negotiate one or more extension, but the server did not return
/// them in the handshake response.
/// </summary>
MandatoryExtension = 1010,
/// <summary>
/// Equivalent to close status 1011. Indicates that a server is
/// terminating the connection because it has encountered an unexpected
/// condition that prevented it from fulfilling the request.
/// </summary>
ServerError = 1011,
/// <summary>
/// Equivalent to close status 1015. Indicates that the connection was
/// closed due to a failure to perform a TLS handshake. A Reserved value.
/// Indicates the status code for the WebSocket connection close.
/// </summary>
TlsHandshakeFailure = 1015
}
/// <remarks>
/// <para>
/// The values of this enumeration are defined in
/// <see href="http://tools.ietf.org/html/rfc6455#section-7.4">
/// Section 7.4</see> of RFC 6455.
/// </para>
/// <para>
/// "Reserved value" cannot be sent as a status code in
/// closing handshake by an endpoint.
/// </para>
/// </remarks>
public enum CloseStatusCode : ushort
{
/// <summary>
/// Equivalent to close status 1000. Indicates normal close.
/// </summary>
Normal = 1000,
/// <summary>
/// Equivalent to close status 1001. Indicates that an endpoint is
/// going away.
/// </summary>
Away = 1001,
/// <summary>
/// Equivalent to close status 1002. Indicates that an endpoint is
/// terminating the connection due to a protocol error.
/// </summary>
ProtocolError = 1002,
/// <summary>
/// Equivalent to close status 1003. Indicates that an endpoint is
/// terminating the connection because it has received a type of
/// data that it cannot accept.
/// </summary>
UnsupportedData = 1003,
/// <summary>
/// Equivalent to close status 1004. Still undefined. A Reserved value.
/// </summary>
Undefined = 1004,
/// <summary>
/// Equivalent to close status 1005. Indicates that no status code was
/// actually present. A Reserved value.
/// </summary>
NoStatus = 1005,
/// <summary>
/// Equivalent to close status 1006. Indicates that the connection was
/// closed abnormally. A Reserved value.
/// </summary>
Abnormal = 1006,
/// <summary>
/// Equivalent to close status 1007. Indicates that an endpoint is
/// terminating the connection because it has received a message that
/// contains data that is not consistent with the type of the message.
/// </summary>
InvalidData = 1007,
/// <summary>
/// Equivalent to close status 1008. Indicates that an endpoint is
/// terminating the connection because it has received a message that
/// violates its policy.
/// </summary>
PolicyViolation = 1008,
/// <summary>
/// Equivalent to close status 1009. Indicates that an endpoint is
/// terminating the connection because it has received a message that
/// is too big to process.
/// </summary>
TooBig = 1009,
/// <summary>
/// Equivalent to close status 1010. Indicates that a client is
/// terminating the connection because it has expected the server to
/// negotiate one or more extension, but the server did not return
/// them in the handshake response.
/// </summary>
MandatoryExtension = 1010,
/// <summary>
/// Equivalent to close status 1011. Indicates that a server is
/// terminating the connection because it has encountered an unexpected
/// condition that prevented it from fulfilling the request.
/// </summary>
ServerError = 1011,
/// <summary>
/// Equivalent to close status 1015. Indicates that the connection was
/// closed due to a failure to perform a TLS handshake. A Reserved value.
/// </summary>
TlsHandshakeFailure = 1015
}
}
Loading

0 comments on commit feb4b73

Please sign in to comment.