theKernel 10.0 NHI1 - theKernel - theLink - theConfig - theSq3Lite - theCompiler - theBrain - theGuard
c - tcl - py - rb - jv - cc
Loading...
Searching...
No Matches
MkBufferStreamC_Read_C_API

MkBufferStreamC - various functions to 'read' data from a MkBufferStreamSMore...

+ Collaboration diagram for MkBufferStreamC_Read_C_API:

Functions

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadL_START_RT (MK_RT mkrt, MK_BUS const bus, MK_BUF buf)
 START read a list-item-type from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadL_END_RT (MK_RT mkrt, MK_BUS const bus)
 END read a list-item-type from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadALL_RT (MK_RT mkrt, MK_BUS const bus, MK_BFL *const val_inout)
 get a temporary MkBufferListC from all data in the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBFL_RT (MK_RT mkrt, MK_BUS const bus, MK_BFL *const val_out)
 read a MkBufferListC from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadLIST_RT (MK_RT mkrt, MK_BUS const bus, MK_NAT_LIST *const val_out)
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadNEXT_RT (MK_RT mkrt, MK_BUS const bus, MK_NAT_OBJECT *const val_out)
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadLONG_RT (MK_RT mkrt, MK_BUS const bus, MK_LONG *const val_out)
 read the long native object from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadI8_RT (MK_RT mkrt, MK_BUS const bus, MK_I8 *const val_out)
 read a val_out from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBOL_RT (MK_RT mkrt, MK_BUS const bus, MK_BOL *const val_out)
 read a val_out from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadI32_RT (MK_RT mkrt, MK_BUS const bus, MK_I32 *const val_out)
 read a val_out from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadFLT_RT (MK_RT mkrt, MK_BUS const bus, MK_FLT *const val_out)
 read a val_out from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadI64_RT (MK_RT mkrt, MK_BUS const bus, MK_I64 *const val_out)
 read a val_out from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadDBL_RT (MK_RT mkrt, MK_BUS const bus, MK_DBL *const val_out)
 read a val_out from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadSTR_RT (MK_RT mkrt, MK_BUS const bus, MK_STRN *const val_out)
 read a val_out from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBIN_RT (MK_RT mkrt, MK_BUS const bus, MkBinaryR *const val_out)
 read a val_out from the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBUF_RT (MK_RT mkrt, MK_BUS const bus, MK_BUF *const val_out)
 read a val_out from the MkBufferStreamC
 
MK_EXTERN bool libmkkernel::MkBufferStreamReadItemExists_RT (MK_RT mkrt, MK_BUSN const bus)
 check if an item exists in the read-data-package
 
MK_EXTERN enum MkTypeE libmkkernel::MkBufferStreamReadGetNextType_RT (MK_RT mkrt, MK_BUSN const bus)
 get the type (MkTypeE) of the next Item in the MkBufferStreamC or "0" if not available
 
MK_EXTERN MK_NUM libmkkernel::MkBufferStreamReadGetNumItems_RT (MK_RT mkrt, MK_BUSN const bus)
 get the number of items left in the MkBufferStreamC
 
MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadUndo_RT (MK_RT mkrt, MK_BUS const bus)
 undo the last MkBufferStreamC READ function call …
 

MkBufferStreamC - MkBufferStreamC_Read_C_API - overload

#define MkBufferStreamReadALL_NULL(...)
 
#define MkBufferStreamReadALL(...)
 
#define MkBufferStreamReadALL_E(...)
 
#define MkBufferStreamReadALL_C(...)
 
#define MkBufferStreamReadALL_e(...)
 
#define MkBufferStreamReadBFL_NULL(...)
 
#define MkBufferStreamReadBFL(...)
 
#define MkBufferStreamReadBFL_E(...)
 
#define MkBufferStreamReadBFL_C(...)
 
#define MkBufferStreamReadBFL_e(...)
 
#define MkBufferStreamReadBUF_NULL(...)
 
#define MkBufferStreamReadBUF(...)
 
#define MkBufferStreamReadBUF_E(...)
 
#define MkBufferStreamReadBUF_C(...)
 
#define MkBufferStreamReadBUF_e(...)
 
#define MkBufferStreamReadGetNextType_NULL(...)
 
#define MkBufferStreamReadGetNextType(...)
 
