My Project
Loading...
Searching...
No Matches
Properties | List of all members
WebSocketSharp.CloseEventArgs Class Reference

Represents the event data for the WebSocket.OnClose event. More...

Inheritance diagram for WebSocketSharp.CloseEventArgs:

Properties

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

Detailed Description

Represents the event data for the WebSocket.OnClose event.

The close event occurs when the WebSocket connection has been closed.

If you would like to get the reason for the connection close, you should access the Code or Reason property.

Property Documentation

◆ Code

ushort WebSocketSharp.CloseEventArgs.Code
get

Gets the status code for the connection close.

A ushort that represents the status code for the connection close.

1005 (no status) if not present.

◆ Reason

string WebSocketSharp.CloseEventArgs.Reason
get

Gets the reason for the connection close.

A string that represents the reason for the connection close.

An empty string if not present.

◆ WasClean

bool WebSocketSharp.CloseEventArgs.WasClean
get

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

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


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