Represents a stream reader capable of reading lines from the object store More...
Public Member Functions | |
| ObjectStoreSubscriptionStreamReader (IObjectStore objectStore, string key) | |
| Initializes a new instance of the ObjectStoreSubscriptionStreamReader class. More... | |
| string | ReadLine () |
| Gets the next line/batch of content from the stream More... | |
| void | Dispose () |
| Disposes of the stream More... | |
Public Attributes | |
| bool | ShouldBeRateLimited => false |
| Gets whether or not this stream reader should be rate limited More... | |
Properties | |
| StreamReader | StreamReader [get] |
| Direct access to the StreamReader instance More... | |
| SubscriptionTransportMedium | TransportMedium [get] |
| Gets SubscriptionTransportMedium.LocalFile 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... | |
Detailed Description
Represents a stream reader capable of reading lines from the object store
Definition at line 28 of file ObjectStoreSubscriptionStreamReader.cs.
Constructor & Destructor Documentation
◆ ObjectStoreSubscriptionStreamReader()
| QuantConnect.Lean.Engine.DataFeeds.Transport.ObjectStoreSubscriptionStreamReader.ObjectStoreSubscriptionStreamReader | ( | IObjectStore | objectStore, |
| string | key | ||
| ) |
Initializes a new instance of the ObjectStoreSubscriptionStreamReader class.
- Parameters
-
objectStore The IObjectStore used to retrieve a stream of data key The object store key the data should be fetched from
Definition at line 78 of file ObjectStoreSubscriptionStreamReader.cs.
Member Function Documentation
◆ ReadLine()
| string QuantConnect.Lean.Engine.DataFeeds.Transport.ObjectStoreSubscriptionStreamReader.ReadLine | ( | ) |
Gets the next line/batch of content from the stream
Implements QuantConnect.Interfaces.IStreamReader.
Definition at line 103 of file ObjectStoreSubscriptionStreamReader.cs.
◆ Dispose()
| void QuantConnect.Lean.Engine.DataFeeds.Transport.ObjectStoreSubscriptionStreamReader.Dispose | ( | ) |
Disposes of the stream
Definition at line 111 of file ObjectStoreSubscriptionStreamReader.cs.
Member Data Documentation
◆ ShouldBeRateLimited
| bool QuantConnect.Lean.Engine.DataFeeds.Transport.ObjectStoreSubscriptionStreamReader.ShouldBeRateLimited => false |
Gets whether or not this stream reader should be rate limited
Definition at line 37 of file ObjectStoreSubscriptionStreamReader.cs.
Property Documentation
◆ StreamReader
|
get |
Direct access to the StreamReader instance
Definition at line 43 of file ObjectStoreSubscriptionStreamReader.cs.
◆ TransportMedium
|
get |
Gets SubscriptionTransportMedium.LocalFile
Definition at line 88 of file ObjectStoreSubscriptionStreamReader.cs.
◆ EndOfStream
|
get |
Gets whether or not there's more data to be read in the stream
Definition at line 96 of file ObjectStoreSubscriptionStreamReader.cs.
The documentation for this class was generated from the following file:
- Engine/DataFeeds/Transport/ObjectStoreSubscriptionStreamReader.cs
