MkBufferStreamC_Read_CC_API

MkBufferStreamC - various functions to 'read' data from a MkBufferStreamS … More...

Collaboration diagram for MkBufferStreamC_Read_CC_API:

Functions
MkBufferListC *	ccmkkernel::MkBufferStreamC::ReadALL (MkBufferListC *val_inout=NULL)
	C++: MkBufferListC* bus.ReadALL(MkBufferListC* val_inout = NULL) → C-API get a temporary MkBufferListC from all data in the MkBufferStreamC …
MkBufferListC *	ccmkkernel::MkBufferStreamC::ReadBFL ()
	C++: MkBufferListC* bus.ReadBFL() → C-API read a MkBufferListC from the MkBufferStreamC …
MkBufferC *	ccmkkernel::MkBufferStreamC::ReadBUF ()
	C++: MkBufferC* bus.ReadBUF() → C-API read a val_out from the MkBufferStreamC …
MkTypeE	ccmkkernel::MkBufferStreamC::ReadGetNextType () const
	C++: MkTypeE bus.ReadGetNextType() → C-API get the type (MkTypeE) of the next Item in the MkBufferStreamC or "0" if not available
MK_NUM	ccmkkernel::MkBufferStreamC::ReadGetNumItems () const
	C++: MK_NUM bus.ReadGetNumItems() → C-API get the number of items left in the MkBufferStreamC …
MK_BOOL	ccmkkernel::MkBufferStreamC::ReadItemExists () const
	C++: MK_BOOL bus.ReadItemExists() → C-API check if an item exists in the read-data-package …
void	ccmkkernel::MkBufferStreamC::ReadL_END ()
	C++: bus.ReadL_END() → C-API END read a list-item-type from the MkBufferStreamC …
void	ccmkkernel::MkBufferStreamC::ReadL_START (MkBufferC *buf=NULL)
	C++: bus.ReadL_START(MkBufferC* buf = NULL) → C-API START read a list-item-type from the MkBufferStreamC …
void	ccmkkernel::MkBufferStreamC::ReadL_START (const MkBufferC &buf)
	C++: bus.ReadL_START(MkBufferC* buf = NULL) → C-API START read a list-item-type from the MkBufferStreamC …
void	ccmkkernel::MkBufferStreamC::ReadUndo ()
	C++: bus.ReadUndo() → C-API undo the last MkBufferStreamC READ function call …
MK_BNP	ccmkkernel::MkBufferStreamC::ReadBIN ()
	C++: doc_mk_cc_BufferStreamReadBIN → C-API read a val_out from the MkBufferStreamC …
MK_BOL	ccmkkernel::MkBufferStreamC::ReadBOL ()
	C++: doc_mk_cc_BufferStreamReadBOL → C-API read a val_out from the MkBufferStreamC …
MK_DBL	ccmkkernel::MkBufferStreamC::ReadDBL ()
	C++: doc_mk_cc_BufferStreamReadDBL → C-API read a val_out from the MkBufferStreamC …
MK_FLT	ccmkkernel::MkBufferStreamC::ReadFLT ()
	C++: doc_mk_cc_BufferStreamReadFLT → C-API read a val_out from the MkBufferStreamC …
MK_I32	ccmkkernel::MkBufferStreamC::ReadI32 ()
	C++: doc_mk_cc_BufferStreamReadI32 → C-API read a val_out from the MkBufferStreamC …
MK_I64	ccmkkernel::MkBufferStreamC::ReadI64 ()
	C++: doc_mk_cc_BufferStreamReadI64 → C-API read a val_out from the MkBufferStreamC …
MK_I8	ccmkkernel::MkBufferStreamC::ReadI8 ()
	C++: doc_mk_cc_BufferStreamReadI8 → C-API read a val_out from the MkBufferStreamC …
MK_LONG	ccmkkernel::MkBufferStreamC::ReadLONG ()
	C++: MK_LONG bus.ReadLONG() → C-API read the long native object from the MkBufferStreamC …
MK_STRN	ccmkkernel::MkBufferStreamC::ReadSTR ()
	C++: doc_mk_cc_BufferStreamReadSTR → C-API read a val_out from the MkBufferStreamC …

Detailed Description

MkBufferStreamC - various functions to 'read' data from a MkBufferStreamS …

Read is done at the position of MkBufferStreamS::storage->cur. After read the cur is incemented with read-sizeof characters.

Read is done at the position of MkBufferStreamS::storage->cur. After read the cur is incemented with read-sizeof characters.

Function Documentation

ReadALL()

MkBufferListC * ccmkkernel::MkBufferStreamC::ReadALL ( MkBufferListC * val_inout = NULL )

inline

C++: MkBufferListC* bus.ReadALL(MkBufferListC* val_inout = NULL) → C-API
get a temporary MkBufferListC from all data in the MkBufferStreamC …

