hip-ucxx C++ API documentation

2026-03-31

3 min read time

Applies to Linux

• Core
  • Context
    • ucxx::Context
      • ~Context()
      • getConfig()
      • getHandle()
      • getInfo()
      • getFeatureFlags()
      • hasCudaSupport()
      • createWorker()
      • createMemoryHandle()
      • defaultFeatureFlags
      • createContext
    • Factory Functions
      • createContext()
  • Worker
    • ucxx::Worker
      • ~Worker()
      • getHandle()
      • getInfo()
      • initBlockingProgressMode()
      • getEpollFileDescriptor()
      • arm()
      • progressWorkerEvent()
      • signal()
      • waitProgress()
      • progressOnce()
      • progress()
      • registerDelayedSubmission()
      • registerGenericPre()
      • registerGenericPost()
      • isDelayedRequestSubmissionEnabled()
      • isFutureEnabled()
      • populateFuturesPool()
      • clearFuturesPool()
      • getFuture()
      • waitRequestNotifier()
      • runRequestNotifier()
      • stopRequestNotifierThread()
      • setProgressThreadStartCallback()
      • startProgressThread()
      • stopProgressThread()
      • isProgressThreadRunning()
      • getProgressThreadId()
      • cancelInflightRequests()
      • scheduleRequestCancel()
      • removeInflightRequest()
      • tagProbe()
      • tagRecv()
      • getAddress()
      • createEndpointFromHostname()
      • createEndpointFromWorkerAddress()
      • createListener()
      • registerAmAllocator()
      • registerAmReceiverCallback()
      • amProbe()
      • flush()
      • createWorker
    • Worker Progress Thread
      • ucxx::WorkerProgressThread
  • Address
    • ucxx::Address
      • getHandle()
      • getLength()
      • getString()
      • createAddressFromWorker
      • createAddressFromString
    • Factory Functions
      • createAddressFromWorker()
      • createAddressFromString()
  • Config
    • ucxx::Config
      • Config()
      • get()
      • getHandle()
  • Component
    • ucxx::Component
      • setParent()
      • getParent()
  • Logging
    • UCXX_MAX_LOG_LEVEL
    • ucxx_log_component_is_enabled
    • ucxx_log_is_enabled
    • ucxx_log_component
    • ucxx_log
    • ucxx_error
    • ucxx_warn
    • ucxx_diag
    • ucxx_info
    • ucxx_debug
    • ucxx_trace
    • ucxx_trace_req
    • ucxx_trace_data
    • ucxx_trace_async
    • ucxx_trace_func
    • ucxx_trace_poll
    • ucxx
      • parseLogLevel()
      • ucxx_log_component_config
      • logLevelNames
      • logLevelNameDefault
      • logLevelDefault
• Communication
  • Endpoint
    • ucxx::Endpoint
      • getHandle()
      • isAlive()
      • raiseOnError()
      • removeInflightRequest()
      • cancelInflightRequests()
      • getCancelingSize()
      • cancelInflightRequestsBlocking()
      • setCloseCallback()
      • amSend()
      • amRecv()
      • memPut()
      • memPut()
      • memGet()
      • memGet()
      • streamSend()
      • streamRecv()
      • tagSend()
      • tagRecv()
      • tagMultiSend()
      • tagMultiRecv()
      • flush()
      • getWorker()
      • close()
      • closeBlocking()
      • createEndpointFromHostname
      • createEndpointFromConnRequest
      • createEndpointFromWorkerAddress
    • ucxx::EpParamsDeleter
      • operator()()
    • Factory Functions
      • createEndpointFromHostname()
      • createEndpointFromWorkerAddress()
      • createEndpointFromConnRequest()
  • Listener
    • ucxx::Listener
      • createEndpointFromConnRequest()
      • getHandle()
      • getPort()
      • getIp()
      • createListener
    • Factory Functions
      • createListener()
• Request
  • Base Request
    • ucxx::Request
      • ~Request()
      • cancel()
      • getStatus()
      • getFuture()
      • checkError()
      • isCompleted()
      • callback()
      • populateDelayedSubmission()
      • getOwnerString()
      • getRecvBuffer()
  • Request Data
    • ucxx
      • ucxx::data
    • Tag Request
      • ucxx::RequestTag
      • Factory Functions
    • Tag Multi-Buffer Request
      • ucxx::RequestTagMulti
      • Factory Functions
    • Stream Request
      • ucxx::RequestStream
      • Factory Functions
    • Active Message Request
      • ucxx::RequestAm
      • Factory Functions
    • Remote Memory Access Request
      • ucxx::RequestMem
      • Factory Functions
    • Flush Request
      • ucxx::RequestFlush
      • Factory Functions
    • Endpoint Close Request
      • ucxx::RequestEndpointClose
      • Factory Functions
• Memory
  • Buffer
    • BufferType
      • Host
      • RMM
      • Invalid
    • ucxx::Buffer
      • ~Buffer()
      • getType()
      • getSize()
      • data()
    • ucxx::HostBuffer
      • HostBuffer()
      • HostBuffer()
      • ~HostBuffer()
      • release()
      • data()
    • ucxx::RMMBuffer
      • RMMBuffer()
      • RMMBuffer()
      • release()
      • data()
  • Memory Handle
    • ucxx::MemoryHandle
      • getHandle()
      • getSize()
      • getBaseAddress()
      • getMemoryType()
      • createRemoteKey()
      • createMemoryHandle
    • Factory Functions
      • createMemoryHandle()
  • Remote Key
    • ucxx::RemoteKey
      • getHandle()
      • getSize()
      • getBaseAddress()
      • serialize()
      • createRemoteKeyFromMemoryHandle
      • createRemoteKeyFromSerialized
    • Factory Functions
      • createRemoteKeyFromMemoryHandle()
      • createRemoteKeyFromSerialized()
• Async
  • Future
    • ucxx::Future
      • ~Future()
      • notify()
      • set()
      • getHandle()
      • release()
  • Notifier
    • ucxx::Notifier
      • ~Notifier()
      • scheduleFutureNotify()
      • waitRequestNotifier()
      • runRequestNotifier()
      • stopRequestNotifierThread()
      • isRunning()
  • Delayed Submission
    • ucxx
      • DelayedSubmissionCallbackType
      • ItemIdType
      • ucxx::BaseDelayedSubmissionCollection
      • ucxx::RequestDelayedSubmissionCollection
      • ucxx::GenericDelayedSubmissionCollection
      • ucxx::DelayedSubmissionCollection
    • Inflight Requests
      • ucxx::InflightRequests
• Utilities
  • Type Definitions
    • ucxx
      • ConfigMap
      • RequestCallbackUserFunction
      • RequestCallbackUserData
      • EndpointCloseCallbackUserFunction
      • EndpointCloseCallbackUserData
      • AmReceiverCallbackType
      • AmReceiverCallbackOwnerType
      • AmReceiverCallbackIdType
      • SerializedRemoteKey
      • ucxx_log_level_t
      • TransferDirection
      • Tag
      • TagMask
      • TagMaskFull
      • ucxx::TagRecvInfo
      • ucxx::AmReceiverCallbackInfo
  • Header
    • ucxx::Header
      • Header()
      • Header()
      • serialize()
      • next
      • nframes
      • isCUDA
      • size
      • dataSize()
      • buildHeaders()
  • Exceptions
    • ucxx::Error
      • Error()
      • what()
      • _msg
    • ucxx::NoMessageError
      • NoMessageError()
    • ucxx::NoResourceError
      • NoResourceError()
    • ucxx::IOError
      • IOError()
    • ucxx::NoMemoryError
      • NoMemoryError()
    • ucxx::InvalidParamError
      • InvalidParamError()
    • ucxx::UnreachableError
      • UnreachableError()
    • ucxx::InvalidAddrError
      • InvalidAddrError()
    • ucxx::NotImplementedError
      • NotImplementedError()
    • ucxx::MessageTruncatedError
      • MessageTruncatedError()
    • ucxx::NoProgressError
      • NoProgressError()
    • ucxx::BufferTooSmallError
      • BufferTooSmallError()
    • ucxx::NoElemError
      • NoElemError()
    • ucxx::SomeConnectsFailedError
      • SomeConnectsFailedError()
    • ucxx::NoDeviceError
      • NoDeviceError()
    • ucxx::BusyError
      • BusyError()
    • ucxx::CanceledError
      • CanceledError()
    • ucxx::ShmemSegmentError
      • ShmemSegmentError()
    • ucxx::AlreadyExistsError
      • AlreadyExistsError()
    • ucxx::OutOfRangeError
      • OutOfRangeError()
    • ucxx::TimedOutError
      • TimedOutError()
    • ucxx::ExceedsLimitError
      • ExceedsLimitError()
    • ucxx::UnsupportedError
      • UnsupportedError()
    • ucxx::RejectedError
      • RejectedError()
    • ucxx::NotConnectedError
      • NotConnectedError()
    • ucxx::ConnectionResetError
      • ConnectionResetError()
    • ucxx::FirstLinkFailureError
      • FirstLinkFailureError()
    • ucxx::LastLinkFailureError
      • LastLinkFailureError()
    • ucxx::FirstEndpointFailureError
      • FirstEndpointFailureError()
    • ucxx::EndpointTimeoutError
      • EndpointTimeoutError()
    • ucxx::LastEndpointFailureError
      • LastEndpointFailureError()
  • Utility Helpers
    • Socket Address Utilities
      • ucxx::utils
    • File Descriptor Utilities
      • createTextFileDescriptor()
      • decodeTextFileDescriptor()
    • UCX Wrappers
      • ucsErrorThrow()