dxFeed .Net API  7.1.0
dxFeed .Net API library intended to provide market data access for DX clients
com.dxfeed.api.IDxSubscription Interface Reference

Interface provides operation with subscription parameters. More...

Inheritance diagram for com.dxfeed.api.IDxSubscription:
[legend]
Collaboration diagram for com.dxfeed.api.IDxSubscription:
[legend]

Public Member Functions

void AddSymbol (string symbol)
 Add symbol to subscription. More...
 
void AddSymbol (CandleSymbol symbol)
 Add candle symbol to subscription. More...
 
void AddSymbols (params string[] symbols)
 Add multiply symbols to subscription. More...
 
void AddSymbols (params CandleSymbol[] symbols)
 Add multiply candle symbols to subscription. More...
 
void RemoveSymbols (params string[] symbols)
 
void RemoveSymbols (params CandleSymbol[] symbols)
 
void SetSymbols (params string[] symbols)
 Set multiply symbols to subscription. More...
 
void SetSymbols (params CandleSymbol[] symbols)
 Set multiply symbols to subscription. More...
 
void Clear ()
 
IList< string > GetSymbols ()
 Get all symbols from subscription. More...
 
void AddSource (params string[] sources)
 Add events.OrderSource to subscription. More...
 
void SetSource (params string[] sources)
 Remove existing events.OrderSource from subscription and set new. More...
 

Detailed Description

Interface provides operation with subscription parameters.

Member Function Documentation

◆ AddSource()

void com.dxfeed.api.IDxSubscription.AddSource ( params string []  sources)

Add events.OrderSource to subscription.

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

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ AddSymbol() [1/2]

void com.dxfeed.api.IDxSubscription.AddSymbol ( string  symbol)

Add symbol to subscription.

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

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ AddSymbol() [2/2]

void com.dxfeed.api.IDxSubscription.AddSymbol ( CandleSymbol  symbol)

Add candle symbol to subscription.

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

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ AddSymbols() [1/2]

void com.dxfeed.api.IDxSubscription.AddSymbols ( params string []  symbols)

Add multiply symbols to subscription.

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

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ AddSymbols() [2/2]

void com.dxfeed.api.IDxSubscription.AddSymbols ( params CandleSymbol []  symbols)

Add multiply candle symbols to subscription.

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

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ Clear()

void com.dxfeed.api.IDxSubscription.Clear ( )

Clear all symbols from subscription.

Snapshot will be IDisposable.Dispose().

Exceptions
DxExceptionInternal error.

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ GetSymbols()

IList<string> com.dxfeed.api.IDxSubscription.GetSymbols ( )

Get all symbols from subscription.

Returns
List of subscribed symbols.
Exceptions
DxExceptionInternal error.

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ RemoveSymbols() [1/2]

void com.dxfeed.api.IDxSubscription.RemoveSymbols ( params string []  symbols)

Remove multiply symbols from subscription.

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

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

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ RemoveSymbols() [2/2]

void com.dxfeed.api.IDxSubscription.RemoveSymbols ( params CandleSymbol []  symbols)

Remove multiply symbols from subscription.

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

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

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ SetSource()

void com.dxfeed.api.IDxSubscription.SetSource ( params string []  sources)

Remove existing events.OrderSource from subscription and set new.

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

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ SetSymbols() [1/2]

void com.dxfeed.api.IDxSubscription.SetSymbols ( params string []  symbols)

Set multiply symbols to subscription.

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

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.

◆ SetSymbols() [2/2]

void com.dxfeed.api.IDxSubscription.SetSymbols ( params CandleSymbol []  symbols)

Set multiply symbols to subscription.

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

Implemented in com.dxfeed.native.NativeSubscription, com.dxfeed.native.NativeSnapshotSubscription, and com.dxfeed.native.OrderViewSubscription.


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