#define MkBufferStreamReadGetNumItems_NULL(...)
 
#define MkBufferStreamReadGetNumItems(...)
 
#define MkBufferStreamReadItemExists_NULL(...)
 
#define MkBufferStreamReadItemExists(...)
 
#define MkBufferStreamReadL_END_NULL(...)
 
#define MkBufferStreamReadL_END(...)
 
#define MkBufferStreamReadL_END_E(...)
 
#define MkBufferStreamReadL_END_C(...)
 
#define MkBufferStreamReadL_START_NULL(...)
 
#define MkBufferStreamReadL_START(...)
 
#define MkBufferStreamReadL_START_1(bus)
 
#define MkBufferStreamReadL_START_E(...)
 
#define MkBufferStreamReadL_START_C(...)
 
#define MkBufferStreamReadUndo_NULL(...)
 
#define MkBufferStreamReadUndo(...)
 
#define MkBufferStreamReadUndo_E(...)
 
#define MkBufferStreamReadUndo_C(...)
 
#define MkBufferStreamReadBIN_NULL(...)
 
#define MkBufferStreamReadBIN(...)
 
#define MkBufferStreamReadBIN_E(...)
 
#define MkBufferStreamReadBIN_C(...)
 
#define MkBufferStreamReadBIN_e(...)
 
#define MkBufferStreamReadBOL_NULL(...)
 
#define MkBufferStreamReadBOL(...)
 
#define MkBufferStreamReadBOL_E(...)
 
#define MkBufferStreamReadBOL_C(...)
 
#define MkBufferStreamReadBOL_e(...)
 
#define MkBufferStreamReadDBL_NULL(...)
 
#define MkBufferStreamReadDBL(...)
 
#define MkBufferStreamReadDBL_E(...)
 
#define MkBufferStreamReadDBL_C(...)
 
#define MkBufferStreamReadDBL_e(...)
 
#define MkBufferStreamReadFLT_NULL(...)
 
#define MkBufferStreamReadFLT(...)
 
#define MkBufferStreamReadFLT_E(...)
 
#define MkBufferStreamReadFLT_C(...)
 
#define MkBufferStreamReadFLT_e(...)
 
#define MkBufferStreamReadI32_NULL(...)
 
#define MkBufferStreamReadI32(...)
 
#define MkBufferStreamReadI32_E(...)
 
#define MkBufferStreamReadI32_C(...)
 
#define MkBufferStreamReadI32_e(...)
 
#define MkBufferStreamReadI64_NULL(...)
 
#define MkBufferStreamReadI64(...)
 
#define MkBufferStreamReadI64_E(...)
 
#define MkBufferStreamReadI64_C(...)
 
#define MkBufferStreamReadI64_e(...)
 
#define MkBufferStreamReadI8_NULL(...)
 
#define MkBufferStreamReadI8(...)
 
#define MkBufferStreamReadI8_E(...)
 
#define MkBufferStreamReadI8_C(...)
 
#define MkBufferStreamReadI8_e(...)
 
#define MkBufferStreamReadLONG_NULL(...)
 
#define MkBufferStreamReadLONG(...)
 
#define MkBufferStreamReadLONG_E(...)
 
#define MkBufferStreamReadLONG_C(...)
 
#define MkBufferStreamReadLONG_e(...)
 
#define MkBufferStreamReadSTR_NULL(...)
 
#define MkBufferStreamReadSTR(...)
 
#define MkBufferStreamReadSTR_E(...)
 
#define MkBufferStreamReadSTR_C(...)
 
#define MkBufferStreamReadSTR_e(...)
 

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.

Macro Definition Documentation

◆ MkBufferStreamReadALL

#define MkBufferStreamReadALL ( ...)
Value:
MkBufferStreamReadALL_RT(MK_RT_CALL __VA_ARGS__)
#define MK_RT_CALL

Definition at line 722 of file kernel_overload_mk.h.

◆ MkBufferStreamReadALL_C

#define MkBufferStreamReadALL_C ( ...)
Value:
#define MkErrorCheckI(err)
#define MkBufferStreamReadALL(...)

Definition at line 724 of file kernel_overload_mk.h.

◆ MkBufferStreamReadALL_E

#define MkBufferStreamReadALL_E ( ...)
Value:
#define MkErrorCheck(err)
check return-code and goto error on error …

Definition at line 723 of file kernel_overload_mk.h.

◆ MkBufferStreamReadALL_e

#define MkBufferStreamReadALL_e ( ...)
Value:
#define MK_EMBEDDED(type, call,...)
macro to create "embedded" (*_e) Version of C-API call's

Definition at line 725 of file kernel_overload_mk.h.

◆ MkBufferStreamReadALL_NULL

#define MkBufferStreamReadALL_NULL ( ...)
Value:
MkBufferStreamReadALL_RT(MK_RT_CALL_NULL __VA_ARGS__)
#define MK_RT_CALL_NULL

Definition at line 721 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBFL

#define MkBufferStreamReadBFL ( ...)
Value:
MkBufferStreamReadBFL_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 729 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBFL_C

#define MkBufferStreamReadBFL_C ( ...)
Value:
#define MkBufferStreamReadBFL(...)

Definition at line 731 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBFL_E

#define MkBufferStreamReadBFL_E ( ...)
Value:

Definition at line 730 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBFL_e

#define MkBufferStreamReadBFL_e ( ...)
Value:

Definition at line 732 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBFL_NULL

#define MkBufferStreamReadBFL_NULL ( ...)
Value:
MkBufferStreamReadBFL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 728 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBIN

#define MkBufferStreamReadBIN ( ...)
Value:
MkBufferStreamReadBIN_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 762 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBIN_C

#define MkBufferStreamReadBIN_C ( ...)
Value:
#define MkBufferStreamReadBIN(...)

Definition at line 764 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBIN_E

#define MkBufferStreamReadBIN_E ( ...)
Value:

Definition at line 763 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBIN_e

#define MkBufferStreamReadBIN_e ( ...)
Value:
MK_EMBEDDED_REF(MkBinaryR,MkBufferStreamReadBIN,__VA_ARGS__)
#define MK_EMBEDDED_REF(type, call,...)
macro to create "embedded" (*_e) Version of C-API call's

Definition at line 765 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBIN_NULL

#define MkBufferStreamReadBIN_NULL ( ...)
Value:
MkBufferStreamReadBIN_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 761 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBOL

#define MkBufferStreamReadBOL ( ...)
Value:
MkBufferStreamReadBOL_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 767 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBOL_C

#define MkBufferStreamReadBOL_C ( ...)
Value:
#define MkBufferStreamReadBOL(...)

Definition at line 769 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBOL_E

#define MkBufferStreamReadBOL_E ( ...)
Value:

Definition at line 768 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBOL_e

#define MkBufferStreamReadBOL_e ( ...)
Value:

Definition at line 770 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBOL_NULL

#define MkBufferStreamReadBOL_NULL ( ...)
Value:
MkBufferStreamReadBOL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 766 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBUF

#define MkBufferStreamReadBUF ( ...)
Value:
MkBufferStreamReadBUF_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 734 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBUF_C

#define MkBufferStreamReadBUF_C ( ...)
Value:
#define MkBufferStreamReadBUF(...)

Definition at line 736 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBUF_E

#define MkBufferStreamReadBUF_E ( ...)
Value:

Definition at line 735 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBUF_e

#define MkBufferStreamReadBUF_e ( ...)
Value:

Definition at line 737 of file kernel_overload_mk.h.

◆ MkBufferStreamReadBUF_NULL

#define MkBufferStreamReadBUF_NULL ( ...)
Value:
MkBufferStreamReadBUF_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 733 of file kernel_overload_mk.h.

◆ MkBufferStreamReadDBL

#define MkBufferStreamReadDBL ( ...)
Value:
MkBufferStreamReadDBL_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 772 of file kernel_overload_mk.h.

◆ MkBufferStreamReadDBL_C

#define MkBufferStreamReadDBL_C ( ...)
Value:
#define MkBufferStreamReadDBL(...)

Definition at line 774 of file kernel_overload_mk.h.

◆ MkBufferStreamReadDBL_E

#define MkBufferStreamReadDBL_E ( ...)
Value:

Definition at line 773 of file kernel_overload_mk.h.

◆ MkBufferStreamReadDBL_e

#define MkBufferStreamReadDBL_e ( ...)
Value:

Definition at line 775 of file kernel_overload_mk.h.

◆ MkBufferStreamReadDBL_NULL

