Lean  $LEAN_TAG$
QuantConnect.Brokerages.WebSocketCloseData Class Reference

Defines data returned from a web socket close event More...

Public Member Functions

 WebSocketCloseData (ushort code, string reason, bool wasClean)
 Initializes a new instance of the WebSocketCloseData class More...
 

Properties

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

Detailed Description

Defines data returned from a web socket close event

Definition at line 21 of file WebSocketCloseData.cs.

Constructor & Destructor Documentation

◆ WebSocketCloseData()

QuantConnect.Brokerages.WebSocketCloseData.WebSocketCloseData ( ushort  code,
string  reason,
bool  wasClean 
)

Initializes a new instance of the WebSocketCloseData class

Parameters
codeThe status code for the connection close
reasonThe reaspn for the connection close
wasCleanTrue if the connection has been closed cleanly, false otherwise

Definition at line 44 of file WebSocketCloseData.cs.

Property Documentation

◆ Code

ushort QuantConnect.Brokerages.WebSocketCloseData.Code
get

Gets the status code for the connection close.

Definition at line 26 of file WebSocketCloseData.cs.

◆ Reason

string QuantConnect.Brokerages.WebSocketCloseData.Reason
get

Gets the reason for the connection close.

Definition at line 31 of file WebSocketCloseData.cs.

◆ WasClean

bool QuantConnect.Brokerages.WebSocketCloseData.WasClean
get

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

Definition at line 36 of file WebSocketCloseData.cs.


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