MkBufferListC_CC_API

MkBufferListC - the class known as bfl or buffer-list is used to create and manage a list of MkBufferC … More...

Collaboration diagram for MkBufferListC_CC_API:

Topics
	MkBufferListC_TOR_CC_API
	MkBufferListC - various functions to create and destroy a MkBufferListS …
	MkBufferListC_Append_CC_API
	MkBufferListC - various functions to 'append' to a MkBufferListS …
	MkBufferListC_Check_CC_API
	MkBufferListC - various functions to 'check' a MkBufferListS …
	MkBufferListC_Index_CC_API
	MkBufferListC - various functions to access a MkBufferListS by index …
	MkBufferListC_Log_CC_API
	MkBufferListC - various functions to 'log' a MkBufferListS …
	MkBufferListC_Misc_CC_API
	MkBufferListC - various functions to work on a MkBufferListS …
	MkBufferListC_Introspection_CC_API
	MkBufferListC_Class_CC_API
	MkBufferListC - define the class …

Classes
struct	ccmkkernel::MkBufferListC_A
	The CLASS used to store a list of MkBufferS items into a flat array… → C-API: libmkkernel::MkBufferListS More...
class	ccmkkernel::MkBufferListC
	The CLASS used to store a list of MkBufferS items into a flat array… → C-API: libmkkernel::MkBufferListS More...

Functions
	ccmkkernel::MkBufferListC::MkBufferListC (MK_BFL hdl)
static MkBufferListC *	ccmkkernel::MkBufferListC::MkBufferListC_ObjNew (MK_RT const mkrt, MK_BFL hdl)
	return MkBufferListC from LibMsgqueObject
MK_BFL	ccmkkernel::MkBufferListC::getBFL (bool nullB=MK_NULL_NO) const
	return the LibMsgqueObject from current MkBufferListC instance
MK_BFLN	ccmkkernel::MkBufferListC::getBFLN (bool nullB=MK_NULL_NO) const
	(const) return the LibMsgqueObject from current MkBufferListC instance
static MK_BFL	ccmkkernel::MkBufferListC::getBFL (MkBufferListC *clsHdl, bool nullB=MK_NULL_NO)
	return LibMsgqueObject from current MkBufferListC pointer
static MK_BFLN	ccmkkernel::MkBufferListC::getBFLN (const MkBufferListC *clsHdl, bool nullB=MK_NULL_NO)
	(const) return LibMsgqueObject from current MkBufferListC pointer
static MK_BFL	ccmkkernel::MkBufferListC::getBFL (const MkBufferListC &clsHdl, bool nullB=MK_NULL_NO)
	return LibMsgqueObject from current MkBufferListC reference
static MK_BFLN	ccmkkernel::MkBufferListC::getBFLN (const MkBufferListC &clsHdl, bool nullB=MK_NULL_NO)
	(const) return LibMsgqueObject from current MkBufferListC reference
bool	ccmkkernel::MkBufferListC::Check () const
	check if pointer is still valid
	ccmkkernel::MkBufferListC::MkBufferListC (int argc, MK_STRN argv[])
	ccmkkernel::MkBufferListC::MkBufferListC (MK_STRN arg0,...)
	ccmkkernel::MkBufferListC::MkBufferListC (const std::vector< std::string > &)
	ccmkkernel::MkBufferListC::MkBufferListC (const MkBufferListC *hdl)
	ccmkkernel::MkBufferListC::MkBufferListC (const MkBufferListC &ref)
MkBufferListC &	ccmkkernel::MkBufferListC::operator= (const MkBufferListC &bfl)
MkBufferListC &	ccmkkernel::MkBufferListC::operator= (const MkBufferListC *bfl)
	ccmkkernel::MkBufferListC::operator MkBufferListC * ()

Variables
static thread_local MkBufferListC	ccmkkernel::MkBufferListC::MK_NULL_REF = {(MK_OBJ)0}

Detailed Description

MkBufferListC - the class known as bfl or buffer-list is used to create and manage a list of MkBufferC …

The MkBufferListC is used to store a list of MkBufferC data into an array. In contrast to the MkBufferStreamC, each individual item can be accessed directly with the MkBufferListC.

MkBufferListC* CLASS

The CLASS used to store a list of MkBufferS items into a flat array…

C-Kernel-Details

The CLASS MkBufferListS is used to store a list of MkBufferS into an MkBufferListS::data array. To access an MkBufferS item use:

‍0 <= index < MkBufferListS::cursize