#define MkBufferStreamReadDBL_NULL ( ...)
Value:
MkBufferStreamReadDBL_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 771 of file kernel_overload_mk.h.

◆ MkBufferStreamReadFLT

#define MkBufferStreamReadFLT ( ...)
Value:
MkBufferStreamReadFLT_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 777 of file kernel_overload_mk.h.

◆ MkBufferStreamReadFLT_C

#define MkBufferStreamReadFLT_C ( ...)
Value:
#define MkBufferStreamReadFLT(...)

Definition at line 779 of file kernel_overload_mk.h.

◆ MkBufferStreamReadFLT_E

#define MkBufferStreamReadFLT_E ( ...)
Value:

Definition at line 778 of file kernel_overload_mk.h.

◆ MkBufferStreamReadFLT_e

#define MkBufferStreamReadFLT_e ( ...)
Value:

Definition at line 780 of file kernel_overload_mk.h.

◆ MkBufferStreamReadFLT_NULL

#define MkBufferStreamReadFLT_NULL ( ...)
Value:
MkBufferStreamReadFLT_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 776 of file kernel_overload_mk.h.

◆ MkBufferStreamReadGetNextType

#define MkBufferStreamReadGetNextType ( ...)
Value:
MkBufferStreamReadGetNextType_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 741 of file kernel_overload_mk.h.

◆ MkBufferStreamReadGetNextType_NULL

#define MkBufferStreamReadGetNextType_NULL ( ...)
Value:
MkBufferStreamReadGetNextType_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 740 of file kernel_overload_mk.h.

◆ MkBufferStreamReadGetNumItems

#define MkBufferStreamReadGetNumItems ( ...)
Value:
MkBufferStreamReadGetNumItems_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 743 of file kernel_overload_mk.h.

◆ MkBufferStreamReadGetNumItems_NULL

#define MkBufferStreamReadGetNumItems_NULL ( ...)
Value:
MkBufferStreamReadGetNumItems_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 742 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI32

#define MkBufferStreamReadI32 ( ...)
Value:
MkBufferStreamReadI32_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 782 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI32_C

#define MkBufferStreamReadI32_C ( ...)
Value:
#define MkBufferStreamReadI32(...)

Definition at line 784 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI32_E

#define MkBufferStreamReadI32_E ( ...)
Value:

Definition at line 783 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI32_e

#define MkBufferStreamReadI32_e ( ...)
Value:

Definition at line 785 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI32_NULL

#define MkBufferStreamReadI32_NULL ( ...)
Value:
MkBufferStreamReadI32_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 781 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI64

#define MkBufferStreamReadI64 ( ...)
Value:
MkBufferStreamReadI64_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 787 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI64_C

#define MkBufferStreamReadI64_C ( ...)
Value:
#define MkBufferStreamReadI64(...)

Definition at line 789 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI64_E

#define MkBufferStreamReadI64_E ( ...)
Value:

Definition at line 788 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI64_e

#define MkBufferStreamReadI64_e ( ...)
Value:

Definition at line 790 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI64_NULL

#define MkBufferStreamReadI64_NULL ( ...)
Value:
MkBufferStreamReadI64_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 786 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI8

#define MkBufferStreamReadI8 ( ...)
Value:
MkBufferStreamReadI8_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 792 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI8_C

#define MkBufferStreamReadI8_C ( ...)
Value:
#define MkBufferStreamReadI8(...)

Definition at line 794 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI8_E

#define MkBufferStreamReadI8_E ( ...)
Value:

Definition at line 793 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI8_e

#define MkBufferStreamReadI8_e ( ...)
Value:

Definition at line 795 of file kernel_overload_mk.h.

◆ MkBufferStreamReadI8_NULL

#define MkBufferStreamReadI8_NULL ( ...)
Value:
MkBufferStreamReadI8_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 791 of file kernel_overload_mk.h.

◆ MkBufferStreamReadItemExists

#define MkBufferStreamReadItemExists ( ...)
Value:
MkBufferStreamReadItemExists_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 745 of file kernel_overload_mk.h.

◆ MkBufferStreamReadItemExists_NULL

#define MkBufferStreamReadItemExists_NULL ( ...)
Value:
MkBufferStreamReadItemExists_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 744 of file kernel_overload_mk.h.

◆ MkBufferStreamReadL_END

