1 Introduction
1.1 About this Manual
1.2 Audience
1.3 Programming Language
1.4 Acronyms and Abbreviations
1.5 References
1.6 Document Conventions
2 Product Overview
2.1 Enterprise Message API Product Description
2.2 Product Documentation and Learning the Enterprise Message API
2.2.1 Consumer Examples
2.2.2 Provider Examples
2.3 Product Architecture
2.3.1 Enterprise Message API Consumer Architecture
2.3.2 Enterprise Message API Provider Architecture
2.3.3 Enterprise Message API Codec Architecture
2.4 Tunnel Streams
3 OMM Containers and Messages
3.1 Overview
3.2 Classes
3.2.1 DataType Class
3.2.2 DataCode Class
3.2.3 Data Class
3.2.4 Msg Class
3.2.5 OmmError Class
3.2.6 TunnelStreamRequest and ClassOfService Classes
3.3 Working with OMM Containers
3.3.1 Example: Populating a FieldList Class
3.3.2 Example: Populating a Map Class Relying on the FieldList Memory Buffer
3.3.3 Example: Populating a Map Class Relying on the Map Class Buffer
3.3.4 Example: Extracting Information from a FieldList Class
3.3.5 Example: Application Filtering on the FieldList Class
3.3.6 Example: Extracting FieldList information using a Downcast Operation
3.4 Working with OMM Messages
3.4.1 Example: Populating the GenericMsg with an ElementList Payload
3.4.2 Example: Extracting Information from the GenericMsg Class
3.4.3 Example: Working with the TunnelStreamRequest Class
4 Consumer Classes
4.1 OmmConsumer Class
4.1.1 Connecting to a Server and Opening Items
4.1.2 Opening Items Immediately After OmmConsumer Object Instantiation
4.1.3 Destroying the OmmConsumer Object
4.1.4 Example: Working with the OmmConsumer Class
4.1.5 Working with Items
4.1.6 Example: Working with Items
4.1.7 Working with Tunnel Streams
4.1.8 Example: Working with Tunnel Streams
4.2 OmmConsumerClient Class
4.2.1 OmmConsumerClient Description
4.2.2 Example: OmmConsumerClient
4.3 OmmConsumerConfig Class
4.3.1 OmmConsumerConfig Description
4.3.2 Unencrypted Connections
4.3.3 Encrypted Connections
4.3.3.1 Implementing Protocols and Encryption Behavior
4.3.3.2 OpenSSL Libraries
4.3.3.3 Certificate Authority
4.3.4 HTTP Proxy Connections
5 Provider Classes
5.1 OmmProvider Class
5.1.1 Connecting to ADH and Submitting Items
5.1.2 Interactive Providers: Post OmmProvider Object Instantiation
5.1.3 Non-Interactive Providers: Post OmmProvider Object Instantiation
5.1.4 Non-Interactive Providers: Encrypted Connections and HTTP Proxy Tunneling
5.1.5 Destroying the OmmProvider Object
5.1.6 Non-Interactive Example: Working with the OmmProvider Class
5.1.7 Interactive Provider Example: Working with the OmmProvider Class
5.1.8 Interactive Provider Example: Handling Post Message
5.1.9 Interactive Provider Example: Handling RTT Responses from Consumer
5.1.10 Working with Items
5.1.11 Packing with Providers
5.1.11.1 Interactive Provider Packing Example
5.1.11.2 Non-interactive Provider Packing Example
5.2 OmmProviderClient Class
5.2.1 OmmProviderClient Description
5.2.2 Non-Interactive Example: OmmProviderClient
5.2.3 Interactive Example: OmmProviderClient
5.3 OMMIProviderConfig
5.4 OmmNiProviderConfig Class
6 Consuming Data from the Cloud
6.1 Overview
6.2 Encrypted Connections
6.3 Credential Management
6.4 Version 1 Authentication Using oAuth Password and Refresh_Token
6.4.1 Client_ID (AppKey) and Client Secret
6.4.2 Obtaining Initial Access and Refresh Tokens
6.4.3 Refreshing the Access Token and Sending a Login Reissue
6.5 Version 2 Authentication Using oAuth Client Credentials
6.5.1 Configuring and Managing Version 2 Credentials
6.5.1.1 JWT Credentials Handling
6.5.2 Version 2 OAuth Client Credentials Token Lifespan
6.6 Service Discovery
6.7 Consuming Market Data
6.8 HTTP Error Handling for Reactor Token Reissues
6.9 Cloud Connection Use Cases
6.9.1 Session Management Use Case
6.9.2 Query Service Discovery
6.10 Logging of Authentication and Service Discovery Interaction
6.10.1 Logged Request Information
6.10.2 Logged Response Information
7 Warm Standby Feature
7.1 Overview
7.2 Warm Standby Modes
7.3 Warm Standby Configuration and Feature Details
7.4
8 Troubleshooting and Debugging
8.1 Enterprise Message API Logger Usage
8.2 Omm Error Client Classes
8.2.1 Error Client Description
8.2.2 Example: Error Client
8.3 OmmException Class
8.4 Creating a DACSLOCK for Publishing Permission Data
1.1 About this Manual
8.4 Creating a DACSLOCK for Publishing Permission Data
This site works best with JavaScript enabled