Public Member Functions | Static Public Member Functions | List of all members
ucxx::AmReceiverCallbackOwnerType Class Reference

Active Message receiver callback owner name (fixed-size). More...

#include <typedefs.h>

Public Member Functions

 AmReceiverCallbackOwnerType ()=default
 Construct an empty (all-zero) owner name.
 
 AmReceiverCallbackOwnerType (const char *s)
 Construct from a null-terminated C string. Throws if length exceeds the limit.
 
 AmReceiverCallbackOwnerType (const std::string &s)
 Construct from a std::string. Throws if length exceeds the limit.
 
const char * data () const noexcept
 Pointer to the raw fixed-size storage.
 
char * data () noexcept
 Mutable pointer to the raw fixed-size storage (for deserialization).
 
bool operator== (const AmReceiverCallbackOwnerType &other) const noexcept
 Equality comparison.
 
bool operator!= (const AmReceiverCallbackOwnerType &other) const noexcept
 Inequality comparison.
 

Static Public Member Functions

static constexpr size_t storageSize () noexcept
 The fixed storage size that is always sent on the wire.
 

Detailed Description

Active Message receiver callback owner name (fixed-size).

A fixed-size identifier for the owner of an Active Message receiver callback. The owner should be a reasonably unique name, usually identifying the application, to allow other applications to coexist and register their own receiver callbacks.

Names are stored in a fixed 64-byte buffer, zero-padded. The maximum string length is 63 characters. Attempting to construct from a longer string throws std::invalid_argument.

Implicit construction from const char* and std::string is supported so that existing call sites such as AmReceiverCallbackInfo("MyApp", 0) compile unchanged.


The documentation for this class was generated from the following file: