ArmoniK.Extensions.Cpp documentation

Contents:

• 1. Setup ArmoniK SDK
  • 1.1. Global prerequisites
  • 1.2. How to build for Linux
    • 1.2.1. Prerequisites Linux
    • 1.2.2. CLion setup
    • 1.2.3. Visual Studio setup
  • 1.3. How to build for Red Hat Enterprise Linux 8 / UBI 8
    • 1.3.1. 1. Enable EPEL and install system dependencies
    • 1.3.2. 2. Build and install nlohmann/json from source
    • 1.3.3. 3. Install the gRPC RPMs
    • 1.3.4. 4. Install ArmoniK.Api
    • 1.3.5. 5. Build the SDK
  • 1.4. Worker Docker images
  • 1.5. How to build for Windows (Client only)
    • 1.5.1. Prerequisites Windows
    • 1.5.2. Visual Studio
• 2. Run tests
  • 2.1. How to use the ArmoniK C++ SDK
    • 2.1.1. Build worker and dynamic worker (Linux only)
    • 2.1.2. Deploy ArmoniK
    • 2.1.3. Build the client test and submit jobs
• 3. Build and configure your own client/worker
  • 3.1. Background: execution paths, blobs, and the convention
    • 3.1.1. Two execution paths
    • 3.1.2. Blobs
    • 3.1.3. The convention
    • 3.1.4. Backward compatibility
  • 3.2. Client
    • 3.2.1. Configure the session
    • 3.2.2. Invocation handler
    • 3.2.3. Submitting tasks — convention path (recommended)
    • 3.2.4. Submitting tasks — legacy path
    • 3.2.5. Task chaining with result_id
    • 3.2.6. Waiting for results
    • 3.2.7. Cross-SDK interoperability Samples
  • 3.3. Worker
    • 3.3.1. Deploying the shared library
    • 3.3.2. Building the shared library

API Documentation

• Doxygen generated C++ documentation