A new MkBufferListS is always preallocated with the predefined ILS-storage (MkBufferListS::bls), but can switch to a MALLOC-storage if the storage requirements of the user exceed the predefined ILS-storage-size (MkBufferListS_bls_size).

‍A MkBufferListS never run out of storage.

See also

MkBufferC, MkBufferStreamC

MkBufferListC* CTOR / DTOR

command	alias
[constructor,static] MkBufferListC* MkBufferListC::Create(MK_NUM size = 0)	ccmkkernel::MkBufferListC(MK_NUM num = 0)
[destructor] bfl.Delete()	delete bfl

The MkBufferListC is used to store a list of MkBufferC data into an array. In contrast to the MkBufferStreamC, each individual item can be accessed directly with the MkBufferListC.

MkBufferListC* CLASS

The CLASS used to store a list of MkBufferS items into a flat array…

C-Kernel-Details

The CLASS MkBufferListS is used to store a list of MkBufferS into an MkBufferListS::data array. To access an MkBufferS item use:

‍0 <= index < MkBufferListS::cursize

A new MkBufferListS is always preallocated with the predefined ILS-storage (MkBufferListS::bls), but can switch to a MALLOC-storage if the storage requirements of the user exceed the predefined ILS-storage-size (MkBufferListS_bls_size).

‍A MkBufferListS never run out of storage.

See also

MkBufferC, MkBufferStreamC

MkBufferListC* CTOR / DTOR

command	alias
[constructor,static] MkBufferListC* MkBufferListC::Create(MK_NUM size = 0)	ccmkkernel::MkBufferListC(MK_NUM num = 0)
[destructor] bfl.Delete()	delete bfl

Function Documentation

Check()

bool ccmkkernel::MkBufferListC::Check ( ) const

inline

check if pointer is still valid

Definition at line 121 of file MkBufferListC_cc.hh.

                         {
        return (hdl && MkBflCheck(hdl));
      };

getBFL() [1/3]

MK_BFL ccmkkernel::MkBufferListC::getBFL ( bool nullB = MK_NULL_NO ) const

inline

return the LibMsgqueObject from current MkBufferListC instance

Definition at line 83 of file MkBufferListC_cc.hh.

                                                   {
        MK_BFL ret = reinterpret_cast<MK_BFL>(hdl);
        if (unlikely(!nullB && ret == NULL)) InstHdlIsNullError();
        return ret;
      };

getBFL() [2/3]

static MK_BFL ccmkkernel::MkBufferListC::getBFL ( const MkBufferListC & clsHdl, bool nullB = MK_NULL_NO )

inlinestatic

return LibMsgqueObject from current MkBufferListC reference

Definition at line 111 of file MkBufferListC_cc.hh.

                                                                                 {
        return clsHdl.getBFL(nullB);
      };

getBFL() [3/3]

static MK_BFL ccmkkernel::MkBufferListC::getBFL ( MkBufferListC * clsHdl, bool nullB = MK_NULL_NO )

inlinestatic

return LibMsgqueObject from current MkBufferListC pointer

Definition at line 97 of file MkBufferListC_cc.hh.

                                                                           {
        MK_BFL ret = clsHdl ? reinterpret_cast<MK_BFL>(clsHdl->hdl) : NULL;
        if (unlikely(!nullB && ret == NULL)) ClassHdlIsNullError(MkBufferListC);
        return ret;
      };

getBFLN() [1/3]

MK_BFLN ccmkkernel::MkBufferListC::getBFLN ( bool nullB = MK_NULL_NO ) const

inline

(const) return the LibMsgqueObject from current MkBufferListC instance

Definition at line 90 of file MkBufferListC_cc.hh.

                                                     {
        MK_BFLN ret = reinterpret_cast<MK_BFLN>(hdl);
        if (unlikely(!nullB && ret == NULL)) InstHdlIsNullError();
        return ret;
      };

Here is the caller graph for this function:

getBFLN() [2/3]

static MK_BFLN ccmkkernel::MkBufferListC::getBFLN ( const MkBufferListC & clsHdl, bool nullB = MK_NULL_NO )

inlinestatic

(const) return LibMsgqueObject from current MkBufferListC reference

Definition at line 116 of file MkBufferListC_cc.hh.

                                                                                   {
        return clsHdl.getBFLN(nullB);
      };

getBFLN() [3/3]

static MK_BFLN ccmkkernel::MkBufferListC::getBFLN ( const MkBufferListC * clsHdl, bool nullB = MK_NULL_NO )

inlinestatic

(const) return LibMsgqueObject from current MkBufferListC pointer