#define MkBufferStreamReadL_END ( ...)
Value:
MkBufferStreamReadL_END_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 747 of file kernel_overload_mk.h.

◆ MkBufferStreamReadL_END_C

#define MkBufferStreamReadL_END_C ( ...)
Value:
#define MkBufferStreamReadL_END(...)

Definition at line 749 of file kernel_overload_mk.h.

◆ MkBufferStreamReadL_END_E

#define MkBufferStreamReadL_END_E ( ...)
Value:

Definition at line 748 of file kernel_overload_mk.h.

◆ MkBufferStreamReadL_END_NULL

#define MkBufferStreamReadL_END_NULL ( ...)
Value:
MkBufferStreamReadL_END_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 746 of file kernel_overload_mk.h.

◆ MkBufferStreamReadL_START

#define MkBufferStreamReadL_START ( ...)
Value:
MkBufferStreamReadL_START_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 751 of file kernel_overload_mk.h.

◆ MkBufferStreamReadL_START_1

#define MkBufferStreamReadL_START_1 ( bus)
Value:
#define MkBufferStreamReadL_START(...)

Definition at line 752 of file kernel_overload_mk.h.

◆ MkBufferStreamReadL_START_C

#define MkBufferStreamReadL_START_C ( ...)
Value:

Definition at line 754 of file kernel_overload_mk.h.

◆ MkBufferStreamReadL_START_E

#define MkBufferStreamReadL_START_E ( ...)
Value:

Definition at line 753 of file kernel_overload_mk.h.

◆ MkBufferStreamReadL_START_NULL

#define MkBufferStreamReadL_START_NULL ( ...)
Value:
MkBufferStreamReadL_START_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 750 of file kernel_overload_mk.h.

◆ MkBufferStreamReadLONG

#define MkBufferStreamReadLONG ( ...)
Value:
MkBufferStreamReadLONG_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 797 of file kernel_overload_mk.h.

◆ MkBufferStreamReadLONG_C

#define MkBufferStreamReadLONG_C ( ...)
Value:
#define MkBufferStreamReadLONG(...)

Definition at line 799 of file kernel_overload_mk.h.

◆ MkBufferStreamReadLONG_E

#define MkBufferStreamReadLONG_E ( ...)
Value:

Definition at line 798 of file kernel_overload_mk.h.

◆ MkBufferStreamReadLONG_e

#define MkBufferStreamReadLONG_e ( ...)
Value:
MK_EMBEDDED(MK_LONG,MkBufferStreamReadLONG,__VA_ARGS__)

Definition at line 800 of file kernel_overload_mk.h.

◆ MkBufferStreamReadLONG_NULL

#define MkBufferStreamReadLONG_NULL ( ...)
Value:
MkBufferStreamReadLONG_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 796 of file kernel_overload_mk.h.

◆ MkBufferStreamReadSTR

#define MkBufferStreamReadSTR ( ...)
Value:
MkBufferStreamReadSTR_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 802 of file kernel_overload_mk.h.

◆ MkBufferStreamReadSTR_C

#define MkBufferStreamReadSTR_C ( ...)
Value:
#define MkBufferStreamReadSTR(...)

Definition at line 804 of file kernel_overload_mk.h.

◆ MkBufferStreamReadSTR_E

#define MkBufferStreamReadSTR_E ( ...)
Value:

Definition at line 803 of file kernel_overload_mk.h.

◆ MkBufferStreamReadSTR_e

#define MkBufferStreamReadSTR_e ( ...)
Value:
MK_EMBEDDED(MK_STRN,MkBufferStreamReadSTR,__VA_ARGS__)

Definition at line 805 of file kernel_overload_mk.h.

◆ MkBufferStreamReadSTR_NULL

#define MkBufferStreamReadSTR_NULL ( ...)
Value:
MkBufferStreamReadSTR_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 801 of file kernel_overload_mk.h.

◆ MkBufferStreamReadUndo

#define MkBufferStreamReadUndo ( ...)
Value:
MkBufferStreamReadUndo_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 756 of file kernel_overload_mk.h.

◆ MkBufferStreamReadUndo_C

#define MkBufferStreamReadUndo_C ( ...)
Value:
#define MkBufferStreamReadUndo(...)

Definition at line 758 of file kernel_overload_mk.h.

