dxFeed .Net API  7.1.0
dxFeed .Net API library intended to provide market data access for DX clients
com.dxfeed.native.NativeSnapshotSubscription Class Reference

Class provides native snapshot subscription More...

Inheritance diagram for com.dxfeed.native.NativeSnapshotSubscription:
[legend]
Collaboration diagram for com.dxfeed.native.NativeSnapshotSubscription:
[legend]

Public Member Functions

 NativeSnapshotSubscription (NativeConnection connection, long time, IDxSnapshotListener listener)
 Creates the new native order or candle subscription on snapshot. More...
 
 NativeSnapshotSubscription (NativeConnection connection, EventType eventType, long time, IDxSnapshotListener listener)
 Creates the new native snapshot subscription with specified event type. More...
 
void Dispose ()
 Disposes the native snapshot subscription More...
 
void AddSymbol (string symbol)
 Adds a symbol to the subscription. More...
 
void AddSymbol (CandleSymbol symbol)
 Adds a candle symbol to the subscription. More...
 
void AddSymbols (params string[] symbols)
 Adds symbols to the subscription. More...
 
void AddSymbols (params CandleSymbol[] symbols)
 Adds candle symbols to the subscription. More...
 
void RemoveSymbols (params string[] symbols)
 
void RemoveSymbols (params CandleSymbol[] symbols)
 
void SetSymbols (params string[] symbols)
 Sets symbols to the subscription. More...
 
void SetSymbols (params CandleSymbol[] symbols)
 Sets multiple symbols to the subscription. More...
 
void Clear ()
 
IList< string > GetSymbols ()
 Returns all symbols of the subscription. More...
 
void AddSource (params string[] sources)
 Adds com.dxfeed.api.events.OrderSource to subscription. More...
 
void SetSource (params string[] sources)
 Removes existing com.dxfeed.api.events.OrderSource from subscription and set new. More...
 

Static Public Attributes

static IntPtr InvalidSnapshot = IntPtr.Zero
 Invalid snapshot More...
 

Properties

string Symbol [get]
 Get symbol of snapshot More...
 

Detailed Description

Class provides native snapshot subscription

Constructor & Destructor Documentation

◆ NativeSnapshotSubscription() [1/2]

com.dxfeed.native.NativeSnapshotSubscription.NativeSnapshotSubscription ( NativeConnection  connection,
long  time,
IDxSnapshotListener  listener 
)
inline

Creates the new native order or candle subscription on snapshot.

Don't call this constructor inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
connectionNative connection pointer.
timeMilliseconds time in the past.
listenerSnapshot events listener.
Exceptions
ArgumentNullExceptionListener is invalid.

◆ NativeSnapshotSubscription() [2/2]

com.dxfeed.native.NativeSnapshotSubscription.NativeSnapshotSubscription ( NativeConnection  connection,
EventType  eventType,
long  time,
IDxSnapshotListener  listener 
)
inline

Creates the new native snapshot subscription with specified event type.

Don't call this constructor inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
connectionNative connection pointer.
eventTypeSingle event type.
timeMilliseconds time in the past.
listenerSnapshot events listener.
Exceptions
ArgumentNullExceptionListener is invalid.

Member Function Documentation

◆ AddSource()

void com.dxfeed.native.NativeSnapshotSubscription.AddSource ( params string []  sources)
inline

Adds com.dxfeed.api.events.OrderSource to subscription.

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
sourcesList of com.dxfeed.api.events.OrderSource names.
Exceptions
ArgumentExceptionInvalid sources parameter.
InvalidOperationExceptionYou try to add more than one source to subscription.
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ AddSymbol() [1/2]

void com.dxfeed.native.NativeSnapshotSubscription.AddSymbol ( string  symbol)
inline

Adds a symbol to the subscription.

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
symbolSymbol.
Exceptions
ArgumentExceptionInvalid symbol parameter.
InvalidOperationExceptionYou try to add more than one symbol to snapshot subscription.
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ AddSymbol() [2/2]

void com.dxfeed.native.NativeSnapshotSubscription.AddSymbol ( CandleSymbol  symbol)
inline

Adds a candle symbol to the subscription.

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
symbolCandleSymbol.
Exceptions
ArgumentExceptionInvalid symbol parameter.
InvalidOperationExceptionYou try to add more than one symbol to snapshot subscription.
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ AddSymbols() [1/2]

void com.dxfeed.native.NativeSnapshotSubscription.AddSymbols ( params string []  symbols)
inline

Adds symbols to the subscription.

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
symbolsList of symbols.
Exceptions
ArgumentExceptionInvalid symbols parameter.
InvalidOperationExceptionYou try to add more than one symbol to snapshot subscription.
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ AddSymbols() [2/2]

void com.dxfeed.native.NativeSnapshotSubscription.AddSymbols ( params CandleSymbol []  symbols)
inline

Adds candle symbols to the subscription.

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
symbolsList of CandleSymbol.
Exceptions
ArgumentExceptionInvalid symbols parameter.
InvalidOperationExceptionYou try to add more than one symbol to snapshot subscription.
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ Clear()

void com.dxfeed.native.NativeSnapshotSubscription.Clear ( )
inline

Clear all symbols from the subscription.

Snapshot will be IDisposable.Dispose().

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Exceptions
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ Dispose()

void com.dxfeed.native.NativeSnapshotSubscription.Dispose ( )
inline

Disposes the native snapshot subscription

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

◆ GetSymbols()

IList<string> com.dxfeed.native.NativeSnapshotSubscription.GetSymbols ( )
inline

Returns all symbols of the subscription.

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Returns
List of subscribed symbols.
Exceptions
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ RemoveSymbols() [1/2]

void com.dxfeed.native.NativeSnapshotSubscription.RemoveSymbols ( params string []  symbols)
inline

Removes symbols from the subscription.

Snapshot will be disposed if symbols contains snapshot symbol (for Snapshots only).

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
symbolsList of symbols.
Exceptions
ArgumentExceptionInvalid symbols parameter.
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ RemoveSymbols() [2/2]

void com.dxfeed.native.NativeSnapshotSubscription.RemoveSymbols ( params CandleSymbol []  symbols)
inline

Removes symbols from the subscription.

Snapshot will be disposed if symbols contains snapshot symbol (for Snapshots only).

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
symbolsList of CandleSymbol.
Exceptions
ArgumentExceptionInvalid symbols parameter.
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ SetSource()

void com.dxfeed.native.NativeSnapshotSubscription.SetSource ( params string []  sources)
inline

Removes existing com.dxfeed.api.events.OrderSource from subscription and set new.

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
sourcesList of com.dxfeed.api.events.OrderSource names.
Exceptions
ArgumentExceptionInvalid sources parameter.
InvalidOperationExceptionYou try to add more than one source to subscription.
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ SetSymbols() [1/2]

void com.dxfeed.native.NativeSnapshotSubscription.SetSymbols ( params string []  symbols)
inline

Sets symbols to the subscription.

Parameters
symbolsList of symbols.

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Exceptions
ArgumentExceptionInvalid symbols parameter.
InvalidOperationExceptionYou try to add more than one symbol to snapshot subscription.
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

◆ SetSymbols() [2/2]

void com.dxfeed.native.NativeSnapshotSubscription.SetSymbols ( params CandleSymbol []  symbols)
inline

Sets multiple symbols to the subscription.

Don't call this method inside any listeners and callbacks of NativeSubscription, NativeConnection, NativeRegionalBook, NativeSnapshotSubscription classes

Parameters
symbolsList of CandleSymbol.
Exceptions
ArgumentExceptionInvalid symbols parameter.
InvalidOperationExceptionYou try to add more than one symbol to snapshot subscription.
DxExceptionInternal error.

Implements com.dxfeed.api.IDxSubscription.

Field Documentation

◆ InvalidSnapshot

IntPtr com.dxfeed.native.NativeSnapshotSubscription.InvalidSnapshot = IntPtr.Zero
static

Invalid snapshot

Property Documentation

◆ Symbol

string com.dxfeed.native.NativeSnapshotSubscription.Symbol
get

Get symbol of snapshot


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