EGDL2 2.1
Loading...
Searching...
No Matches
WebSocketSharp.CloseEventArgs Class Reference

Contains the event data associated with a WebSocket.OnClose event. More...

Inherits EventArgs.

Properties

ushort Code [get]
 Gets the status code for the close.
 
string Reason [get]
 Gets the reason for the close.
 
bool WasClean [get, set]
 Gets a value indicating whether the WebSocket connection has been closed cleanly.
 

Detailed Description

Contains the event data associated with a WebSocket.OnClose event.

A WebSocket.OnClose event occurs when the WebSocket connection has been closed. If you would like to get the reason for the close, you should access the Code or Reason property.

Property Documentation

◆ Code

ushort WebSocketSharp.CloseEventArgs.Code
get

Gets the status code for the close.

A ushort that represents the status code for the close if any.

◆ Reason

string WebSocketSharp.CloseEventArgs.Reason
get

Gets the reason for the close.

A string that represents the reason for the close if any.

◆ WasClean

bool WebSocketSharp.CloseEventArgs.WasClean
getset

Gets a value indicating whether the WebSocket connection has been closed cleanly.

true if the WebSocket connection has been closed cleanly; otherwise, false.


The documentation for this class was generated from the following file: