The latest version of connectivity configuration files available here.
All public constructors of OnixS::ICE::iMpact::MarketData::Handler
accepts the path to the connectivity configuration file as primary parameter. This file contains definitions of multicast groups and network addresses of corresponding servers to which the Handler have to connect to receive market data.
There are three major sections which make up the configuration: TCP connection information, Multicast groups, and Market types.
The Handler supports automatic reconnect for TCP connections and provides the following settings:
reconnectTimeoutInSeconds
- in case of reconnect this timeout in second will be used to delay the next connection. This is because ICE enforces new connections to be established minimum after 15 seconds of the last successful connection.maximumNumberOfReconnectAttempts
- maximum number of reconnect attempts. If you want to reconnect until the connection is established please use -1
. If you don't want to reconnect at all, please use 0
.The settings above can be specified in the connectivity configuration:
Also, you can use the API and set desired values using OnixS::ICE::iMpact::MarketData::TcpSettings::reconnectTimeoutInSeconds
and OnixS::ICE::iMpact::MarketData::TcpSettings::maximumNumberOfReconnectAttempts
.
TCP connection information section defines attributes of remote system to which server has to connect to request primary information like product definitions for selected markets. This section also defines login information like username and password which the Handler must supply to succeed with requests.
Typical TCP connection information section looks like the following:
Values of ip
and port
attributes define connection to remote system. userName
and password
are the logon-related attributes.
getStripInfoMessages
used as a flag to indicate whether the client wants to get Strip Info Messages or not. Y
or N
. It is N
by default.
sslEnabled
used to enable/disable SSL for TCP connection to ICE server. By default, SSL is enabled for Non-Production and disabled for Production.
If you don't want to store username and password in the connectivity configuration file, please use the Handler's API. For example:
Multicast groups section defines addresses of Multicast Price Feed channels for different types of books for a particular multicast group. Example below shows how single entry have to be defined:
Each group
entry defines connection parameters for each type of book defined by the ICE iMpact specification. Therefore, connectivity configuration supposes existence of two entries in each group
entry: fullOrderDepth
and priceLevel
. In own turn, each such entry must contain live
and snapshot
sub-entries which define connection information for corresponding Multicast Price Feed channel.
Finally, Market types
section defines the correspondence between multicast groups and types of markets which make up a particular group. Like, ICE Futures Europe Oil
group includes IPE Gas Oil Futures
, IPE Brent Future
, IPE Gas Oil Futures Crack
, and other market types. So, the section defines such kind of information.
The following sample depicts how association can be defined:
Generally, a basic configuration file looks like the following: