Reads instrument profiles from the stream using Simple File Format. Please see Instrument Profile Format documentation for complete description. This reader automatically uses data formats as specified in the stream. Use InstrumentProfileConnection if support for streaming updates of instrument profiles is needed.
More...
|
DateTime | GetLastModified () |
| Returns last modification time (in milliseconds) from last ReadFromFile operation or zero if it is unknown. More...
|
|
IList< InstrumentProfile > | ReadFromFile (string address) |
| Reads and returns instrument profiles from specified file. This method recognizes popular data compression formats "zip" and "gzip" by analyzing file name. If file name ends with ".zip" then all compressed files will be read independently one by one in their order of appearing and total concatenated list of instrument profiles will be returned. If file name ends with ".gz" then compressed content will be read and returned. In other cases file will be considered uncompressed and will be read as is. More...
|
|
IList< InstrumentProfile > | ReadFromFile (string address, string user, string password) |
| Reads and returns instrument profiles from specified address with a specified basic user and password credentials. This method recognizes popular data compression formats "zip" and "gzip" by analyzing file name. If file name ends with ".zip" then all compressed files will be read independently one by one in their order of appearing and total concatenated list of instrument profiles will be returned. If file name ends with ".gz" then compressed content will be read and returned. In other cases file will be considered uncompressed and will be read as is. More...
|
|
IList< InstrumentProfile > | Read (Stream inputStream, string name) |
| Reads and returns instrument profiles from specified stream using specified name to select data compression format. This method recognizes popular data compression formats "zip" and "gzip" by analyzing file name. If file name ends with ".zip" then all compressed files will be read independently one by one in their order of appearing and total concatenated list of instrument profiles will be returned. If file name ends with ".gz" then compressed content will be read and returned. In other cases file will be considered uncompressed and will be read as is. More...
|
|
IList< InstrumentProfile > | Read (Stream inputStream) |
| Reads and returns instrument profiles from specified stream. More...
|
|
|
static string | ResolveSourceUrl (string address) |
| Converts a specified string address specification into an URL that will be read by ReadFromFile method using URLInputStream. More...
|
|
Reads instrument profiles from the stream using Simple File Format. Please see Instrument Profile Format documentation for complete description. This reader automatically uses data formats as specified in the stream. Use InstrumentProfileConnection if support for streaming updates of instrument profiles is needed.
◆ GetLastModified()
DateTime com.dxfeed.ipf.InstrumentProfileReader.GetLastModified |
( |
| ) |
|
|
inline |
Returns last modification time (in milliseconds) from last ReadFromFile operation or zero if it is unknown.
- Returns
- Last modification time (in milliseconds)
◆ Read() [1/2]
IList<InstrumentProfile> com.dxfeed.ipf.InstrumentProfileReader.Read |
( |
Stream |
inputStream, |
|
|
string |
name |
|
) |
| |
|
inline |
Reads and returns instrument profiles from specified stream using specified name to select data compression format. This method recognizes popular data compression formats "zip" and "gzip" by analyzing file name. If file name ends with ".zip" then all compressed files will be read independently one by one in their order of appearing and total concatenated list of instrument profiles will be returned. If file name ends with ".gz" then compressed content will be read and returned. In other cases file will be considered uncompressed and will be read as is.
- Parameters
-
inputStream | Stream from which read profiles. |
name | Profile name. |
- Returns
- Instrument profile list.
- Exceptions
-
ArgumentException | Stream does not support reading. |
ArgumentNullException | Stream is null. |
IOException | If an I/O error occurs. |
InstrumentProfileFormatException | If input stream does not conform to the Simple File Format. |
◆ Read() [2/2]
IList<InstrumentProfile> com.dxfeed.ipf.InstrumentProfileReader.Read |
( |
Stream |
inputStream | ) |
|
|
inline |
Reads and returns instrument profiles from specified stream.
- Parameters
-
inputStream | Stream from which read profiles. |
- Returns
- Instrument profiles from specified stream.
- Exceptions
-
ArgumentException | Stream does not support reading. |
ArgumentNullException | Stream is null. |
IOException | If an I/O error occurs. |
InstrumentProfileFormatException | If input stream does not conform to the Simple File Format. |
◆ ReadFromFile() [1/2]
IList<InstrumentProfile> com.dxfeed.ipf.InstrumentProfileReader.ReadFromFile |
( |
string |
address | ) |
|
|
inline |
Reads and returns instrument profiles from specified file. This method recognizes popular data compression formats "zip" and "gzip" by analyzing file name. If file name ends with ".zip" then all compressed files will be read independently one by one in their order of appearing and total concatenated list of instrument profiles will be returned. If file name ends with ".gz" then compressed content will be read and returned. In other cases file will be considered uncompressed and will be read as is.
Authentication information can be supplied to this method as part of URL user info like "http://user:password@host:port/path/file.ipf".
This is a shortcut for ReadFromFile(address, null, null).
This operation updates GetLastModified().
- Parameters
-
address | URL of file to read from. |
- Returns
- List of instrument profiles.
- Exceptions
-
◆ ReadFromFile() [2/2]
IList<InstrumentProfile> com.dxfeed.ipf.InstrumentProfileReader.ReadFromFile |
( |
string |
address, |
|
|
string |
user, |
|
|
string |
password |
|
) |
| |
|
inline |
Reads and returns instrument profiles from specified address with a specified basic user and password credentials. This method recognizes popular data compression formats "zip" and "gzip" by analyzing file name. If file name ends with ".zip" then all compressed files will be read independently one by one in their order of appearing and total concatenated list of instrument profiles will be returned. If file name ends with ".gz" then compressed content will be read and returned. In other cases file will be considered uncompressed and will be read as is.
Specified user and password take precedence over authentication information that is supplied to this method as part of URL user info like "http://user:password@host:port/path/file.ipf".
This operation updates GetLastModified().
- Parameters
-
address | URL of file to read from. |
user | The user name (may be null). |
password | The password (may be null). |
- Returns
- List of instrument profiles.
- Exceptions
-
◆ ResolveSourceUrl()
static string com.dxfeed.ipf.InstrumentProfileReader.ResolveSourceUrl |
( |
string |
address | ) |
|
|
inlinestatic |
Converts a specified string address specification into an URL that will be read by ReadFromFile method using URLInputStream.
- Parameters
-
address | Address to convert. |
- Returns
- A new resolved URL.
◆ lastModified
DateTime com.dxfeed.ipf.InstrumentProfileReader.lastModified |
|
private |
The documentation for this class was generated from the following file: