Cap’n’Proto Schema Documentation

This section documents the Cap’n’Proto schemas used in FusionSC. These schemas define the data structures and RPC interfaces for the distributed services.

Overview

FusionSC uses Cap’n’Proto for:

  • Data serialization: Efficient binary encoding of data structures

  • RPC interfaces: Distributed service communication

  • Schema definitions: Type-safe contracts between services

The schemas are located in src/python/fusionsc/serviceDefs/fusionsc/.

Schema Types

Structs

Data structures that define the layout of serialized data. Each struct has a unique type ID and fields with assigned indices.

Interfaces

Remote procedure call (RPC) interfaces that define service contracts. Each method has a unique index and can return complex types.

API Documentation

The documentation is automatically generated from the schema files. For each schema, you’ll find:

  • Struct definitions with fields and types

  • Interface definitions with methods and parameters

  • Usage examples for C++ and Python