QuantConnect.Brokerages.IWebSocket Interface Reference

Wrapper for WebSocket4Net to enhance testability More...

Inheritance diagram for QuantConnect.Brokerages.IWebSocket:

Public Member Functions
void	Initialize (string url, string sessionToken=null)
	Wraps constructor More...
void	Send (string data)
	Wraps send method More...
void	Connect ()
	Wraps Connect method More...
void	Close ()
	Wraps Close method More...

Properties
bool	IsOpen [get]
	Wraps IsOpen More...

Events
EventHandler< WebSocketMessage >	Message
	on message event More...
EventHandler< WebSocketError >	Error
	On error event More...
EventHandler	Open
	On Open event More...
EventHandler< WebSocketCloseData >	Closed
	On Close event More...

Detailed Description

Wrapper for WebSocket4Net to enhance testability

Definition at line 23 of file IWebSocket.cs.

Member Function Documentation

Initialize()

void QuantConnect.Brokerages.IWebSocket.Initialize	(	string	url,
		string	sessionToken = null
	)

Wraps constructor

Parameters

url	The target websocket url
sessionToken	The websocket session token

Implemented in QuantConnect.Brokerages.WebSocketClientWrapper.

Here is the caller graph for this function:

Send()

void QuantConnect.Brokerages.IWebSocket.Send

(

string

data

)

Wraps send method

Parameters

data

Implemented in QuantConnect.Brokerages.WebSocketClientWrapper.

Connect()

void QuantConnect.Brokerages.IWebSocket.Connect

(

)

Wraps Connect method

Implemented in QuantConnect.Brokerages.WebSocketClientWrapper.

Here is the caller graph for this function:

Close()

void QuantConnect.Brokerages.IWebSocket.Close

(

)

Wraps Close method

Implemented in QuantConnect.Brokerages.WebSocketClientWrapper.

Property Documentation

IsOpen

bool QuantConnect.Brokerages.IWebSocket.IsOpen

get

Wraps IsOpen

Definition at line 51 of file IWebSocket.cs.

Event Documentation

Message

EventHandler<WebSocketMessage> QuantConnect.Brokerages.IWebSocket.Message

on message event

Definition at line 56 of file IWebSocket.cs.

Error

EventHandler<WebSocketError> QuantConnect.Brokerages.IWebSocket.Error

On error event

Definition at line 61 of file IWebSocket.cs.

Open

EventHandler QuantConnect.Brokerages.IWebSocket.Open

On Open event

Definition at line 66 of file IWebSocket.cs.

Closed

EventHandler<WebSocketCloseData> QuantConnect.Brokerages.IWebSocket.Closed

On Close event

Definition at line 71 of file IWebSocket.cs.

---

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

• Brokerages/IWebSocket.cs