◆ MkBufferStreamReadUndo_E

#define MkBufferStreamReadUndo_E ( ...)
Value:

Definition at line 757 of file kernel_overload_mk.h.

◆ MkBufferStreamReadUndo_NULL

#define MkBufferStreamReadUndo_NULL ( ...)
Value:
MkBufferStreamReadUndo_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 755 of file kernel_overload_mk.h.

Function Documentation

◆ MkBufferStreamReadALL_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadALL_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_BFL *const val_inout )

get a temporary MkBufferListC from all data in the MkBufferStreamC

If the val_inout is NULL than a temporary MkBufferListC is returned. If the val_inout is not NULL than the memory of the val_inout is reused.

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[in,out]val_inoutthe MkBufferListC - the storage of the input is reused
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
See also
BufferStreamReadBFL
Attention
(do not free) The memory of the out/return value belongs to the called CcMkKernel function and therefore never becomes MK_NULL for a non-error result.
For details on the out/return value, see: MkKernel_Storage_C_API.

◆ MkBufferStreamReadBFL_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBFL_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_BFL *const val_out )

read a MkBufferListC from the MkBufferStreamC

The MkBufferListC represent a list-item-type (libmkkernel::MK_LSTT from the MkBufferStreamC. A list-item-type is created with bus.WriteL_START() and bus.WriteL_END() and collect multiple items into one item, the list-item-type.

A list-item-type can have an other list-item-type as item, this create a tree-like structure of items.

If the next item in the read-data-package is not a list-item-type than an error is raised. To get all data in the read-data-package as one single MkBufferListC use the MqReadALL.

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe MkBufferListC as return-value
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
See also
BufferStreamReadALL BufferStreamWriteBFL
Attention
(do not free) The memory of the out/return value belongs to the called CcMkKernel function and therefore never becomes MK_NULL for a non-error result.
For details on the out/return value, see: MkKernel_Storage_C_API.

◆ MkBufferStreamReadBIN_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBIN_RT ( MK_RT mkrt,
MK_BUS const bus,
MkBinaryR *const val_out )

read a val_out from the MkBufferStreamC

The MkBufferStreamReadTT style of functions always return a val_out or a MkErrorC.

Precondition
The val_out can be a PRIMITIVE TYPE, a class-type or a pointer-type (binary, string etc).
After every read the current-access-position is incremented by one to get the next item for the next read.
To reset the current-access-position to the start use bus.PosToStart().
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe new value
Attention
In general MkBinaryR is owned by the called function, to get your own copy use MkBinaryDup.

◆ MkBufferStreamReadBOL_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBOL_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_BOL *const val_out )

read a val_out from the MkBufferStreamC

The MkBufferStreamReadTT style of functions always return a val_out or a MkErrorC.

Precondition
The val_out can be a PRIMITIVE TYPE, a class-type or a pointer-type (binary, string etc).
After every read the current-access-position is incremented by one to get the next item for the next read.
To reset the current-access-position to the start use bus.PosToStart().
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe new value

◆ MkBufferStreamReadBUF_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadBUF_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_BUF *const val_out )

read a val_out from the MkBufferStreamC

The MkBufferStreamReadTT style of functions always return a val_out or a MkErrorC.

Precondition
The val_out can be a PRIMITIVE TYPE, a class-type or a pointer-type (binary, string etc).
After every read the current-access-position is incremented by one to get the next item for the next read.
To reset the current-access-position to the start use bus.PosToStart().
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe new value

◆ MkBufferStreamReadDBL_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadDBL_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_DBL *const val_out )

read a val_out from the MkBufferStreamC

The MkBufferStreamReadTT style of functions always return a val_out or a MkErrorC.

Precondition
The val_out can be a PRIMITIVE TYPE, a class-type or a pointer-type (binary, string etc).
After every read the current-access-position is incremented by one to get the next item for the next read.
To reset the current-access-position to the start use bus.PosToStart().
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe new value

◆ MkBufferStreamReadFLT_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadFLT_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_FLT *const val_out )

read a val_out from the MkBufferStreamC

The MkBufferStreamReadTT style of functions always return a val_out or a MkErrorC.

Precondition
The val_out can be a PRIMITIVE TYPE, a class-type or a pointer-type (binary, string etc).
After every read the current-access-position is incremented by one to get the next item for the next read.
To reset the current-access-position to the start use bus.PosToStart().
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe new value

