Lean: QuantConnect.Brokerages.BrokerageMultiWebSocketEntry Class Reference

Lean $LEAN_TAG$

Helper class for BrokerageMultiWebSocketSubscriptionManager More...

Public Member Functions
bool	Contains (Symbol symbol)
	Returns whether the symbol is subscribed More...

	BrokerageMultiWebSocketEntry (Dictionary< Symbol, int > symbolWeights, IWebSocket webSocket)
	Initializes a new instance of the BrokerageMultiWebSocketEntry class More...

	BrokerageMultiWebSocketEntry (IWebSocket webSocket)
	Initializes a new instance of the BrokerageMultiWebSocketEntry class More...

void	AddSymbol (Symbol symbol)
	Adds a symbol to the entry More...

void	RemoveSymbol (Symbol symbol)
	Removes a symbol from the entry More...

Properties
IWebSocket	WebSocket `[get]`
	Gets the web socket instance More...

int	TotalWeight `[get]`
	Gets the sum of symbol weights for this web socket More...

int	SymbolCount `[get]`
	Gets the number of symbols subscribed More...

IReadOnlyCollection< Symbol >	Symbols `[get]`
	Returns the list of subscribed symbols More...

Detailed Description

Helper class for BrokerageMultiWebSocketSubscriptionManager

Definition at line 24 of file BrokerageMultiWebSocketEntry.cs.

Constructor & Destructor Documentation

◆ BrokerageMultiWebSocketEntry() [1/2]

QuantConnect.Brokerages.BrokerageMultiWebSocketEntry.BrokerageMultiWebSocketEntry	(	Dictionary< Symbol, int >	symbolWeights,
		IWebSocket	webSocket
	)

Initializes a new instance of the BrokerageMultiWebSocketEntry class

Parameters

symbolWeights	A dictionary of symbol weights
webSocket	The web socket instance

Definition at line 87 of file BrokerageMultiWebSocketEntry.cs.

◆ BrokerageMultiWebSocketEntry() [2/2]

QuantConnect.Brokerages.BrokerageMultiWebSocketEntry.BrokerageMultiWebSocketEntry ( IWebSocket webSocket )

Initializes a new instance of the BrokerageMultiWebSocketEntry class

Parameters

webSocket The web socket instance

Definition at line 99 of file BrokerageMultiWebSocketEntry.cs.

Member Function Documentation

◆ Contains()

bool QuantConnect.Brokerages.BrokerageMultiWebSocketEntry.Contains ( Symbol symbol )

Returns whether the symbol is subscribed

Parameters

symbol

Returns

Definition at line 59 of file BrokerageMultiWebSocketEntry.cs.

◆ AddSymbol()

void QuantConnect.Brokerages.BrokerageMultiWebSocketEntry.AddSymbol ( Symbol symbol )

Adds a symbol to the entry

Parameters

symbol The symbol to add

Definition at line 108 of file BrokerageMultiWebSocketEntry.cs.

◆ RemoveSymbol()

void QuantConnect.Brokerages.BrokerageMultiWebSocketEntry.RemoveSymbol ( Symbol symbol )

Removes a symbol from the entry

Parameters

symbol The symbol to remove

Definition at line 125 of file BrokerageMultiWebSocketEntry.cs.

Property Documentation

◆ WebSocket

IWebSocket QuantConnect.Brokerages.BrokerageMultiWebSocketEntry.WebSocket

get

Gets the web socket instance

Definition at line 33 of file BrokerageMultiWebSocketEntry.cs.

◆ TotalWeight

int QuantConnect.Brokerages.BrokerageMultiWebSocketEntry.TotalWeight

get

Gets the sum of symbol weights for this web socket

Definition at line 38 of file BrokerageMultiWebSocketEntry.cs.

◆ SymbolCount

int QuantConnect.Brokerages.BrokerageMultiWebSocketEntry.SymbolCount

get

Gets the number of symbols subscribed

Definition at line 44 of file BrokerageMultiWebSocketEntry.cs.

◆ Symbols

IReadOnlyCollection<Symbol> QuantConnect.Brokerages.BrokerageMultiWebSocketEntry.Symbols

get

Returns the list of subscribed symbols

Returns

Definition at line 72 of file BrokerageMultiWebSocketEntry.cs.

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

Brokerages/BrokerageMultiWebSocketEntry.cs