Lean
$LEAN_TAG$
|
Represents a stream reader capabable of downloading a remote file and then reading it from disk More...
Public Member Functions | |
RemoteFileSubscriptionStreamReader (IDataCacheProvider dataCacheProvider, string source, string downloadDirectory, IEnumerable< KeyValuePair< string, string >> headers) | |
Initializes a new instance of the RemoteFileSubscriptionStreamReader class. More... | |
string | ReadLine () |
Gets the next line/batch of content from the stream More... | |
void | Dispose () |
Disposes of the stream More... | |
Static Public Member Functions | |
static void | SetDownloadProvider (IDownloadProvider downloader) |
Save reference to the download system. More... | |
Public Attributes | |
bool | ShouldBeRateLimited => false |
Gets whether or not this stream reader should be rate limited More... | |
StreamReader | StreamReader => _streamReader.StreamReader |
Direct access to the StreamReader instance More... | |
Properties | |
string | LocalFileName [get] |
The local file name of the downloaded file More... | |
SubscriptionTransportMedium | TransportMedium [get] |
Gets SubscriptionTransportMedium.RemoteFile More... | |
bool | EndOfStream [get] |
Gets whether or not there's more data to be read in the stream More... | |
Properties inherited from QuantConnect.Interfaces.IStreamReader | |
SubscriptionTransportMedium | TransportMedium [get] |
Gets the transport medium of this stream reader More... | |
bool | EndOfStream [get] |
Gets whether or not there's more data to be read in the stream More... | |
StreamReader | StreamReader [get] |
Direct access to the StreamReader instance More... | |
bool | ShouldBeRateLimited [get] |
Gets whether or not this stream reader should be rate limited More... | |
Represents a stream reader capabable of downloading a remote file and then reading it from disk
Definition at line 29 of file RemoteFileSubscriptionStreamReader.cs.
QuantConnect.Lean.Engine.DataFeeds.Transport.RemoteFileSubscriptionStreamReader.RemoteFileSubscriptionStreamReader | ( | IDataCacheProvider | dataCacheProvider, |
string | source, | ||
string | downloadDirectory, | ||
IEnumerable< KeyValuePair< string, string >> | headers | ||
) |
Initializes a new instance of the RemoteFileSubscriptionStreamReader class.
dataCacheProvider | The IDataCacheProvider used to retrieve a stream of data |
source | The remote url to be downloaded via web client |
downloadDirectory | The local directory and destination of the download |
headers | Defines header values to add to the request |
Definition at line 58 of file RemoteFileSubscriptionStreamReader.cs.
string QuantConnect.Lean.Engine.DataFeeds.Transport.RemoteFileSubscriptionStreamReader.ReadLine | ( | ) |
Gets the next line/batch of content from the stream
Implements QuantConnect.Interfaces.IStreamReader.
Definition at line 141 of file RemoteFileSubscriptionStreamReader.cs.
void QuantConnect.Lean.Engine.DataFeeds.Transport.RemoteFileSubscriptionStreamReader.Dispose | ( | ) |
Disposes of the stream
Definition at line 149 of file RemoteFileSubscriptionStreamReader.cs.
|
static |
Save reference to the download system.
downloader | Downloader provider for the remote file fetching. |
Definition at line 158 of file RemoteFileSubscriptionStreamReader.cs.
bool QuantConnect.Lean.Engine.DataFeeds.Transport.RemoteFileSubscriptionStreamReader.ShouldBeRateLimited => false |
Gets whether or not this stream reader should be rate limited
Definition at line 39 of file RemoteFileSubscriptionStreamReader.cs.
StreamReader QuantConnect.Lean.Engine.DataFeeds.Transport.RemoteFileSubscriptionStreamReader.StreamReader => _streamReader.StreamReader |
Direct access to the StreamReader instance
Definition at line 44 of file RemoteFileSubscriptionStreamReader.cs.
|
get |
The local file name of the downloaded file
Definition at line 49 of file RemoteFileSubscriptionStreamReader.cs.
|
get |
Gets SubscriptionTransportMedium.RemoteFile
Definition at line 126 of file RemoteFileSubscriptionStreamReader.cs.
|
get |
Gets whether or not there's more data to be read in the stream
Definition at line 134 of file RemoteFileSubscriptionStreamReader.cs.