LCI v2.0.0-dev
For Asynchronous Multithreaded Communication
Loading...
Searching...
No Matches
lci::status_t Struct Reference

The type of the completion desciptor for a posted communication. More...

#include <lci.hpp>

Collaboration diagram for lci::status_t:
[legend]

Public Member Functions

 status_t ()=default
 
 status_t (errorcode_t error_)
 
 status_t (void *user_context_)
 
void set_done ()
 
void set_posted ()
 
void set_retry ()
 
bool is_done () const
 
bool is_posted () const
 
bool is_retry () const
 
template<typename T>
get_scalar () const
 
buffer_t get_buffer ()
 
buffers_t get_buffers ()
 
bool is_scalar () const
 
bool is_buffer () const
 
bool is_buffers () const
 

Public Attributes

error_t error = errorcode_t::retry_init
 
int rank = -1
 
data_t data
 
tag_t tag = 0
 
void * user_context = nullptr
 

Detailed Description

The type of the completion desciptor for a posted communication.

Constructor & Destructor Documentation

◆ status_t() [1/3]

lci::status_t::status_t ( )
default

◆ status_t() [2/3]

lci::status_t::status_t ( errorcode_t error_)
inline

◆ status_t() [3/3]

lci::status_t::status_t ( void * user_context_)
inlineexplicit

Member Function Documentation

◆ get_buffer()

buffer_t lci::status_t::get_buffer ( )
inline

◆ get_buffers()

buffers_t lci::status_t::get_buffers ( )
inline

◆ get_scalar()

template<typename T>
T lci::status_t::get_scalar ( ) const
inline

◆ is_buffer()

bool lci::status_t::is_buffer ( ) const
inline

◆ is_buffers()

bool lci::status_t::is_buffers ( ) const
inline

◆ is_done()

bool lci::status_t::is_done ( ) const
inline

◆ is_posted()

bool lci::status_t::is_posted ( ) const
inline

◆ is_retry()

bool lci::status_t::is_retry ( ) const
inline

◆ is_scalar()

bool lci::status_t::is_scalar ( ) const
inline

◆ set_done()

void lci::status_t::set_done ( )
inline

◆ set_posted()

void lci::status_t::set_posted ( )
inline

◆ set_retry()

void lci::status_t::set_retry ( )
inline

Member Data Documentation

◆ data

data_t lci::status_t::data

◆ error

error_t lci::status_t::error = errorcode_t::retry_init

◆ rank

int lci::status_t::rank = -1

◆ tag

tag_t lci::status_t::tag = 0

◆ user_context

void* lci::status_t::user_context = nullptr

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