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

Interface provides operations with event subscription More...

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

Public Member Functions

void Disconnect ()
 Disconnect from the server More...
 
IDxSubscription CreateSubscription (EventType type, IDxEventListener listener)
 Create event subscription. More...
 
IDxSubscription CreateSubscription (DateTime? time, IDxCandleListener listener)
 Create candle event subscription More...
 
IDxSubscription CreateSubscription (EventType type, long time, IDxEventListener listener)
 Create time event subscription. More...
 
IDxSubscription CreateSubscription (EventType type, DateTime? time, IDxEventListener listener)
 Create time event subscription. More...
 
IDxSubscription CreateSnapshotSubscription (Int64 time, IDxSnapshotListener listener)
 Creates snapshot subscription More...
 
IDxSubscription CreateSnapshotSubscription (DateTime? time, IDxSnapshotListener listener)
 Creates snapshot subscription More...
 
IDxSubscription CreateSnapshotSubscription (EventType eventType, Int64 time, IDxSnapshotListener listener)
 Creates snapshot subscription More...
 
IDxSubscription CreateSnapshotSubscription (EventType eventType, DateTime? time, IDxSnapshotListener listener)
 Creates snapshot subscription More...
 
IDxSubscription CreateOrderViewSubscription (IDxOrderViewListener listener)
 Creates Order View subscription More...
 
IDxRegionalBook CreateRegionalBook (string symbol, IDxRegionalBookListener book_listener, IDxQuoteListener quote_listener)
 Creates regional book More...
 
void WriteRawData (string rawFileName)
 Add dumping raw data of incoming traffic of connection into specific file More...
 

Properties

IDictionary< string, string > Properties [get]
 Retrieves properties for specified connection. Properties can be changed during reconnection. So returned array is a snapshot of properties at the moment of the call. More...
 
string ConnectedAddress [get]
 Retrieves string with current connected address in format <host>:<port>. If return value is NULL then connection is not connected (reconnection, no valid addresses, closed connection and others). More...
 
ConnectionStatus Status [get]
 Retrieves the current connection status More...
 

Detailed Description

Interface provides operations with event subscription

Member Function Documentation

◆ CreateOrderViewSubscription()

IDxSubscription com.dxfeed.api.IDxConnection.CreateOrderViewSubscription ( IDxOrderViewListener  listener)

Creates Order View subscription

Parameters
listener
Returns

Implemented in com.dxfeed.native.NativeConnection.

◆ CreateRegionalBook()

IDxRegionalBook com.dxfeed.api.IDxConnection.CreateRegionalBook ( string  symbol,
IDxRegionalBookListener  book_listener,
IDxQuoteListener  quote_listener 
)

Creates regional book

Parameters
symbolSingle symbol name
book_listenerRegional book changes listener. Null is allowed.
quote_listenerQuotes listener. Null is allowed.
Returns
regional book object

Implemented in com.dxfeed.native.NativeConnection.

◆ CreateSnapshotSubscription() [1/4]

IDxSubscription com.dxfeed.api.IDxConnection.CreateSnapshotSubscription ( Int64  time,
IDxSnapshotListener  listener 
)

Creates snapshot subscription

Parameters
timeTime in the past - number of milliseconds from 1.1.1970 (unix time)
listener
Returns

◆ CreateSnapshotSubscription() [2/4]

IDxSubscription com.dxfeed.api.IDxConnection.CreateSnapshotSubscription ( DateTime?  time,
IDxSnapshotListener  listener 
)

Creates snapshot subscription

Parameters
timeDate time in the past
listener
Returns

Implemented in com.dxfeed.native.NativeConnection.

◆ CreateSnapshotSubscription() [3/4]

IDxSubscription com.dxfeed.api.IDxConnection.CreateSnapshotSubscription ( EventType  eventType,
Int64  time,
IDxSnapshotListener  listener 
)

Creates snapshot subscription

Parameters
eventTypeSingle event type.
timeTime in the past - number of milliseconds from 1.1.1970 (unix time)
listenersnapshot listener callback
Returns
subscription object
Exceptions
DxException

◆ CreateSnapshotSubscription() [4/4]

IDxSubscription com.dxfeed.api.IDxConnection.CreateSnapshotSubscription ( EventType  eventType,
DateTime?  time,
IDxSnapshotListener  listener 
)

Creates snapshot subscription

Parameters
eventTypeSingle event type.
timeDate time in the past
listenersnapshot listener callback
Returns
subscription object
Exceptions
DxException

Implemented in com.dxfeed.native.NativeConnection.

◆ CreateSubscription() [1/4]

IDxSubscription com.dxfeed.api.IDxConnection.CreateSubscription ( EventType  type,
IDxEventListener  listener 
)

Create event subscription.

Parameters
typeEvent type.
listenerEvent listener callback.
Returns
Subscription object.
Exceptions
ArgumentNullExceptionListener is null.
DxException

Implemented in com.dxfeed.native.NativeConnection.

◆ CreateSubscription() [2/4]

IDxSubscription com.dxfeed.api.IDxConnection.CreateSubscription ( DateTime?  time,
IDxCandleListener  listener 
)

Create candle event subscription

Parameters
timedate time in the past
listenercandle listener callback
Returns
Subscription object.
Exceptions
ArgumentNullExceptionListener is null.
DxException

Implemented in com.dxfeed.native.NativeConnection.

◆ CreateSubscription() [3/4]

IDxSubscription com.dxfeed.api.IDxConnection.CreateSubscription ( EventType  type,
long  time,
IDxEventListener  listener 
)

Create time event subscription.

Parameters
typeEvent type.
timeUnix time stamp (the number of milliseconds from 1.1.1970)
listenerEvent listener callback.
Returns
Subscription object.
Exceptions
ArgumentNullExceptionListener is null.
DxException

Implemented in com.dxfeed.native.NativeConnection.

◆ CreateSubscription() [4/4]

IDxSubscription com.dxfeed.api.IDxConnection.CreateSubscription ( EventType  type,
DateTime?  time,
IDxEventListener  listener 
)

Create time event subscription.

Parameters
typeEvent type.
timeDate time in the past.
listenerEvent listener callback.
Returns
Subscription object.
Exceptions
ArgumentNullExceptionListener is null.
DxException

Implemented in com.dxfeed.native.NativeConnection.

◆ Disconnect()

void com.dxfeed.api.IDxConnection.Disconnect ( )

Disconnect from the server

Implemented in com.dxfeed.native.NativeConnection.

◆ WriteRawData()

void com.dxfeed.api.IDxConnection.WriteRawData ( string  rawFileName)

Add dumping raw data of incoming traffic of connection into specific file

Parameters
rawFileNamefile name for raw data
Exceptions
ArgumentExceptionInvalid argument rawFileName
NativeDxException

Implemented in com.dxfeed.native.NativeConnection.

Property Documentation

◆ ConnectedAddress

string com.dxfeed.api.IDxConnection.ConnectedAddress
get

Retrieves string with current connected address in format <host>:<port>. If return value is NULL then connection is not connected (reconnection, no valid addresses, closed connection and others).

◆ Properties

IDictionary<string, string> com.dxfeed.api.IDxConnection.Properties
get

Retrieves properties for specified connection. Properties can be changed during reconnection. So returned array is a snapshot of properties at the moment of the call.

◆ Status

ConnectionStatus com.dxfeed.api.IDxConnection.Status
get

Retrieves the current connection status


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