dxFeed .Net API  7.1.0
dxFeed .Net API library intended to provide market data access for DX clients
com.dxfeed.ipf.impl.InstrumentProfileComposer Class Reference

Composer for Instrument Profile Simple File Format. Please see Instrument Profile Format documentation for complete description. More...

Inheritance diagram for com.dxfeed.ipf.impl.InstrumentProfileComposer:
[legend]
Collaboration diagram for com.dxfeed.ipf.impl.InstrumentProfileComposer:
[legend]

Public Member Functions

 InstrumentProfileComposer (Stream outStream)
 Creates a new instrument profile composer. More...
 
void Dispose ()
 Dispose object. More...
 
void Compose (IList< InstrumentProfile > profiles, bool skipRemoved)
 Atomically captures profile types to work correctly when profile type is being changed concurrently, otherwise, the method is not thread-safe. More...
 
void ComposeNewLine ()
 Writes a new line. More...
 
void ComposeFlush ()
 Writes FLUSH command More...
 
void ComposeComplete ()
 Writes COMPLETE command. More...
 

Detailed Description

Composer for Instrument Profile Simple File Format. Please see Instrument Profile Format documentation for complete description.

Constructor & Destructor Documentation

◆ InstrumentProfileComposer()

com.dxfeed.ipf.impl.InstrumentProfileComposer.InstrumentProfileComposer ( Stream  outStream)
inline

Creates a new instrument profile composer.

Parameters
outStream
Exceptions
System.ArgumentNullException
System.ArgumentException

Member Function Documentation

◆ Compose()

void com.dxfeed.ipf.impl.InstrumentProfileComposer.Compose ( IList< InstrumentProfile profiles,
bool  skipRemoved 
)
inline

Atomically captures profile types to work correctly when profile type is being changed concurrently, otherwise, the method is not thread-safe.

Parameters
profilesList of instrument profiles.
skipRemovedWhen skipRemoved == true, it ignores removed instruments when composing.
Exceptions
System.ArgumentExceptionIf attempt to write record without fields was made.
System.IO.IOExceptionIf an I/O error occurs.
System.InvalidOperationExceptionCan't format certain profile.

◆ ComposeComplete()

void com.dxfeed.ipf.impl.InstrumentProfileComposer.ComposeComplete ( )
inline

Writes COMPLETE command.

Exceptions
System.ArgumentExceptionIf attempt to write record without fields was made.
System.IO.IOExceptionIf an I/O error occurs.

◆ ComposeFlush()

void com.dxfeed.ipf.impl.InstrumentProfileComposer.ComposeFlush ( )
inline

Writes FLUSH command

Exceptions
System.ArgumentExceptionIf attempt to write record without fields was made.
System.IO.IOExceptionIf an I/O error occurs.

◆ ComposeNewLine()

void com.dxfeed.ipf.impl.InstrumentProfileComposer.ComposeNewLine ( )
inline

Writes a new line.

Exceptions
System.ArgumentExceptionIf attempt to write record without fields was made.
System.IO.IOExceptionIf an I/O error occurs.

◆ Dispose()

void com.dxfeed.ipf.impl.InstrumentProfileComposer.Dispose ( )
inline

Dispose object.

Exceptions
System.IO.IOExceptionIf an I/O error occurs.

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