•All Classes Namespaces Functions Variables Typedefs Enumerations Friends
Public Member Functions | List of all members
ucxx::Error Class Reference

The base class for all UCX exceptions. More...

#include <exception.h>

Inheritance diagram for ucxx::Error:
ucxx::AlreadyExistsError ucxx::BufferTooSmallError ucxx::BusyError ucxx::CanceledError ucxx::ConnectionResetError ucxx::EndpointTimeoutError ucxx::ExceedsLimitError ucxx::FirstEndpointFailureError ucxx::FirstLinkFailureError ucxx::IOError ucxx::InvalidAddrError ucxx::InvalidParamError ucxx::LastEndpointFailureError ucxx::LastLinkFailureError ucxx::MessageTruncatedError ucxx::NoDeviceError ucxx::NoElemError ucxx::NoMemoryError ucxx::NoMessageError ucxx::NoProgressError ucxx::NoResourceError ucxx::NotConnectedError ucxx::NotImplementedError ucxx::OutOfRangeError ucxx::RejectedError ucxx::ShmemSegmentError ucxx::SomeConnectsFailedError ucxx::TimedOutError ucxx::UnreachableError ucxx::UnsupportedError

Public Member Functions

 Error (const std::string &msg)
 The base class constructor. More...
 
const char * what () const noexcept override
 Returns an explanatory string. More...
 

Detailed Description

The base class for all UCX exceptions.

The base class for all UCX errors that may occur made into C++ exceptions.

Constructor & Destructor Documentation

◆ Error()

ucxx::Error::Error ( const std::string &  msg)
inlineexplicit

The base class constructor.

The base class constructor taking the explanatory string of the error.

Parameters
[in]msgthe explanatory string of the error.

Member Function Documentation

◆ what()

const char* ucxx::Error::what ( ) const
inlineoverridenoexcept

Returns an explanatory string.

Returns an explanatory string of the UCX error that has occurred.

Returns
the explanatory string.
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1