QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider Class Reference

File provider implements optimized zip archives caching facility. Cache is thread safe. More...

Inheritance diagram for QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider:

Public Member Functions
	ZipDataCacheProvider (IDataProvider dataProvider, bool isDataEphemeral=true, double cacheTimer=double.NaN)
	Constructor that sets the IDataProvider used to retrieve data More...
Stream	Fetch (string key)
	Does not attempt to retrieve any data 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...
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

Properties
bool	IsDataEphemeral [get]
	Property indicating the data is temporary in nature and should not be cached. More...
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

File provider implements optimized zip archives caching facility. Cache is thread safe.

Definition at line 34 of file ZipDataCacheProvider.cs.

Constructor & Destructor Documentation

ZipDataCacheProvider()

QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider.ZipDataCacheProvider	(	IDataProvider	dataProvider,
		bool	isDataEphemeral = true,
		double	cacheTimer = double.NaN
	)

Constructor that sets the IDataProvider used to retrieve data

Definition at line 51 of file ZipDataCacheProvider.cs.

Here is the call graph for this function:

Member Function Documentation

Fetch()

Stream QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider.Fetch

(

string

key

)

Does not attempt to retrieve any data

Implements QuantConnect.Interfaces.IDataCacheProvider.

Definition at line 62 of file ZipDataCacheProvider.cs.

Here is the call graph for this function:

Store()

void QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider.Store	(	string	key,
		byte[]	data
	)

Store the data in the cache.

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 129 of file ZipDataCacheProvider.cs.

Here is the call graph for this function:

GetZipEntries()

List<string> QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider.GetZipEntries

(

string

zipFile

)

Returns a list of zip entries in a provided zip file

Implements QuantConnect.Interfaces.IDataCacheProvider.

Definition at line 185 of file ZipDataCacheProvider.cs.

Dispose()

void QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider.Dispose

(

)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

<filterpriority>2</filterpriority>

Definition at line 206 of file ZipDataCacheProvider.cs.

Property Documentation

IsDataEphemeral

bool QuantConnect.Lean.Engine.DataFeeds.ZipDataCacheProvider.IsDataEphemeral

get

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

Definition at line 46 of file ZipDataCacheProvider.cs.

---

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

• Engine/DataFeeds/ZipDataCacheProvider.cs