com.paritytrading.juncture.cboe.fx.itch.package-info Maven / Gradle / Ivy
/**
* This package contains an implementation of Cboe FX ITCH Protocol 1.65.
*
* The implementation is based on the Java NIO API and consists of two
* parts:
*
* - an implementation of ITCH Session Management Protocol
* ({@link com.paritytrading.juncture.cboe.fx.itch.ITCHSession})
* - an implementation of Cboe FX Book Protocol
* ({@link com.paritytrading.juncture.cboe.fx.itch.CboeFXBook})
*
*
* The implementation of ITCH Session Management Protocol consists of
* three primary functions:
*
* - data reception
* ({@link com.paritytrading.juncture.cboe.fx.itch.ITCHSession#receive})
* - data transmission
* - session keep-alive
* ({@link com.paritytrading.juncture.cboe.fx.itch.ITCHSession#keepAlive})
*
*
* Data reception can run on one thread and data transmission and session
* keep-alive on another without locking. Data transmission and session
* keep-alive can run on different threads but require locking.
*
* The underlying socket channels can be either blocking or non-blocking.
* In both cases, data transmission always blocks.
*/
package com.paritytrading.juncture.cboe.fx.itch;