dxFeed .Net API
5.13.0
dxFeed .Net API library intended to provide market data access for DX clients
|
Manages network connections to DXFeed. More...
Public Member Functions | |
IDXEndpoint | User (string user) |
Changes user name for this endpoint. This method shall be called before Connect(string) together with Password(string) to configure service access credentials. More... | |
IDXEndpoint | Password (string password) |
Changes password for this endpoint. This method shall be called before Connect(string) together with User(string) to configure service access credentials. More... | |
IDXEndpoint | Connect (string address) |
void | Disconnect () |
void | Close () |
ISet< Type > | GetEventTypes () |
Returns a set of all event types supported by this endpoint. The resulting set cannot be modified. More... | |
Properties | |
DXEndpointState | State [get] |
Thread-safe state getter of this endpoint. More... | |
IDXFeed | Feed [get] |
Returns feed that is associated with this endpoint. More... | |
Events | |
OnEndpointClosingEventHandler | OnClosing |
Event fires when Close() method was called. More... | |
Manages network connections to DXFeed.
void com.dxfeed.api.IDXEndpoint.Close | ( | ) |
Closes this endpoint. All network connection are terminated as with Disconnect() method and no further connections can be established.
The endpoint State immediately becomes DXEndpointState.Closed. All resources associated with this endpoint are released.
Implemented in com.dxfeed.api.DXEndpoint.
IDXEndpoint com.dxfeed.api.IDXEndpoint.Connect | ( | string | address | ) |
Connects to the specified remove address. Previously established connections are closed if the new address is different from the old one. This method does nothing if address does not change or if this endpoint is DXEndpointState.Closed. The endpoint State immediately becomes DXEndpointState.Connecting otherwise.
The address string is provided with the market data vendor agreement. Use "demo.dxfeed.com:7300" for a demo quote feed.
The simplest address strings have the following format: |
---|
host:port to establish a TCP/IP connection |
:port to listen for a TCP/IP connection with a plain socket connector (good for up to a few hundred of connections). |
For premium services access credentials must be configured before invocation of Connect
method using User(string) and Password(string) methods.
address | The data source address. |
ArgumentNullException | If address is null. |
Implemented in com.dxfeed.api.DXEndpoint.
void com.dxfeed.api.IDXEndpoint.Disconnect | ( | ) |
Terminates all remote network connections. This method does nothing if this endpoint is DXEndpointState.Closed. The endpoint State immediately becomes DXEndpointState.NotConnected otherwise.
This method does not release all resources that are associated with this endpoint. Use Close() method to release all resources.
Implemented in com.dxfeed.api.DXEndpoint.
ISet<Type> com.dxfeed.api.IDXEndpoint.GetEventTypes | ( | ) |
Returns a set of all event types supported by this endpoint. The resulting set cannot be modified.
Implemented in com.dxfeed.api.DXEndpoint.
IDXEndpoint com.dxfeed.api.IDXEndpoint.Password | ( | string | password | ) |
Changes password for this endpoint. This method shall be called before Connect(string) together with User(string) to configure service access credentials.
password | Password |
ArgumentNullException | If password is null. |
Implemented in com.dxfeed.api.DXEndpoint.
IDXEndpoint com.dxfeed.api.IDXEndpoint.User | ( | string | user | ) |
Changes user name for this endpoint. This method shall be called before Connect(string) together with Password(string) to configure service access credentials.
user | User name. |
ArgumentNullException | If user is null. |
Implemented in com.dxfeed.api.DXEndpoint.
|
get |
Returns feed that is associated with this endpoint.
|
get |
Thread-safe state getter of this endpoint.
OnEndpointClosingEventHandler com.dxfeed.api.IDXEndpoint.OnClosing |
Event fires when Close() method was called.