◆ MkBufferStreamReadGetNextType_RT()

MK_EXTERN enum MkTypeE libmkkernel::MkBufferStreamReadGetNextType_RT ( MK_RT mkrt,
MK_BUSN const bus )

get the type (MkTypeE) of the next Item in the MkBufferStreamC or "0" if not available

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
Returns
the type

◆ MkBufferStreamReadGetNumItems_RT()

MK_EXTERN MK_NUM libmkkernel::MkBufferStreamReadGetNumItems_RT ( MK_RT mkrt,
MK_BUSN const bus )

get the number of items left in the MkBufferStreamC

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
Returns
the number of items as integer

◆ MkBufferStreamReadI32_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadI32_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_I32 *const val_out )

read a val_out from the MkBufferStreamC

The MkBufferStreamReadTT style of functions always return a val_out or a MkErrorC.

Precondition
The val_out can be a PRIMITIVE TYPE, a class-type or a pointer-type (binary, string etc).
After every read the current-access-position is incremented by one to get the next item for the next read.
To reset the current-access-position to the start use bus.PosToStart().
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe new value

◆ MkBufferStreamReadI64_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadI64_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_I64 *const val_out )

read a val_out from the MkBufferStreamC

The MkBufferStreamReadTT style of functions always return a val_out or a MkErrorC.

Precondition
The val_out can be a PRIMITIVE TYPE, a class-type or a pointer-type (binary, string etc).
After every read the current-access-position is incremented by one to get the next item for the next read.
To reset the current-access-position to the start use bus.PosToStart().
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe new value

◆ MkBufferStreamReadI8_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadI8_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_I8 *const val_out )

read a val_out from the MkBufferStreamC

The MkBufferStreamReadTT style of functions always return a val_out or a MkErrorC.

Precondition
The val_out can be a PRIMITIVE TYPE, a class-type or a pointer-type (binary, string etc).
After every read the current-access-position is incremented by one to get the next item for the next read.
To reset the current-access-position to the start use bus.PosToStart().
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe new value

◆ MkBufferStreamReadItemExists_RT()

MK_EXTERN bool libmkkernel::MkBufferStreamReadItemExists_RT ( MK_RT mkrt,
MK_BUSN const bus )

check if an item exists in the read-data-package

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
Returns
boolean, true or false

◆ MkBufferStreamReadL_END_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadL_END_RT ( MK_RT mkrt,
MK_BUS const bus )

END read a list-item-type from the MkBufferStreamC

◆ MkBufferStreamReadL_START_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadL_START_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_BUF buf )

START read a list-item-type from the MkBufferStreamC

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[in]bufMK_NULL or a MkBufferC with a list-item-type or an error is raised.
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MkBufferStreamReadLIST_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadLIST_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_NAT_LIST *const val_out )

◆ MkBufferStreamReadLONG_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadLONG_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_LONG *const val_out )

read the long native object from the MkBufferStreamC

on 64bit use a BufferStreamReadI32 and on 32bit use a BufferStreamReadI64

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe native long object to read
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Attention
this api-function is NOT portable
See also
bus.WriteLONG(MK_LONG val)

◆ MkBufferStreamReadNEXT_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadNEXT_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_NAT_OBJECT *const val_out )

◆ MkBufferStreamReadSTR_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadSTR_RT ( MK_RT mkrt,
MK_BUS const bus,
MK_STRN *const val_out )

read a val_out from the MkBufferStreamC

The MkBufferStreamReadTT style of functions always return a val_out or a MkErrorC.

Precondition
The val_out can be a PRIMITIVE TYPE, a class-type or a pointer-type (binary, string etc).
After every read the current-access-position is incremented by one to get the next item for the next read.
To reset the current-access-position to the start use bus.PosToStart().
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
[out]val_outthe new value

◆ MkBufferStreamReadUndo_RT()

MK_EXTERN enum MkErrorE libmkkernel::MkBufferStreamReadUndo_RT ( MK_RT mkrt,
MK_BUS const bus )

undo the last MkBufferStreamC READ function call …

Decrement the current-access-position by one, to the start of the last read body-item. The next read function call will extract the same item again. Only one undo level is supported.

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]busthe MkBufferStreamS instance to work on
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)