WebSocketSharp Namespace Reference

Classes
class	CloseEventArgs
	Represents the event data for the WebSocket.OnClose event. More...
class	ErrorEventArgs
	Represents the event data for the WebSocket.OnError event. More...
class	Ext
	Provides a set of static methods for websocket-sharp.
class	HttpBase
class	HttpRequest
class	HttpResponse
class	LogData
	Represents a log data used by the Logger class. More...
class	Logger
	Provides a set of methods and properties for logging. More...
class	MessageEventArgs
	Represents the event data for the WebSocket.OnMessage event. More...
class	PayloadData
class	WebSocket
	Implements the WebSocket interface. More...
class	WebSocketException
	The exception that is thrown when a fatal error occurs in the WebSocket communication. More...
class	WebSocketFrame

Enumerations
enum	ByteOrder { Little , Big }
	Specifies the byte order. More...
enum	CloseStatusCode : ushort {   Normal = 1000 , Away = 1001 , ProtocolError = 1002 , UnsupportedData = 1003 ,   Undefined = 1004 , NoStatus = 1005 , Abnormal = 1006 , InvalidData = 1007 ,   PolicyViolation = 1008 , TooBig = 1009 , MandatoryExtension = 1010 , ServerError = 1011 ,   TlsHandshakeFailure = 1015 }
	Indicates the status code for the WebSocket connection close. More...
enum	CompressionMethod : byte { None , Deflate }
	Specifies the method for compression. More...
enum	LogLevel {   Trace , Debug , Info , Warn ,   Error , Fatal , None }
	Specifies the logging level. More...
enum	WebSocketState : ushort {   New = 0 , Connecting = 1 , Open = 2 , Closing = 3 ,   Closed = 4 }
	Indicates the state of the WebSocket interface. More...

Enumeration Type Documentation

ByteOrder

enum WebSocketSharp.ByteOrder

Specifies the byte order.

Enumerator
Little	Specifies Little-endian.
Big	Specifies Big-endian.

CloseStatusCode

enum WebSocketSharp.CloseStatusCode : ushort

Indicates the status code for the WebSocket connection close.

The values of this enumeration are defined in Section 7.4

of RFC 6455.

"Reserved value" cannot be sent as a status code in closing handshake by an endpoint.

Enumerator
Normal	Equivalent to close status 1000. Indicates normal close.
Away	Equivalent to close status 1001. Indicates that an endpoint is going away.
ProtocolError	Equivalent to close status 1002. Indicates that an endpoint is terminating the connection due to a protocol error.
UnsupportedData	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.
Undefined	Equivalent to close status 1004. Still undefined. A Reserved value.
NoStatus	Equivalent to close status 1005. Indicates that no status code was actually present. A Reserved value.
Abnormal	Equivalent to close status 1006. Indicates that the connection was closed abnormally. A Reserved value.
InvalidData	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.
PolicyViolation	Equivalent to close status 1008. Indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
TooBig	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.
MandatoryExtension	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.
ServerError	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.
TlsHandshakeFailure	Equivalent to close status 1015. Indicates that the connection was closed due to a failure to perform a TLS handshake. A Reserved value.

CompressionMethod

enum WebSocketSharp.CompressionMethod : byte

Specifies the method for compression.

The methods are defined in Compression Extensions for WebSocket

.

Enumerator
None	Specifies no compression.
Deflate	Specifies DEFLATE.

LogLevel

enum WebSocketSharp.LogLevel

Specifies the logging level.

Enumerator
Trace	Specifies the bottom logging level.
Debug	Specifies the 2nd logging level from the bottom.
Info	Specifies the 3rd logging level from the bottom.
Warn	Specifies the 3rd logging level from the top.
Error	Specifies the 2nd logging level from the top.
Fatal	Specifies the top logging level.
None	Specifies not to output logs.

WebSocketState

enum WebSocketSharp.WebSocketState : ushort

Indicates the state of the WebSocket interface.

Enumerator
New	Equivalent to numeric value 0. Indicates that a new interface has been created.
Connecting	Equivalent to numeric value 1. Indicates that the connect process is in progress.
Open	Equivalent to numeric value 2. Indicates that the connection has been established and the communication is possible.
Closing	Equivalent to numeric value 3. Indicates that the close process is in progress.
Closed	Equivalent to numeric value 4. Indicates that the connection has been closed or could not be established.