3. cuObjClient Class API#
3.1. Class Declaration#
class cuObjClient {
public:
// Constructor & Destructor
cuObjClient(CUObjOps_t& ops, cuObjProto_t proto = CUOBJ_PROTO_RDMA_DC_V1);
~cuObjClient();
// Memory Management
cuObjErr_t cuMemObjGetDescriptor(void* ptr, size_t size);
cuObjErr_t cuMemObjPutDescriptor(void* ptr);
ssize_t cuMemObjGetMaxRequestCallbackSize(void* ptr);
cuObjErr_t cuMemObjGetRDMAToken(void* ptr, size_t size, size_t buffer_offset,
cuObjOpType_t operation, char** desc_str_out);
cuObjErr_t cuMemObjPutRDMAToken(char* desc_str);
// I/O Operations
ssize_t cuObjGet(void* ctx, void* ptr, size_t size, loff_t offset = 0,
loff_t buf_offset = 0);
ssize_t cuObjPut(void* ctx, void* ptr, size_t size, loff_t offset = 0,
loff_t buf_offset = 0);
// Connection Management
bool isConnected(void);
// Static Utilities
static void* getCtx(const void* handle);
static cuObjMemoryType_t getMemoryType(const void* ptr);
// Telemetry Management
static void setupTelemetry(bool use_OTEL, std::ostream* os);
static void shutdownTelemetry();
static void setTelemFlags(unsigned flags);
};
3.2. Constructor#
Creates a new cuObjClient instance with user-defined callback operations.
cuObjClient(CUObjOps_t& ops, cuObjProto_t proto = CUOBJ_PROTO_RDMA_DC_V1);
Parameters:
ops: Reference to callback operations structure,CUObjIOOps.proto: RDMA descriptor protocol. The default value isCUOBJ_PROTO_RDMA_DC_V1.
Notes:
CUOBJ_PROTO_RDMA_DC_V1is the supported protocol value.Current behavior does not validate unsupported
protovalues.The callbacks are invoked during
cuObjGet()andcuObjPut()operations.Callbacks may be called from threads other than the caller thread.
Use
isConnected()after construction to verify that the client is ready for operations.If a required GET or PUT callback is not provided, the corresponding operation fails when the callback is needed.