QuantConnect.Lean.Engine.DataFeeds.SingleEntryDataCacheProvider Class Reference

Default implementation of the IDataCacheProvider Does not cache data. If the data is a zip, the first entry is returned More...

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

Public Member Functions
	SingleEntryDataCacheProvider (IDataProvider dataProvider, bool isDataEphemeral=true)
	Constructor that takes the IDataProvider to be used to retrieve data More...
Stream	Fetch (string key)
	Fetch data from the cache More...
void	Store (string key, byte[] data)
	Not implemented 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

Default implementation of the IDataCacheProvider Does not cache data. If the data is a zip, the first entry is returned

Definition at line 32 of file SingleEntryDataCacheProvider.cs.

Constructor & Destructor Documentation

SingleEntryDataCacheProvider()

QuantConnect.Lean.Engine.DataFeeds.SingleEntryDataCacheProvider.SingleEntryDataCacheProvider	(	IDataProvider	dataProvider,
		bool	isDataEphemeral = true
	)

Constructor that takes the IDataProvider to be used to retrieve data

Definition at line 46 of file SingleEntryDataCacheProvider.cs.

Member Function Documentation

Fetch()

Stream QuantConnect.Lean.Engine.DataFeeds.SingleEntryDataCacheProvider.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 57 of file SingleEntryDataCacheProvider.cs.

Here is the call graph for this function:

Store()

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

Not implemented

Parameters

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

Implements QuantConnect.Interfaces.IDataCacheProvider.

Definition at line 90 of file SingleEntryDataCacheProvider.cs.

GetZipEntries()

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

(

string

zipFile

)

Returns a list of zip entries in a provided zip file

Implements QuantConnect.Interfaces.IDataCacheProvider.

Definition at line 98 of file SingleEntryDataCacheProvider.cs.

Here is the call graph for this function:

Dispose()

void QuantConnect.Lean.Engine.DataFeeds.SingleEntryDataCacheProvider.Dispose

(

)

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

Definition at line 114 of file SingleEntryDataCacheProvider.cs.

Property Documentation

IsDataEphemeral

bool QuantConnect.Lean.Engine.DataFeeds.SingleEntryDataCacheProvider.IsDataEphemeral

get

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

Definition at line 41 of file SingleEntryDataCacheProvider.cs.

---

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

• Engine/DataFeeds/SingleEntryDataCacheProvider.cs