KeySquare API

The KeySquare Java API connects applications to the platform.

Start with the classes below when building an application.

Connect

• KeySession - main API for connectivity, routing, subscribing, publishing and monitoring.
• KeySessionContext - configuration for session creation.
• KeySessionFactory - creates session instances.
• KeySessionListener - session lifecycle and error callbacks.

Process Data

• MessageProcessor - for receiving messages.
• KeyMessage - received message containing metadata, topic and payload.
• Messages - factory for reusable publishable messages.

Address Data

• Topic - immutable topic and wildcard constants.
• Topics - factory for creating topics.

Packages

Package	Description
trading.keysquare.api.clock	Provides nanosecond-resolution wall-clock timestamps.
trading.keysquare.api.codec	Provides custom serialization support for messages.
trading.keysquare.api.edit	Provides experimental APIs for requesting and processing message edits.
trading.keysquare.api.message	Defines reusable message types for publishing and receiving SBE, DTO, flexible, custom and raw messages.
trading.keysquare.api.monitoring	Provides application readiness, status and metric reporting APIs.
trading.keysquare.api.recovery	Defines recovery policies for reconnecting sessions.
trading.keysquare.api.session	Defines the session API used to connect applications to the platform.
trading.keysquare.api.subscription	Provides callbacks and helpers for subscription and unsubscription requests.
trading.keysquare.api.topic	Defines topics and topic sets used to address messages.