theKernel 10.0
Loading...
Searching...
No Matches
MkBufferC_Get_CC_API

MkBufferC - various functions to get buffer-dataMore...

+ Collaboration diagram for MkBufferC_Get_CC_API:

Functions

MkBufferListCccmkkernel::MkBufferC::GetBFL (MkBufferListC *val_inout=NULL) const
  C++: MkBufferListC* buf.GetBFL(MkBufferListC* val_inout = NULL) C-API
function to read an MkBufferListC from an MkBufferC object …
 
MkBufferCccmkkernel::MkBufferC::GetBUF ()
  C++: MkBufferC* buf.GetBUF() C-API
get a val_out from a MkBufferC
 
MK_BNP ccmkkernel::MkBufferC::GetBIN () const
  C++: doc_mk_cc_BufferGetBIN C-API
get a val_out from a MkBufferC
 
MK_BOL ccmkkernel::MkBufferC::GetBOL () const
  C++: doc_mk_cc_BufferGetBOL C-API
get a val_out from a MkBufferC
 
MK_DBL ccmkkernel::MkBufferC::GetDBL () const
  C++: doc_mk_cc_BufferGetDBL C-API
get a val_out from a MkBufferC
 
MK_FLT ccmkkernel::MkBufferC::GetFLT () const
  C++: doc_mk_cc_BufferGetFLT C-API
get a val_out from a MkBufferC
 
MK_I16 ccmkkernel::MkBufferC::GetI16 () const
  C++: doc_mk_cc_BufferGetI16 C-API
get a val_out from a MkBufferC
 
MK_I32 ccmkkernel::MkBufferC::GetI32 () const
  C++: doc_mk_cc_BufferGetI32 C-API
get a val_out from a MkBufferC
 
MK_I64 ccmkkernel::MkBufferC::GetI64 () const
  C++: doc_mk_cc_BufferGetI64 C-API
get a val_out from a MkBufferC
 
MK_I8 ccmkkernel::MkBufferC::GetI8 () const
  C++: doc_mk_cc_BufferGetI8 C-API
get a val_out from a MkBufferC
 
MK_STRN ccmkkernel::MkBufferC::GetSTR () const
  C++: doc_mk_cc_BufferGetSTR C-API
get a val_out from a MkBufferC
 
std::string ccmkkernel::MkBufferC::GetStringR () const
  C++: std::string buf.GetStringR() C-API
get a val_out from a MkBufferC
 

Detailed Description

MkBufferC - various functions to get buffer-data

Function Documentation

◆ GetBFL()

MkBufferListC * ccmkkernel::MkBufferC::GetBFL ( MkBufferListC * val_inout = NULL) const
inline

C++: MkBufferListC* buf.GetBFL(MkBufferListC* val_inout = NULL) C-API
function to read an MkBufferListC from an MkBufferC object …

Definition at line 217 of file MkBufferC_inline_cc.hh.

217 {
218 MK_UNUSED auto buf = getBUFN();
219 MK_BFL val_inout_hdl = MkBufferListC::getBFL__null_allow(val_inout);
220 enum MkErrorE errVal = MkBufferGetBFL(buf, &val_inout_hdl);
221 MkErrorC_Check(buf, errVal);
223 }
#define MkErrorC_Check(errObj, errVal)
MK_BUFN getBUFN() const
(const) return the LibMsgqueObject from current MkBufferC instance
#define MkBufferGetBFL(...)
static MkBufferListC * MkBufferListC_ObjNew(MK_RT_ARGS MK_BFL hdl)
return MkBufferListC from LibMsgqueObject
MK_BFL getBFL__null_allow() const
return the LibMsgqueObject from current MkBufferListC instance
struct MkBufferListS * MK_BFL
class-shortcut for struct MkBufferListS *, all shortcut using the XX_YYY syntax (only for public API)...
#define MK_UNUSED
mark unnused variables and functions
MkErrorE
collection for the different error-codes …
#define MK_RT_CALL

◆ GetBIN()

MK_BNP ccmkkernel::MkBufferC::GetBIN ( ) const
inline

C++: doc_mk_cc_BufferGetBIN C-API
get a val_out from a MkBufferC

Definition at line 239 of file MkBufferC_inline_cc.hh.

239 {
240 MK_UNUSED auto buf = getBUFN();
241 MkBinaryR val_out_ref;
242 enum MkErrorE errVal = MkBufferGetBIN(buf, &val_out_ref);
243 ErrorCheck(errVal);
244 MK_BNP val_out = std::make_pair(val_out_ref.size,val_out_ref.data);
245 return val_out;
246 }
#define MkBufferGetBIN(...)
void ErrorCheck(enum MkErrorE err, MK_STRN const caller=__builtin_FUNCTION(), MK_I32 const line=__builtin_LINE()) const
std::pair< MK_SIZE, MK_BINN > MK_BNP

◆ GetBOL()

MK_BOL ccmkkernel::MkBufferC::GetBOL ( ) const
inline

C++: doc_mk_cc_BufferGetBOL C-API
get a val_out from a MkBufferC

Definition at line 249 of file MkBufferC_inline_cc.hh.

249 {
250 MK_UNUSED auto buf = getBUFN();
251 MK_BOL val_out;
252 enum MkErrorE errVal = MkBufferGetBOL(buf, &val_out);
253 MkErrorC_Check(buf, errVal);
254 return val_out != 0;
255 }
#define MkBufferGetBOL(...)
unsigned char MK_BOL
1 byte boolean data-type

◆ GetBUF()

MkBufferC * ccmkkernel::MkBufferC::GetBUF ( )
inline

C++: MkBufferC* buf.GetBUF() C-API
get a val_out from a MkBufferC

Definition at line 228 of file MkBufferC_inline_cc.hh.

