QuantConnect.Data.DiskDataCacheProvider Class Reference

Simple data cache provider, writes and reads directly from disk Used as default for LeanDataWriter More...

Inheritance diagram for QuantConnect.Data.DiskDataCacheProvider:

Public Member Functions
	DiskDataCacheProvider ()
	Creates a new instance More...
	DiskDataCacheProvider (KeyStringSynchronizer locker)
	Creates a new instance using the given synchronizer More...
Stream	Fetch (string key)
	Fetch data from the cache More...
void	Store (string key, byte[] data)
	Store the data in the cache. Not implemented in this instance of the IDataCacheProvider More...
List< string >	GetZipEntries (string zipFile)
	Returns a list of zip entries in a provided zip file More...
void	Dispose ()
	Dispose for this class More...

Public Attributes
bool	IsDataEphemeral => false
	Property indicating the data is temporary in nature and should not be cached. More...

Additional Inherited Members
Properties inherited from QuantConnect.Interfaces.IDataCacheProvider
bool	IsDataEphemeral [get]
	Property indicating the data is temporary in nature and should not be cached More...

Detailed Description

Simple data cache provider, writes and reads directly from disk Used as default for LeanDataWriter

Definition at line 31 of file DiskDataCacheProvider.cs.

Constructor & Destructor Documentation

DiskDataCacheProvider() [1/2]

QuantConnect.Data.DiskDataCacheProvider.DiskDataCacheProvider

(

)

Creates a new instance

Definition at line 43 of file DiskDataCacheProvider.cs.

DiskDataCacheProvider() [2/2]

QuantConnect.Data.DiskDataCacheProvider.DiskDataCacheProvider

(

KeyStringSynchronizer

locker

)

Creates a new instance using the given synchronizer

Parameters

locker

The synchronizer instance to use

Definition at line 51 of file DiskDataCacheProvider.cs.

Member Function Documentation

Fetch()

Stream QuantConnect.Data.DiskDataCacheProvider.Fetch

(

string

key

)

Fetch data from the cache

Parameters

key	A string representing the key of the cached data

Returns

An Stream of the cached data

Implements QuantConnect.Interfaces.IDataCacheProvider.

Definition at line 61 of file DiskDataCacheProvider.cs.

Here is the call graph for this function:

Store()

void QuantConnect.Data.DiskDataCacheProvider.Store	(	string	key,
		byte[]	data
	)

Store the data in the cache. Not implemented in this instance of the IDataCacheProvider

Parameters

key	The source of the data, used as a key to retrieve data in the cache
data	The data as a byte array

Implements QuantConnect.Interfaces.IDataCacheProvider.

Definition at line 113 of file DiskDataCacheProvider.cs.

Here is the call graph for this function:

GetZipEntries()

List<string> QuantConnect.Data.DiskDataCacheProvider.GetZipEntries

(

string

zipFile

)

Returns a list of zip entries in a provided zip file

Implements QuantConnect.Interfaces.IDataCacheProvider.

Definition at line 126 of file DiskDataCacheProvider.cs.

Here is the call graph for this function:

Dispose()

void QuantConnect.Data.DiskDataCacheProvider.Dispose

(

)

Dispose for this class

Definition at line 138 of file DiskDataCacheProvider.cs.

Member Data Documentation

IsDataEphemeral

bool QuantConnect.Data.DiskDataCacheProvider.IsDataEphemeral => false

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

Definition at line 38 of file DiskDataCacheProvider.cs.

---

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

• Common/Data/DiskDataCacheProvider.cs