Lean  $LEAN_TAG$
QuantConnect.Brokerages.IConnectionHandler Interface Reference

Provides handling of a brokerage or data feed connection More...

Inheritance diagram for QuantConnect.Brokerages.IConnectionHandler:
[legend]

Public Member Functions

void Initialize (string connectionId)
 Initializes the connection handler More...
 
void EnableMonitoring (bool isEnabled)
 Enables/disables monitoring of the connection More...
 
void KeepAlive (DateTime lastDataReceivedTime)
 Notifies the connection handler that new data was received More...
 

Properties

bool IsConnectionLost [get]
 Returns true if the connection has been lost More...
 

Events

EventHandler ConnectionLost
 Event that fires when a connection loss is detected More...
 
EventHandler ConnectionRestored
 Event that fires when a lost connection is restored More...
 
EventHandler ReconnectRequested
 Event that fires when a reconnection attempt is required More...
 

Detailed Description

Provides handling of a brokerage or data feed connection

Definition at line 23 of file IConnectionHandler.cs.

Member Function Documentation

◆ Initialize()

void QuantConnect.Brokerages.IConnectionHandler.Initialize ( string  connectionId)

Initializes the connection handler

Parameters
connectionIdThe connection id

Implemented in QuantConnect.Brokerages.DefaultConnectionHandler.

◆ EnableMonitoring()

void QuantConnect.Brokerages.IConnectionHandler.EnableMonitoring ( bool  isEnabled)

Enables/disables monitoring of the connection

Parameters
isEnabledTrue to enable monitoring, false otherwise

Implemented in QuantConnect.Brokerages.DefaultConnectionHandler.

◆ KeepAlive()

void QuantConnect.Brokerages.IConnectionHandler.KeepAlive ( DateTime  lastDataReceivedTime)

Notifies the connection handler that new data was received

Parameters
lastDataReceivedTimeThe UTC timestamp of the last data point received

Implemented in QuantConnect.Brokerages.DefaultConnectionHandler.

Property Documentation

◆ IsConnectionLost

bool QuantConnect.Brokerages.IConnectionHandler.IsConnectionLost
get

Returns true if the connection has been lost

Definition at line 43 of file IConnectionHandler.cs.

Event Documentation

◆ ConnectionLost

EventHandler QuantConnect.Brokerages.IConnectionHandler.ConnectionLost

Event that fires when a connection loss is detected

Definition at line 28 of file IConnectionHandler.cs.

◆ ConnectionRestored

EventHandler QuantConnect.Brokerages.IConnectionHandler.ConnectionRestored

Event that fires when a lost connection is restored

Definition at line 33 of file IConnectionHandler.cs.

◆ ReconnectRequested

EventHandler QuantConnect.Brokerages.IConnectionHandler.ReconnectRequested

Event that fires when a reconnection attempt is required

Definition at line 38 of file IConnectionHandler.cs.


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