Lean  $LEAN_TAG$
Public Member Functions | Properties | List of all members
QuantConnect.Interfaces.IBrokerageCashSynchronizer Interface Reference

Defines live brokerage cash synchronization operations. More...

Inheritance diagram for QuantConnect.Interfaces.IBrokerageCashSynchronizer:
[legend]

Public Member Functions

bool ShouldPerformCashSync (DateTime currentTimeUtc)
 Returns whether the brokerage should perform the cash synchronization More...
 
bool PerformCashSync (IAlgorithm algorithm, DateTime currentTimeUtc, Func< TimeSpan > getTimeSinceLastFill)
 Synchronizes the cashbook with the brokerage account More...
 

Properties

DateTime LastSyncDateTimeUtc [get]
 Gets the datetime of the last sync (UTC) More...
 

Detailed Description

Defines live brokerage cash synchronization operations.

Definition at line 23 of file IBrokerageCashSynchronizer.cs.

Member Function Documentation

◆ ShouldPerformCashSync()

bool QuantConnect.Interfaces.IBrokerageCashSynchronizer.ShouldPerformCashSync ( DateTime  currentTimeUtc)

Returns whether the brokerage should perform the cash synchronization

Parameters
currentTimeUtcThe current time (UTC)
Returns
True if the cash sync should be performed

Implemented in QuantConnect.Brokerages.Brokerage.

Here is the caller graph for this function:

◆ PerformCashSync()

bool QuantConnect.Interfaces.IBrokerageCashSynchronizer.PerformCashSync ( IAlgorithm  algorithm,
DateTime  currentTimeUtc,
Func< TimeSpan >  getTimeSinceLastFill 
)

Synchronizes the cashbook with the brokerage account

Parameters
algorithmThe algorithm instance
currentTimeUtcThe current time (UTC)
getTimeSinceLastFillA function which returns the time elapsed since the last fill
Returns
True if the cash sync was performed successfully

Implemented in QuantConnect.Brokerages.Brokerage.

Here is the caller graph for this function:

Property Documentation

◆ LastSyncDateTimeUtc

DateTime QuantConnect.Interfaces.IBrokerageCashSynchronizer.LastSyncDateTimeUtc
get

Gets the datetime of the last sync (UTC)

Definition at line 28 of file IBrokerageCashSynchronizer.cs.

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