dxFeed .Net API  5.13.0
dxFeed .Net API library intended to provide market data access for DX clients
Public Member Functions | Protected Member Functions | Properties | Private Member Functions | Private Attributes
com.dxfeed.api.DXFeedSnapshotCollector< E > Class Template Reference

More...

Inheritance diagram for com.dxfeed.api.DXFeedSnapshotCollector< E >:
[legend]
Collaboration diagram for com.dxfeed.api.DXFeedSnapshotCollector< E >:
[legend]

Public Member Functions

 DXFeedSnapshotCollector ()
 Default constructor. More...
 
void OnCandleSnapshot< TB, TE > (TB buf)
 On Candle snapshot event received. More...
 
void OnGreeksSnapshot< TB, TE > (TB buf)
 On Greeks snapshot event received. More...
 
void OnOrderSnapshot< TB, TE > (TB buf)
 On Order snapshot event received. More...
 
void OnSeriesSnapshot< TB, TE > (TB buf)
 On Series snapshot event received. More...
 
void OnSpreadOrderSnapshot< TB, TE > (TB buf)
 On SpreadOrder snapshot event received. More...
 
void OnTimeAndSaleSnapshot< TB, TE > (TB buf)
 On TimeAndSale snapshot event received. More...
 
void EventsReceived (IList< E > events)
 Invoked when events of type E are received. More...
 

Protected Member Functions

virtual IList< E > FilterEvents (IList< E > events)
 

Properties

bool IsDone [get]
 Returns true if collector contains full snapshot. More...
 
List< E > Events [get]
 Gets all collected events of this snapshot. More...
 

Private Member Functions

void AddSnapshot (IList< E > events)
 

Private Attributes

IList< E > events = new List<E>()
 
object eventsLock = new object()
 
volatile bool isDone = false
 

Detailed Description

Collector of snapshot events.

It is also listener of snapshot events that stores all events into list. Events are updated with snapshot. You can get events list at any time. This class supports only one snapshot.

Template Parameters
EThe event type.
Type Constraints
E :IDxEventType 

Constructor & Destructor Documentation

◆ DXFeedSnapshotCollector()

Default constructor.

Member Function Documentation

◆ AddSnapshot()

void com.dxfeed.api.DXFeedSnapshotCollector< E >.AddSnapshot ( IList< E >  events)
inlineprivate

◆ EventsReceived()

void com.dxfeed.api.DXFeedSnapshotCollector< E >.EventsReceived ( IList< E >  events)
inline

Invoked when events of type E are received.

Parameters
eventsThe list of received events.

Implements com.dxfeed.api.IDXFeedEventListener< E >.

◆ FilterEvents()

virtual IList<E> com.dxfeed.api.DXFeedSnapshotCollector< E >.FilterEvents ( IList< E >  events)
inlineprotectedvirtual

◆ OnCandleSnapshot< TB, TE >()

void com.dxfeed.api.DXFeedSnapshotCollector< E >.OnCandleSnapshot< TB, TE > ( TB  buf)
inline

On Candle snapshot event received.

Template Parameters
TBEvent buffer type.
TEEvent type.
Parameters
bufEvent buffer object.

Implements com.dxfeed.api.IDxCandleSnapshotListener.

Type Constraints
TB :IDxEventBuf<TE> 
TE :IDxCandle 

◆ OnGreeksSnapshot< TB, TE >()

void com.dxfeed.api.DXFeedSnapshotCollector< E >.OnGreeksSnapshot< TB, TE > ( TB  buf)
inline

On Greeks snapshot event received.

Template Parameters
TBEvent buffer type.
TEEvent type.
Parameters
bufEvent buffer object.

Implements com.dxfeed.api.IDxGreeksSnapshotListener.

Type Constraints
TB :IDxEventBuf<TE> 
TE :IDxGreeks 

◆ OnOrderSnapshot< TB, TE >()

void com.dxfeed.api.DXFeedSnapshotCollector< E >.OnOrderSnapshot< TB, TE > ( TB  buf)
inline

On Order snapshot event received.

Template Parameters
TBEvent buffer type.
TEEvent type.
Parameters
bufEvent buffer object.

Implements com.dxfeed.api.IDxOrderSnapshotListener.

Type Constraints
TB :IDxEventBuf<TE> 
TE :IDxOrder 

◆ OnSeriesSnapshot< TB, TE >()

void com.dxfeed.api.DXFeedSnapshotCollector< E >.OnSeriesSnapshot< TB, TE > ( TB  buf)
inline

On Series snapshot event received.

Template Parameters
TBEvent buffer type.
TEEvent type.
Parameters
bufEvent buffer object.

Implements com.dxfeed.api.IDxSeriesSnapshotListener.

Type Constraints
TB :IDxEventBuf<TE> 
TE :IDxSeries 

◆ OnSpreadOrderSnapshot< TB, TE >()

void com.dxfeed.api.DXFeedSnapshotCollector< E >.OnSpreadOrderSnapshot< TB, TE > ( TB  buf)
inline

On SpreadOrder snapshot event received.

Template Parameters
TBEvent buffer type.
TEEvent type.
Parameters
bufEvent buffer object.

Implements com.dxfeed.api.IDxSpreadOrderSnapshotListener.

Type Constraints
TB :IDxEventBuf<TE> 
TE :IDxSpreadOrder 

◆ OnTimeAndSaleSnapshot< TB, TE >()

void com.dxfeed.api.DXFeedSnapshotCollector< E >.OnTimeAndSaleSnapshot< TB, TE > ( TB  buf)
inline

On TimeAndSale snapshot event received.

Template Parameters
TBEvent buffer type.
TEEvent type.
Parameters
bufEvent buffer object.

Implements com.dxfeed.api.IDxTimeAndSaleSnapshotListener.

Type Constraints
TB :IDxEventBuf<TE> 
TE :IDxTimeAndSale 

Field Documentation

◆ events

IList<E> com.dxfeed.api.DXFeedSnapshotCollector< E >.events = new List<E>()
private

◆ eventsLock

object com.dxfeed.api.DXFeedSnapshotCollector< E >.eventsLock = new object()
private

◆ isDone

volatile bool com.dxfeed.api.DXFeedSnapshotCollector< E >.isDone = false
private

Property Documentation

◆ Events

List<E> com.dxfeed.api.DXFeedSnapshotCollector< E >.Events
get

Gets all collected events of this snapshot.

◆ IsDone

Returns true if collector contains full snapshot.


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