Definition at line 219 of file MkBufferStreamC_inline_cc.hh.

                                                                           {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_BFL val_inout_hdl = MkBufferListC::getBFL(val_inout,MK_NULL_YES);
    enum MkErrorE errVal = MkBufferStreamReadALL(bus, &val_inout_hdl);
    MkErrorC_Check(bus, errVal);
    return MkBufferListC::MkBufferListC_ObjNew(MK_RT_CALL val_inout_hdl);
  }

ReadBFL()

MkBufferListC * ccmkkernel::MkBufferStreamC::ReadBFL ( )

inline

C++: MkBufferListC* bus.ReadBFL() → C-API
read a MkBufferListC from the MkBufferStreamC …

Definition at line 231 of file MkBufferStreamC_inline_cc.hh.

                                                   {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_BFL val_out;
    enum MkErrorE errVal = MkBufferStreamReadBFL(bus, &val_out);
    MkErrorC_Check(bus, errVal);
    return MkBufferListC::MkBufferListC_ObjNew(MK_RT_CALL val_out);
  }

ReadBIN()

MK_BNP ccmkkernel::MkBufferStreamC::ReadBIN ( )

inline

C++: doc_mk_cc_BufferStreamReadBIN → C-API
read a val_out from the MkBufferStreamC …

Definition at line 313 of file MkBufferStreamC_inline_cc.hh.

                                           {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MkBinaryR val_out_ref;
    enum MkErrorE errVal = MkBufferStreamReadBIN(bus, &val_out_ref);
    ErrorCheck(errVal);
    MK_BNP val_out = std::make_pair(val_out_ref.size,val_out_ref.data);
    return val_out;
  }

ReadBOL()

MK_BOL ccmkkernel::MkBufferStreamC::ReadBOL ( )

inline

C++: doc_mk_cc_BufferStreamReadBOL → C-API
read a val_out from the MkBufferStreamC …

Definition at line 324 of file MkBufferStreamC_inline_cc.hh.

                                           {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_BOL val_out;
    enum MkErrorE errVal = MkBufferStreamReadBOL(bus, &val_out);
    MkErrorC_Check(bus, errVal);
    return val_out != 0;
  }

ReadBUF()

MkBufferC * ccmkkernel::MkBufferStreamC::ReadBUF ( )

inline

C++: MkBufferC* bus.ReadBUF() → C-API
read a val_out from the MkBufferStreamC …

Definition at line 241 of file MkBufferStreamC_inline_cc.hh.

                                               {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_BUF val_out;
    enum MkErrorE errVal = MkBufferStreamReadBUF(bus, &val_out);
    MkErrorC_Check(bus, errVal);
    return MkBufferC::MkBufferC_ObjNew(MK_RT_CALL val_out);
  }

ReadDBL()

MK_DBL ccmkkernel::MkBufferStreamC::ReadDBL ( )

inline

C++: doc_mk_cc_BufferStreamReadDBL → C-API
read a val_out from the MkBufferStreamC …

Definition at line 334 of file MkBufferStreamC_inline_cc.hh.

                                           {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_DBL val_out;
    enum MkErrorE errVal = MkBufferStreamReadDBL(bus, &val_out);
    MkErrorC_Check(bus, errVal);
    return val_out;
  }

ReadFLT()

MK_FLT ccmkkernel::MkBufferStreamC::ReadFLT ( )

inline

C++: doc_mk_cc_BufferStreamReadFLT → C-API
read a val_out from the MkBufferStreamC …

Definition at line 344 of file MkBufferStreamC_inline_cc.hh.

                                           {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_FLT val_out;
    enum MkErrorE errVal = MkBufferStreamReadFLT(bus, &val_out);
    MkErrorC_Check(bus, errVal);
    return val_out;
  }

ReadGetNextType()

MkTypeE ccmkkernel::MkBufferStreamC::ReadGetNextType ( ) const

inline

C++: MkTypeE bus.ReadGetNextType() → C-API
get the type (MkTypeE) of the next Item in the MkBufferStreamC or "0" if not available

Definition at line 253 of file MkBufferStreamC_inline_cc.hh.

                                                         {
    MK_UNUSED auto bus = getBUSN(MK_NULL_NO);
    MkRtSetup_X(bus);
    enum MkTypeE __retVal__L = MkBufferStreamReadGetNextType(bus);
    return __retVal__L;
  }

ReadGetNumItems()

MK_NUM ccmkkernel::MkBufferStreamC::ReadGetNumItems ( ) const

inline

C++: MK_NUM bus.ReadGetNumItems() → C-API
get the number of items left in the MkBufferStreamC …