Definition at line 104 of file MkBufferListC_cc.hh.

                                                                                   {
        MK_BFLN ret = clsHdl ? reinterpret_cast<MK_BFLN>(clsHdl->hdl) : NULL;
        if (unlikely(!nullB && ret == NULL)) ClassHdlIsNullError(MkBufferListC);
        return ret;
      };

MkBufferListC() [1/6]

ccmkkernel::MkBufferListC::MkBufferListC ( const MkBufferListC & ref )

inline

Definition at line 39 of file MkBufferListC_inline_cc.hh.

                                                                {
    MkRtSetup_O(copy.hdl);
    MkObjectC::atomInit(MkObjDup(copy.hdl));
  }

MkBufferListC() [2/6]

ccmkkernel::MkBufferListC::MkBufferListC ( const MkBufferListC * hdl )

inline

Definition at line 33 of file MkBufferListC_inline_cc.hh.

                                                                {
    if (copy == NULL) throw MkReferenceNullExceptionC("MkBufferListC");
    MkRtSetup_O(copy->hdl);
    MkObjectC::atomInit(MkObjDup(copy->hdl));
  }

MkBufferListC() [3/6]

ccmkkernel::MkBufferListC::MkBufferListC ( const std::vector< std::string > & vals )

inline

Definition at line 72 of file MkBufferListC_inline_cc.hh.

                                                                       {
    MkRtSetup_NULL;
    auto bfl = MkBufferListCreate((MK_NUM)vals.size());
    for(const std::string& str : vals) {
      MkBufferListAppendStringR(bfl,MkStringCreate((MK_NUM)str.size(),str.c_str()));
    }
    MkBufferListC_Init(bfl);
  }

MkBufferListC() [4/6]

ccmkkernel::MkBufferListC::MkBufferListC ( int argc, MK_STRN argv[] )

inline

Definition at line 59 of file MkBufferListC_inline_cc.hh.

                                                               {
    MkRtSetup_NULL;
    MkBufferListC_Init(MkBufferListCreateVC(argc,argv));
  }

MkBufferListC() [5/6]

ccmkkernel::MkBufferListC::MkBufferListC ( MK_BFL hdl )

inline

Definition at line 74 of file MkBufferListC_cc.hh.

: MkObjectC(MkBufferListC_X2obj(hdl)) {};

MkBufferListC() [6/6]

ccmkkernel::MkBufferListC::MkBufferListC ( MK_STRN arg0, ... )

inline

Definition at line 64 of file MkBufferListC_inline_cc.hh.

                                                        {
    MkRtSetup_NULL;
    va_list ap;
    va_start(ap, arg0);
    MkBufferListC_Init(MkBufferListCreateVAL(arg0,ap));
    va_end (ap);
  }

MkBufferListC_ObjNew()

static MkBufferListC * ccmkkernel::MkBufferListC::MkBufferListC_ObjNew ( MK_RT const mkrt, MK_BFL hdl )

inlinestatic

return MkBufferListC from LibMsgqueObject

Definition at line 78 of file MkBufferListC_cc.hh.

                                                                         {
        return (hdl ? static_cast<MkBufferListC*>(MkObjectC::atomObjNew(MK_RT_CALL MkBufferListC_X2obj(hdl))) : &MK_NULL_REF);
      }

Here is the caller graph for this function:

operator MkBufferListC *()

ccmkkernel::MkBufferListC::operator MkBufferListC * ( )

inline

Definition at line 138 of file MkBufferListC_cc.hh.

{ return this; };

operator=() [1/2]

MkBufferListC & ccmkkernel::MkBufferListC::operator= ( const MkBufferListC & bfl )

inline

Definition at line 44 of file MkBufferListC_inline_cc.hh.

                                                                           {
    MkRtSetup_O(copy.hdl);
    MkObjCopy(hdl,copy.hdl);
    return *this;
  }

operator=() [2/2]

MkBufferListC & ccmkkernel::MkBufferListC::operator= ( const MkBufferListC * bfl )

inline

Definition at line 50 of file MkBufferListC_inline_cc.hh.

                                                                           {
    if (copy == NULL) throw MkReferenceNullExceptionC("MkBufferListC");
    MkRtSetup_O(copy->hdl);
    MkObjCopy(hdl,copy->hdl);
    return *this;
  }

Variable Documentation

MK_NULL_REF

thread_local MkBufferListC ccmkkernel::MkBufferListC::MK_NULL_REF = {(MK_OBJ)0}

static

Definition at line 46 of file MkBufferListC_cc.hh.