228 {
229 MK_UNUSED auto buf = getBUF();
230 MK_BUF val_out;
231 enum MkErrorE errVal = MkBufferGetBUF(buf, &val_out);
232 MkErrorC_Check(buf, errVal);
234 }
static MkBufferC * MkBufferC_ObjNew(MK_RT_ARGS MK_BUF hdl)
return MkBufferC from LibMsgqueObject
MK_BUF getBUF() const
return the LibMsgqueObject from current MkBufferC instance
struct MkBufferS * MK_BUF
class-shortcut for struct MkBufferS *, all shortcut using the XX_YYY syntax (only for public API) …
#define MkBufferGetBUF(...)

◆ GetDBL()

MK_DBL ccmkkernel::MkBufferC::GetDBL ( ) const
inline

C++: doc_mk_cc_BufferGetDBL C-API
get a val_out from a MkBufferC

Definition at line 258 of file MkBufferC_inline_cc.hh.

258 {
259 MK_UNUSED auto buf = getBUFN();
260 MK_DBL val_out;
261 enum MkErrorE errVal = MkBufferGetDBL(buf, &val_out);
262 MkErrorC_Check(buf, errVal);
263 return val_out;
264 }
#define MkBufferGetDBL(...)
double MK_DBL
8 byte double data-type

◆ GetFLT()

MK_FLT ccmkkernel::MkBufferC::GetFLT ( ) const
inline

C++: doc_mk_cc_BufferGetFLT C-API
get a val_out from a MkBufferC

Definition at line 267 of file MkBufferC_inline_cc.hh.

267 {
268 MK_UNUSED auto buf = getBUFN();
269 MK_FLT val_out;
270 enum MkErrorE errVal = MkBufferGetFLT(buf, &val_out);
271 MkErrorC_Check(buf, errVal);
272 return val_out;
273 }
#define MkBufferGetFLT(...)
float MK_FLT
4 byte float data-type

◆ GetI16()

MK_I16 ccmkkernel::MkBufferC::GetI16 ( ) const
inline

C++: doc_mk_cc_BufferGetI16 C-API
get a val_out from a MkBufferC

Definition at line 276 of file MkBufferC_inline_cc.hh.

276 {
277 MK_UNUSED auto buf = getBUFN();
278 MK_I16 val_out;
279 enum MkErrorE errVal = MkBufferGetI16(buf, &val_out);
280 MkErrorC_Check(buf, errVal);
281 return val_out;
282 }
#define MkBufferGetI16(...)
signed short int MK_I16
2 byte short data-type

◆ GetI32()

MK_I32 ccmkkernel::MkBufferC::GetI32 ( ) const
inline

C++: doc_mk_cc_BufferGetI32 C-API
get a val_out from a MkBufferC

Definition at line 285 of file MkBufferC_inline_cc.hh.

285 {
286 MK_UNUSED auto buf = getBUFN();
287 MK_I32 val_out;
288 enum MkErrorE errVal = MkBufferGetI32(buf, &val_out);
289 MkErrorC_Check(buf, errVal);
290 return val_out;
291 }
#define MkBufferGetI32(...)
signed int MK_I32
4 byte integer data-type

◆ GetI64()

MK_I64 ccmkkernel::MkBufferC::GetI64 ( ) const
inline

C++: doc_mk_cc_BufferGetI64 C-API
get a val_out from a MkBufferC

Definition at line 294 of file MkBufferC_inline_cc.hh.

294 {
295 MK_UNUSED auto buf = getBUFN();
296 MK_I64 val_out;
297 enum MkErrorE errVal = MkBufferGetI64(buf, &val_out);
298 MkErrorC_Check(buf, errVal);
299 return val_out;
300 }
#define MkBufferGetI64(...)
signed long long MK_I64
8 byte wide integer data-type

◆ GetI8()

MK_I8 ccmkkernel::MkBufferC::GetI8 ( ) const
inline

C++: doc_mk_cc_BufferGetI8 C-API
get a val_out from a MkBufferC

Definition at line 303 of file MkBufferC_inline_cc.hh.

303 {
304 MK_UNUSED auto buf = getBUFN();
305 MK_I8 val_out;
306 enum MkErrorE errVal = MkBufferGetI8(buf, &val_out);
307 MkErrorC_Check(buf, errVal);
308 return (MK_I8)val_out;
309 }
#define MkBufferGetI8(...)
signed char MK_I8
1 byte byte data-type

◆ GetSTR()

MK_STRN ccmkkernel::MkBufferC::GetSTR ( ) const
inline

C++: doc_mk_cc_BufferGetSTR C-API
get a val_out from a MkBufferC

Definition at line 312 of file MkBufferC_inline_cc.hh.

312 {
313 MK_UNUSED auto buf = getBUFN();
314 MK_STRN val_out;
315 enum MkErrorE errVal = MkBufferGetSTR(buf, &val_out);
316 MkErrorC_Check(buf, errVal);
317 return val_out;
318 }
#define MkBufferGetSTR(...)
const MK_STRB * MK_STRN
constant string pointer data-type

◆ GetStringR()

std::string ccmkkernel::MkBufferC::GetStringR ( ) const
inline

C++: std::string buf.GetStringR() C-API
get a val_out from a MkBufferC

Definition at line 321 of file MkBufferC_inline_cc.hh.

321 {
322 MK_UNUSED auto buf = getBUFN();
323 MkStringR val_out_ref;
324 enum MkErrorE errVal = MkBufferGetStringR(buf, &val_out_ref);
325 ErrorCheck(errVal);
326 const std::string& val_out = std::string(val_out_ref.ptr,val_out_ref.len);
327 return val_out;
328 }
#define MkBufferGetStringR(...)