Contents

• 1. cuObjServer API Specification
  • 1.1. Overview
  • 1.2. Architecture
  • 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 Base Class
    • 1.4.1. Class Declaration
    • 1.4.2. RDMAConnection(const char* ip, unsigned short port)
    • 1.4.3. startRDMASession()
    • 1.4.4. initRDMAConfigParams()
    • 1.4.5. closeRDMASession()
    • 1.4.6. handleDisconnectEvent()
    • 1.4.7. getChannelIP()
    • 1.4.8. getChannelPort()
    • 1.4.9. getConfigTunableParam()
  • 1.5. cuObjServer Class API
    • 1.5.1. Class Declaration
    • 1.5.2. Constructors
      • 1.5.2.1. Basic Constructor
      • 1.5.2.2. Constructor With Tunables
      • 1.5.2.3. Default Constructor
    • 1.5.3. Memory Management APIs
      • 1.5.3.1. allocHostBuffer()
      • 1.5.3.2. registerBuffer() for a Single Buffer
      • 1.5.3.3. registerBuffer() for a 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()
      • 1.5.4.2. handlePutObject()
    • 1.5.5. Asynchronous Completion
      • 1.5.5.1. 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
    • 1.6.2. cuObjScatterGatherEntryWithOffset
    • 1.6.3. cuObjAsyncEvent_t
    • 1.6.4. cuObjRDMATunableParam
    • 1.6.5. cuObjRDMATunable
  • 1.7. Error Handling
    • 1.7.1. Return Value Conventions
    • 1.7.2. I/O API Failure Values
    • 1.7.3. poll() Failure Values
    • 1.7.4. Completion Status
  • 1.8. Server IPv6 Endpoint Support
  • 1.9. Usage Patterns
    • 1.9.1. Basic Server Usage
    • 1.9.2. Synchronous PUT Usage
    • 1.9.3. Asynchronous Usage
    • 1.9.4. Scatter-Gather Registration
    • 1.9.5. Registered Buffer View
    • 1.9.6. Custom RDMA Tuning
    • 1.9.7. Telemetry Configuration
  • 1.10. Constants and Limits
    • 1.10.1. Operation Limits
    • 1.10.2. Poll Limits
    • 1.10.3. Channel Limits
    • 1.10.4. Memory Requirements
  • 1.11. Thread Safety and Channel Management
    • 1.11.1. Channel Rules
    • 1.11.2. Shared Resources
    • 1.11.3. Telemetry Configuration
  • 1.12. API Usage Notes