Definition at line 261 of file MkBufferStreamC_inline_cc.hh.

                                                        {
    MK_UNUSED auto bus = getBUSN(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_NUM __retVal__L = MkBufferStreamReadGetNumItems(bus);
    return __retVal__L;
  }

ReadI32()

MK_I32 ccmkkernel::MkBufferStreamC::ReadI32 ( )

inline

C++: doc_mk_cc_BufferStreamReadI32 → C-API
read a val_out from the MkBufferStreamC …

Definition at line 354 of file MkBufferStreamC_inline_cc.hh.

                                           {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_I32 val_out;
    enum MkErrorE errVal = MkBufferStreamReadI32(bus, &val_out);
    MkErrorC_Check(bus, errVal);
    return val_out;
  }

ReadI64()

MK_I64 ccmkkernel::MkBufferStreamC::ReadI64 ( )

inline

C++: doc_mk_cc_BufferStreamReadI64 → C-API
read a val_out from the MkBufferStreamC …

Definition at line 364 of file MkBufferStreamC_inline_cc.hh.

                                           {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_I64 val_out;
    enum MkErrorE errVal = MkBufferStreamReadI64(bus, &val_out);
    MkErrorC_Check(bus, errVal);
    return val_out;
  }

ReadI8()

MK_I8 ccmkkernel::MkBufferStreamC::ReadI8 ( )

inline

C++: doc_mk_cc_BufferStreamReadI8 → C-API
read a val_out from the MkBufferStreamC …

Definition at line 374 of file MkBufferStreamC_inline_cc.hh.

                                         {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_I8 val_out;
    enum MkErrorE errVal = MkBufferStreamReadI8(bus, &val_out);
    MkErrorC_Check(bus, errVal);
    return (MK_I8)val_out;
  }

ReadItemExists()

MK_BOOL ccmkkernel::MkBufferStreamC::ReadItemExists ( ) const

inline

C++: MK_BOOL bus.ReadItemExists() → C-API
check if an item exists in the read-data-package …

Definition at line 269 of file MkBufferStreamC_inline_cc.hh.

                                                        {
    MK_UNUSED auto bus = getBUSN(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_BOOL __retVal__L = MkBufferStreamReadItemExists(bus);
    return __retVal__L;
  }

ReadL_END()

void ccmkkernel::MkBufferStreamC::ReadL_END ( )

inline

C++: bus.ReadL_END() → C-API
END read a list-item-type from the MkBufferStreamC …

Definition at line 277 of file MkBufferStreamC_inline_cc.hh.

                                           {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    enum MkErrorE errVal = MkBufferStreamReadL_END(bus);
    MkErrorC_Check(bus, errVal);
  }

ReadL_START() [1/2]

void ccmkkernel::MkBufferStreamC::ReadL_START ( const MkBufferC & buf )

inline

C++: bus.ReadL_START(MkBufferC* buf = NULL) → C-API
START read a list-item-type from the MkBufferStreamC …

Definition at line 294 of file MkBufferStreamC_inline_cc.hh.

                                                                 {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    const MK_BUF buf_hdl = MkBufferC::getBUF(buf,MK_NULL_NO);
    enum MkErrorE errVal = MkBufferStreamReadL_START(bus, buf_hdl);
    MkErrorC_Check(bus, errVal);
  }

ReadL_START() [2/2]

void ccmkkernel::MkBufferStreamC::ReadL_START ( MkBufferC * buf = NULL )

inline

C++: bus.ReadL_START(MkBufferC* buf = NULL) → C-API
START read a list-item-type from the MkBufferStreamC …

Definition at line 285 of file MkBufferStreamC_inline_cc.hh.

                                                           {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_BUF buf_hdl = MkBufferC::getBUF(buf,MK_NULL_YES);
    enum MkErrorE errVal = MkBufferStreamReadL_START(bus, buf_hdl);
    MkErrorC_Check(bus, errVal);
  }

ReadLONG()

MK_LONG ccmkkernel::MkBufferStreamC::ReadLONG ( )

inline

C++: MK_LONG bus.ReadLONG() → C-API
read the long native object from the MkBufferStreamC …

Definition at line 384 of file MkBufferStreamC_inline_cc.hh.

                                             {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_LONG val_out;
    enum MkErrorE errVal = MkBufferStreamReadLONG(bus, &val_out);
    MkErrorC_Check(bus, errVal);
    return val_out;
  }

ReadSTR()

MK_STRN ccmkkernel::MkBufferStreamC::ReadSTR ( )

inline

C++: doc_mk_cc_BufferStreamReadSTR → C-API
read a val_out from the MkBufferStreamC …

Definition at line 394 of file MkBufferStreamC_inline_cc.hh.

                                            {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    MK_STRN val_out;
    enum MkErrorE errVal = MkBufferStreamReadSTR(bus, &val_out);
    MkErrorC_Check(bus, errVal);
    return val_out;
  }

ReadUndo()

void ccmkkernel::MkBufferStreamC::ReadUndo ( )

inline

C++: bus.ReadUndo() → C-API
undo the last MkBufferStreamC READ function call …

Definition at line 303 of file MkBufferStreamC_inline_cc.hh.

                                          {
    MK_UNUSED auto bus = getBUS(MK_NULL_NO);
    MkRtSetup_X(bus);
    enum MkErrorE errVal = MkBufferStreamReadUndo(bus);
    MkErrorC_Check(bus, errVal);
  }