Contents

• 1. cuObjServer API Specification v1.0.0
  • 1.1. Overview
    • 1.1.1. Key features
    • 1.1.2. Protocol support
  • 1.2. I/O flow
    • 1.2.1. Key concepts
  • 1.3. Core Types and Enumerations
    • 1.3.1. Error types
    • 1.3.2. Protocol types
    • 1.3.3. Operation types
    • 1.3.4. Channel ID states
    • 1.3.5. Delay modes
  • 1.4. RDMAConnection Class
    • 1.4.1. Class declaration
    • 1.4.2. Notes
  • 1.5. cuObjServer Class API
    • 1.5.1. Class declaration
    • 1.5.2. Constructors
      • 1.5.2.1. Basic constructor
      • 1.5.2.2. Advanced constructor with tuning parameters
    • 1.5.3. Memory Management APIs
      • 1.5.3.1. allocHostBuffer
      • 1.5.3.2. registerBuffer (single buffer)
      • 1.5.3.3. registerBuffer (scatter-gather list)
      • 1.5.3.4. getRDMABufferFromSgList
      • 1.5.3.5. putRDMABufferFromSgList
      • 1.5.3.6. deRegisterBuffer
    • 1.5.4. I/O Operations
      • 1.5.4.1. handleGetObject (synchronous and async submission)
      • 1.5.4.2. handleGetObject (with poll delay)
      • 1.5.4.3. handlePutObject (synchronous and async submission)
      • 1.5.4.4. handlePutObject (with poll delay)
    • 1.5.5. Asynchronous Operations
      • 1.5.5.1. cuObjAsyncEvent_t
      • 1.5.5.2. poll
    • 1.5.6. Channel Management
      • 1.5.6.1. allocateChannelId
      • 1.5.6.2. freeChannelId
    • 1.5.7. Connection Management
      • 1.5.7.1. isConnected
    • 1.5.8. Telemetry Management
      • 1.5.8.1. setupTelemetry
      • 1.5.8.2. shutdownTelemetry
      • 1.5.8.3. setTelemFlags
  • 1.6. Supporting Structures
    • 1.6.1. cuObjScatterGatherEntry_t
    • 1.6.2. cuObjScatterGatherEntryWithOffset_t
    • 1.6.3. cuObjRDMATunableParam
    • 1.6.4. Key parameters
  • 1.7. Error Handling
    • 1.7.1. Return value conventions
    • 1.7.2. InfiniBand verbs status
    • 1.7.3. Example
    • 1.7.4. Best practices
  • 1.8. Usage Patterns
    • 1.8.1. Basic server usage (single-threaded)
    • 1.8.2. Multi-threaded server usage
    • 1.8.3. Asynchronous operations
    • 1.8.4. Scatter-gather buffer usage
    • 1.8.5. Advanced: RDMA buffer views
    • 1.8.6. Custom RDMA tuning
    • 1.8.7. Telemetry configuration
  • 1.9. Constants and Limits
    • 1.9.1. Operation limits
    • 1.9.2. Channel limits
    • 1.9.3. RDMA defaults
    • 1.9.4. Memory requirements
  • 1.10. Thread Safety and Channel Management
    • 1.10.1. Thread safety model
    • 1.10.2. Channel usage rules
      • 1.10.2.1. Default channel (0)
      • 1.10.2.2. Allocated channels
      • 1.10.2.3. Async operations
    • 1.10.3. Correct and incorrect patterns
  • 1.11. Best Practices