Lean  $LEAN_TAG$
QuantConnect.Interfaces.IStreamReader Interface Reference

Defines a transport mechanism for data from its source into various reader methods More...

Inheritance diagram for QuantConnect.Interfaces.IStreamReader:
[legend]

Public Member Functions

string ReadLine ()
 Gets the next line/batch of content from the stream More...
 

Properties

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

Defines a transport mechanism for data from its source into various reader methods

Definition at line 25 of file IStreamReader.cs.

Member Function Documentation

◆ ReadLine()

string QuantConnect.Interfaces.IStreamReader.ReadLine ( )

Gets the next line/batch of content from the stream

Implemented in QuantConnect.Lean.Engine.DataFeeds.Transport.RemoteFileSubscriptionStreamReader, QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader, QuantConnect.Lean.Engine.DataFeeds.Transport.ObjectStoreSubscriptionStreamReader, and QuantConnect.Lean.Engine.DataFeeds.Transport.RestSubscriptionStreamReader.

Here is the caller graph for this function:

Property Documentation

◆ TransportMedium

SubscriptionTransportMedium QuantConnect.Interfaces.IStreamReader.TransportMedium
get

Gets the transport medium of this stream reader

Definition at line 30 of file IStreamReader.cs.

◆ EndOfStream

bool QuantConnect.Interfaces.IStreamReader.EndOfStream
get

Gets whether or not there's more data to be read in the stream

Definition at line 35 of file IStreamReader.cs.

◆ StreamReader

StreamReader QuantConnect.Interfaces.IStreamReader.StreamReader
get

Direct access to the StreamReader instance

Definition at line 45 of file IStreamReader.cs.

◆ ShouldBeRateLimited

bool QuantConnect.Interfaces.IStreamReader.ShouldBeRateLimited
get

Gets whether or not this stream reader should be rate limited

Definition at line 50 of file IStreamReader.cs.


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