lci::error_t Struct Reference

Wrapper class for error code. More...

#include <lci.hpp>

Public Member Functions
	error_t ()
	error_t (errorcode_t errorcode_)
	Construct an error_t object with a specific error code.
void	reset_retry ()
	Reset the error code to retry.
bool	is_done () const
	Check if the error code is in the done category.
bool	is_posted () const
	Check if the error code is in the posted category.
bool	is_retry () const
	Check if the error code is in the retry category.
const char *	get_str () const
	Get the string representation of the error code.

Public Attributes
errorcode_t	errorcode

Detailed Description

Wrapper class for error code.

This class wraps the error code and provides utility functions to check the error code.

Constructor & Destructor Documentation

error_t() [1/2]

lci::error_t::error_t ( )

inline

error_t() [2/2]

lci::error_t::error_t ( errorcode_t errorcode_ )

inline

Construct an error_t object with a specific error code.

Parameters

errorcode_

The error code to be wrapped.

Member Function Documentation

get_str()

const char * lci::error_t::get_str ( ) const

inline

Get the string representation of the error code.

Returns

The string representation of the error code.

Here is the call graph for this function:

is_done()

bool lci::error_t::is_done ( ) const

inline

Check if the error code is in the done category.

Returns

true if the error code is in the done category.

is_posted()

bool lci::error_t::is_posted ( ) const

inline

Check if the error code is in the posted category.

Returns

true if the error code is in the posted category.

is_retry()

bool lci::error_t::is_retry ( ) const

inline

Check if the error code is in the retry category.

Returns

true if the error code is in the retry category.

reset_retry()

void lci::error_t::reset_retry ( )

inline

Reset the error code to retry.

Member Data Documentation

errorcode

errorcode_t lci::error_t::errorcode

---

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

• /home/runner/work/lci/lci/src/api/lci.hpp