hip-ucxx C++ API documentation#
2026-09-10
2 min read time
Applies to Linux
- Core
- Context
- Worker
ucxx::Worker~Worker()getHandle()getInfo()initBlockingProgressMode()getEpollFileDescriptor()arm()progressWorkerEvent()signal()waitProgress()progressOnce()progress()registerDelayedSubmission()registerGenericPre()registerGenericPost()isDelayedRequestSubmissionEnabled()isFutureEnabled()isRequestAttributesEnabled()getCudaBufferType()populateFuturesPool()clearFuturesPool()getFuture()waitRequestNotifier()runRequestNotifier()stopRequestNotifierThread()setProgressThreadStartCallback()startProgressThread()stopProgressThread()isProgressThreadRunning()getProgressThreadId()cancelInflightRequests()scheduleRequestCancel()removeInflightRequest()tagProbe()tagRecv()tagRecvWithHandle()getAddress()createEndpointFromHostname()createEndpointFromWorkerAddress()createListener()registerAmAllocator()registerAmReceiverCallback()amProbe()flush()queryAttributes()createWorkerucxx::Worker::Attributes
- Worker Progress Thread
- Address
- Config
- Component
- Logging
- Communication
- Endpoint
ucxx::EndpointgetHandle()isAlive()raiseOnError()removeInflightRequest()cancelInflightRequests()getCancelingSize()cancelInflightRequestsBlocking()setCloseCallback()amSend()amSend()amSend()amRecv()memPut()memPut()memGet()memGet()streamSend()streamRecv()tagSend()tagRecv()tagMultiSend()tagMultiRecv()flush()getWorker()close()closeBlocking()createEndpointFromHostnamecreateEndpointFromConnRequestcreateEndpointFromWorkerAddress
ucxx::EpParamsDeleter- Factory Functions
- Listener
- Endpoint
- Request
- Memory
- Async
- Utilities
- Type Definitions
ucxxConfigMapRequestCallbackUserFunctionRequestCallbackUserDataEndpointCloseCallbackUserFunctionEndpointCloseCallbackUserDataAmReceiverCallbackTypeAmReceiverCallbackIdTypeSerializedRemoteKeyucxx_log_level_tTransferDirectionTagTagMaskAmSendMemoryTypePolicyTagMaskFullAmReceiverCallbackOwnerMaxLenAmReceiverCallbackOwnerStorageSizeucxx::AmReceiverCallbackOwnerTypeucxx::AmReceiverCallbackInfoucxx::AmSendParamsucxx::AmReceiverCallbackOwnerHash
- Header
- Exceptions
ucxx::Errorucxx::NoMessageErrorucxx::NoResourceErrorucxx::IOErrorucxx::NoMemoryErrorucxx::InvalidParamErrorucxx::UnreachableErrorucxx::InvalidAddrErrorucxx::NotImplementedErrorucxx::MessageTruncatedErrorucxx::NoProgressErrorucxx::BufferTooSmallErrorucxx::NoElemErrorucxx::SomeConnectsFailedErrorucxx::NoDeviceErrorucxx::BusyErrorucxx::CanceledErrorucxx::ShmemSegmentErrorucxx::AlreadyExistsErrorucxx::OutOfRangeErrorucxx::TimedOutErrorucxx::ExceedsLimitErrorucxx::UnsupportedErrorucxx::RejectedErrorucxx::NotConnectedErrorucxx::ConnectionResetErrorucxx::FirstLinkFailureErrorucxx::LastLinkFailureErrorucxx::FirstEndpointFailureErrorucxx::EndpointTimeoutErrorucxx::LastEndpointFailureError
- Utility Helpers
- Type Definitions