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

Defines a cache for data More...

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

Public Member Functions

Stream Fetch (string key)
 Fetch data from the cache More...
 
void Store (string key, byte[] data)
 Store the data in the cache More...
 
List< string > GetZipEntries (string zipFile)
 Returns a list of zip entries in a provided zip file More...
 

Properties

bool IsDataEphemeral [get]
 Property indicating the data is temporary in nature and should not be cached More...
 

Detailed Description

Defines a cache for data

Definition at line 26 of file IDataCacheProvider.cs.

Member Function Documentation

◆ Fetch()

Stream QuantConnect.Interfaces.IDataCacheProvider.Fetch ( string  key)

Fetch data from the cache

Parameters
keyA string representing the key of the cached data
Returns
An Stream of the cached data

Implemented in QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider, QuantConnect.Data.DiskDataCacheProvider, and QuantConnect.Lean.Engine.DataFeeds.SingleEntryDataCacheProvider.

Here is the caller graph for this function:

◆ Store()

void QuantConnect.Interfaces.IDataCacheProvider.Store ( string  key,
byte[]  data 
)

Store the data in the cache

Parameters
keyThe source of the data, used as a key to retrieve data in the cache
dataThe data to cache as a byte array

Implemented in QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider, QuantConnect.Data.DiskDataCacheProvider, and QuantConnect.Lean.Engine.DataFeeds.SingleEntryDataCacheProvider.

Here is the caller graph for this function:

◆ GetZipEntries()

List<string> QuantConnect.Interfaces.IDataCacheProvider.GetZipEntries ( string  zipFile)

Returns a list of zip entries in a provided zip file

Implemented in QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider, QuantConnect.Data.DiskDataCacheProvider, and QuantConnect.Lean.Engine.DataFeeds.SingleEntryDataCacheProvider.

Property Documentation

◆ IsDataEphemeral

bool QuantConnect.Interfaces.IDataCacheProvider.IsDataEphemeral
get

Property indicating the data is temporary in nature and should not be cached

Definition at line 31 of file IDataCacheProvider.cs.

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