csmkkernel.MkBufferStreamC Class Reference

MkBufferStreamC - the abstract class known as bus or stream is a subclass of MkBufferC and is used for package-based-io … More...

Inheritance diagram for csmkkernel.MkBufferStreamC:

Collaboration diagram for csmkkernel.MkBufferStreamC:

Public Member Functions
new MkBufferStreamC	Next ()
	C#: MkBufferStreamC bus.Next() → C-API get next instance from linked-list of MkBufferStreamS type
new MkBufferStreamC	Prev ()
	C#: MkBufferStreamC bus.Prev() → C-API get previous instance from linked-list of MkBufferStreamS type
MkBufferStreamC	Copy (MkBufferStreamC src)
	C#: MkBufferStreamC bus.Copy(MkBufferStreamC src) → C-API copy the MkBufferStreamC from src to bus …
MkBufferStreamC	Reset ()
	C#: MkBufferStreamC bus.Reset() → C-API reset a MkBufferStreamC to the length zero …
MkBufferListC	ToBFL ()
	C#: MkBufferListC bus.ToBFL() → C-API convert the bus into a MkBufferListC …
void	PosToStart ()
	C#: bus.PosToStart() → C-API set the current-access-position to the start of MkBufferStreamC …
void	ResetFull ()
	C#: bus.ResetFull() → C-API reset a MkBufferStreamC to the length zero and free allocated storage…
MkBufferListC	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	ReadBFL ()
	C#: MkBufferListC bus.ReadBFL() → C-API read a MkBufferListC from the MkBufferStreamC …
MkBufferC	ReadBUF ()
	C#: MkBufferC bus.ReadBUF() → C-API read a val_out from the MkBufferStreamC …
MkTypeE	ReadGetNextType ()
	C#: MkTypeE bus.ReadGetNextType() → C-API get the type (MkTypeE) of the next Item in the MkBufferStreamC or "0" if not available
int	ReadGetNumItems ()
	C#: int bus.ReadGetNumItems() → C-API get the number of items left in the MkBufferStreamC …
bool	ReadItemExists ()
	C#: bool bus.ReadItemExists() → C-API check if an item exists in the read-data-package …
void	ReadL_END ()
	C#: bus.ReadL_END() → C-API END read a list-item-type from the MkBufferStreamC …
void	ReadL_START (MkBufferC buf=null)
	C#: bus.ReadL_START(MkBufferC buf = null) → C-API START read a list-item-type from the MkBufferStreamC …
void	ReadUndo ()
	C#: bus.ReadUndo() → C-API undo the last MkBufferStreamC READ function call …
byte[]	ReadBIN ()
	C#: doc_mk_cs_BufferStreamReadBIN → C-API read a val_out from the MkBufferStreamC …
bool	ReadBOL ()
	C#: doc_mk_cs_BufferStreamReadBOL → C-API read a val_out from the MkBufferStreamC …
double	ReadDBL ()
	C#: doc_mk_cs_BufferStreamReadDBL → C-API read a val_out from the MkBufferStreamC …
float	ReadFLT ()
	C#: doc_mk_cs_BufferStreamReadFLT → C-API read a val_out from the MkBufferStreamC …
int	ReadI32 ()
	C#: doc_mk_cs_BufferStreamReadI32 → C-API read a val_out from the MkBufferStreamC …
long	ReadI64 ()
	C#: doc_mk_cs_BufferStreamReadI64 → C-API read a val_out from the MkBufferStreamC …
byte	ReadI8 ()
	C#: doc_mk_cs_BufferStreamReadI8 → C-API read a val_out from the MkBufferStreamC …
long	ReadLONG ()
	C#: long bus.ReadLONG() → C-API read the long native object from the MkBufferStreamC …
string	ReadSTR ()
	C#: doc_mk_cs_BufferStreamReadSTR → C-API read a val_out from the MkBufferStreamC …
MkBufferStreamC	Merge ()
	C#: [constructor] MkBufferStreamC bus.Merge() → C-API Merge-Constructor - create a new MkBufferStreamC as a merge from an existing object …
MkBufferStreamC	Dup ()
	C#: [constructor] MkBufferStreamC src.Dup() → C-API Dup-Constructor - create a new MkBufferStreamC instance as copy from an existing MkBufferStreamC instance …
	MkBufferStreamC (int size=0)
	CONSTRUCTOR.
void	WriteBFL (MkBufferListC bfl)
	C#: bus.WriteBFL(MkBufferListC bfl) → C-API write a MkBufferListC into the MkBufferStreamC …
void	WriteBIN (byte[] val)
	C#: doc_mk_cs_BufferStreamWriteBIN → C-API write a PRIMITIVE TYPE into the MkBufferStreamC …
void	WriteBOL (bool val)
	C#: doc_mk_cs_BufferStreamWriteBOL → C-API write a PRIMITIVE TYPE into the MkBufferStreamC …
void	WriteBUF (MkBufferC val)
	C#: bus.WriteBUF(MkBufferC val) → C-API write a PRIMITIVE TYPE into the MkBufferStreamC …
void	WriteBUS_FLAT (MkBufferStreamC add)
	C#: bus.WriteBUS_FLAT(MkBufferStreamC add) → C-API write a MkBufferStreamC into the MkBufferStreamC …
void	WriteDBL (double val)
	C#: doc_mk_cs_BufferStreamWriteDBL → C-API write a PRIMITIVE TYPE into the MkBufferStreamC …
void	WriteFLT (float val)
	C#: doc_mk_cs_BufferStreamWriteFLT → C-API write a PRIMITIVE TYPE into the MkBufferStreamC …
void	WriteHDL (int val)
	C#: bus.WriteHDL(int val) → C-API write the handle into the MkBufferStreamC …
void	WriteI32 (int val)
	C#: doc_mk_cs_BufferStreamWriteI32 → C-API write a PRIMITIVE TYPE into the MkBufferStreamC …
void	WriteI64 (long val)
	C#: doc_mk_cs_BufferStreamWriteI64 → C-API write a PRIMITIVE TYPE into the MkBufferStreamC …
void	WriteI8 (byte val)
	C#: doc_mk_cs_BufferStreamWriteI8 → C-API write a PRIMITIVE TYPE into the MkBufferStreamC …
void	WriteLONG (long val)
	C#: bus.WriteLONG(long val) → C-API write the long native object into the MkBufferStreamC …
void	WriteL_END ()
	C#: bus.WriteL_END() → C-API END write a list-item-type into the MkBufferStreamC …
void	WriteL_FLAT (MkBufferListC bfl)
	C#: bus.WriteL_FLAT(MkBufferListC bfl) → C-API write a MkBufferListC FLAT into the MkBufferStreamC …
void	WriteL_START ()
	C#: bus.WriteL_START() → C-API START write a list-item-type into the MkBufferStreamC …
void	WriteSTR (string val, int len=-1)
	C#: doc_mk_cs_BufferStreamWriteSTR → C-API write a PRIMITIVE TYPE into the MkBufferStreamC …
Public Member Functions inherited from csmkkernel.MkObjectC
delegate void	MkObjectDeleteSCB (string typeName, int typeHdl, int objHdl)
	implements the csmkkernel API object: public version from MkObjectDeleteSCB as method
void	ErrorCheck (MkErrorE err)
bool	Check ()
string	ToNameOfClass ()
	C#: string obj.ToNameOfClass() → C-API Class-Slot - returns the C#-Class-Name of the obj as string
void	HandleDelete ()
	C#: netObj.HandleDelete() → C-API Handle-Delete-Slot - delete a netObj from handle-storage …
bool	HandleExists ()
	C#: bool obj.HandleExists() → C-API check if obj has already a handle defined…
Int32	HandleGet ()
	C#: Int32 obj.HandleGet() → C-API Handle-Get-Slot - returns a export-hdl to the MkObjectC useable for external storage
Int32	HandleGetOfType ()
	C#: Int32 obj.HandleGetOfType() → C-API Export-Slot - returns typeHdl of the obj .
Int32	HandleGetOr0 ()
	C#: Int32 obj.HandleGetOr0() → C-API return export-hdl or 0 in not created…
MkObjectC	Next ()
	C#: MkObjectC obj.Next() → C-API get next instance from linked-list of MkObjectS type
MkObjectC	Prev ()
	C#: MkObjectC obj.Prev() → C-API get previous instance from linked-list of MkObjectS type
void	DbgDump (string message="var", [CallerMemberName]string callfunc=null)
	C#: obj.DbgDump(string message = "var", [CallerMemberName]string callfunc = null) → C-API debug: Dump a instance to stderr with LNG and MQ internal data…
void	DbgL (string message, int debug=0, [CallerMemberName]string callfunc=null, int lvl=0)
	C#: fmtobj.DbgL(string message, int debug = 0, [CallerMemberName]string callfunc = null, int lvl = 0) → C-API debug: write a instance-marker to the MkLogFileC (default: stderr) using the fmtobj as prefix …
void	DbgLogC ([CallerMemberName]string callfunc=null)
	C#: obj.DbgLogC([CallerMemberName]string callfunc = null) → C-API debug: write a short-obj-summary to MkLogFileC (default: stderr) …
void	DbgO ([CallerMemberName]string callfunc=null)
	C#: obj.DbgO([CallerMemberName]string callfunc = null) → C-API debug: write the object-details to MkLogFileC (default: stderr) …
void	DbgSTACK (int skip=0, int num=-1, [CallerMemberName]string callfunc=null)
	C#: fmtobj.DbgSTACK(int skip = 0, int num = -1, [CallerMemberName]string callfunc = null) → C-API debug: write the stack-trace to MkLogFileC (default: stderr) …
void	LogC (string message, int debug=0, [CallerMemberName]string callfunc=null)
	C#: fmtobj.LogC(string message, int debug = 0, [CallerMemberName]string callfunc = null) → C-API write a logging-message to MkLogFileC (default: stderr) using the internal format …
void	LogHEX (string callfunc, byte[] data)
	C#: fmtobj.LogHEX(string callfunc, byte[] data) → C-API log binaray data as HEX into the MkLogFileC (default: stderr) …
void	Log (MkObjectC fmtobj=null, int debug=0, [CallerMemberName]string callfunc=null, int lvl=0)
	C#: obj.Log(MkObjectC fmtobj = null, int debug = 0, [CallerMemberName]string callfunc = null, int lvl = 0) → C-API Log-Slot - log a summary of an object to the MkLogFileC (default: stderr) target …
void	LogLong (MkObjectC fmtobj=null, int debug=0, [CallerMemberName]string callfunc=null, int lvl=0)
	C#: obj.LogLong(MkObjectC fmtobj = null, int debug = 0, [CallerMemberName]string callfunc = null, int lvl = 0) → C-API log the MkObjectS verbose into the MkLogFileC (default: stderr) …
void	LogShort (MkObjectC fmtobj=null, int debug=0, [CallerMemberName]string callfunc=null, int lvl=0)
	C#: obj.LogShort(MkObjectC fmtobj = null, int debug = 0, [CallerMemberName]string callfunc = null, int lvl = 0) → C-API log the MkObjectS into the MkLogFileC (default: stderr) …
void	LogType (MkObjectC fmtobj=null, int debug=0, [CallerMemberName]string callfunc=null, int lvl=0)
	C#: obj.LogType(MkObjectC fmtobj = null, int debug = 0, [CallerMemberName]string callfunc = null, int lvl = 0) → C-API log the tyoe of the MkObjectS into the MkLogFileC (default: stderr) …
MkErrorC	ErrorCatch (Exception exception=null, [CallerMemberName]string callfunc=null)
	C#: MkErrorC obj.ErrorCatch(Exception exception = null, [CallerMemberName]string callfunc = null) → C-API convert a programming-language-error into an csmkkernel error …
MkErrorC	ToError ()
	C#: MkErrorC obj.ToError() → C-API Error-Slot - return an error-object pre initialized with obj data.
bool	IsNull ()
	C#: bool obj.IsNull() → C-API ckeck if the object is null
string	ToName ()
	C#: string obj.ToName() → C-API Info-Slot - returns brief information about the obj as a string
string	ToNameOfType ()
	C#: string obj.ToNameOfType() → C-API Type-Slot - returns the LibMkKernel-Type-Name of the obj as a string
override string	ToString ()
	C#: string inst.ToString() → C-API String-Slot - returns the string representation of the inst …
int	RefGet ()
	MkRefGetP
void	SysKill (int pid, int signal)
	MkSysKill
int	SysGetPid ()
	MkSysGetPid
void	Dispose ()
	C#: [destructor] obj.Dispose() → C-API Dispose-Slot - untie the connection between the Native-C#-Instance and the csmkkernel-Instance.
void	Delete ()
	C#: [destructor] obj.Delete() → C-API Delete-Slot - delete an instance.

Static Public Member Functions
static MkBufferStreamC	MkBufferStreamC_ObjNew (IntPtr hdl)
new static MkBufferStreamC	HandleResolve (Int32 netHdl)
	C#: [static] MkBufferStreamC MkBufferStreamC.HandleResolve(Int32 netHdl) → C-API Handle-Resolve-Slot - return a MkBufferStreamC from netHdl or null if invalid…
new static MkBufferStreamC	Instances ()
	C#: [static] MkBufferStreamC MkBufferStreamC.Instances() → C-API get head-instance from linked-list of MkBufferStreamS type …
new static MkBufferStreamC	GetNull ()
	C#: [static] MkBufferStreamC MkBufferStreamC.GetNull() → C-API Null-Slot - return a MkBufferStreamC typed NULL instance …
static MkBufferStreamC	Create (int size=0)
	C#: [constructor,static] MkBufferStreamC MkBufferStreamC.Create(int size = 0) → C-API create and initialize an MkBufferStreamC instance …
static MkBufferStreamC	Create1024 (int size=0)
	C#: [constructor,static] MkBufferStreamC MkBufferStreamC.Create1024(int size = 0) → C-API call the BufferStreamCreate with default type MkBufferStream1024S (1024 byte) …
static MkBufferStreamC	Create16384 (int size=0)
	C#: [constructor,static] MkBufferStreamC MkBufferStreamC.Create16384(int size = 0) → C-API call the BufferStreamCreate with default type MkBufferStream16384S (16384 byte) …
static MkBufferStreamC	Create256 (int size=0)
	C#: [constructor,static] MkBufferStreamC MkBufferStreamC.Create256(int size = 0) → C-API call the BufferStreamCreate with default type MkBufferStream256S (256 byte) …
static MkBufferStreamC	Create64 (int size=0)
	C#: [constructor,static] MkBufferStreamC MkBufferStreamC.Create64(int size = 0) → C-API call the BufferStreamCreate with default type MkBufferStream64S (64 byte) …
static MkBufferStreamC	CreateTLS (string tlsName, bool resetB=true)
	C#: [static] MkBufferStreamC MkBufferStreamC.CreateTLS(string tlsName, bool resetB = true) → C-API same as BufferStreamCreate but require no cleanup …
Static Public Member Functions inherited from csmkkernel.MkObjectC
static MkObjectC	MkObjectC_ObjNew (IntPtr hdl)
static IntPtr	getOBJ (string cls, MkObjectC obj)
static IntPtr	getOBJ_null_allow (MkObjectC obj)
static MkObjectC	HandleResolve (Int32 netHdl)
	C#: [static] MkObjectC MkObjectC.HandleResolve(Int32 netHdl) → C-API Handle-Resolve-Slot - return a MkObjectC from netHdl or null if invalid…
static void	HandleDeleteByNetHdl (Int32 netHdl)
	C#: [static] MkObjectC.HandleDeleteByNetHdl(Int32 netHdl) → C-API Handle-Delete-Slot - delete a netHdl from handle-storage …
static MkObjectC	Instances ()
	C#: [static] MkObjectC MkObjectC.Instances() → C-API get head-instance from linked-list of MkObjectS type …
static MkObjectC	GetNull ()
	C#: [static] MkObjectC MkObjectC.GetNull() → C-API Null-Slot - return a MkObjectC typed NULL instance …
static void	DbgM (string message, int debug=0, [CallerMemberName]string callfunc=null, int lvl=0)
	C#: [static] MkObjectC.DbgM(string message, int debug = 0, [CallerMemberName]string callfunc = null, int lvl = 0) → C-API debug: write a static-marker to the MkLogFileC (default: stderr) …
static int	SysHashI32 (string key, int length=-1)
	MkSysHashI32
static string	SysHashSTR (string key, int length=-1)
	MkSysHashSTR
static void	DeleteCallbackCleanup (string ident)
	C#: [static] MkObjectC.DeleteCallbackCleanup(string ident) → C-API cleanup the DeleteCallback installed with MkObjectDeleteCallbackSetup …
static void	DeleteCallbackSetup (string ident, MkObjectDeleteSCB callback=null, string filter=null)
	C#: [static] MkObjectC.DeleteCallbackSetup(string ident, MkObjectDeleteSCB callback = null, string filter = null) → C-API Create/Delete the instance-delete-callback …
static int	getPId ()
static int	getTId ()
static string	getStackTrace (int level=2)
static string	getCallerProc (int level=2)
static int	getCallerLine (int level=2)
static string	getCallerFile (int level=2)

Static Protected Member Functions
static IntPtr	CTOR (int size=0)
	C#: [constructor,static] MkBufferStreamC MkBufferStreamC.Create(int size = 0) → C-API create and initialize an MkBufferStreamC instance …
Static Protected Member Functions inherited from csmkkernel.MkObjectC
static object	atomObjNew (Type type, ConstructorInfo ctor, IntPtr obj)
static object	atomObjCreate (Type type, ConstructorInfo ctor, IntPtr obj)
static IntPtr	atomSelfCreate (ConstructorInfo ctor, IntPtr obj, IntPtr env)
static object	atomSelfNull (ConstructorInfo ctor)
static void	atomSelfUnlink (IntPtr self, IntPtr env)
static ConstructorInfo	getCtor (Type type)
static string	Name (IntPtr mkrt, IntPtr obj)
	C#: string obj.ToName() → C-API Info-Slot - returns brief information about the obj as a string

Additional Inherited Members
Protected Member Functions inherited from csmkkernel.MkObjectC
	MkObjectC (IntPtr obj)
	MkObjectC ()
virtual void	Dispose (bool disposing)
	Support IDisposable.
Protected Attributes inherited from csmkkernel.MkObjectC
IntPtr	pmkrt = IntPtr.Zero
Package Functions inherited from csmkkernel.MkObjectC
Static Package Functions inherited from csmkkernel.MkObjectC
Properties inherited from csmkkernel.MkObjectC
IntPtr	hdl [get, set]
IntPtr	hdl_null_allow [get, set]
IntPtr	mkrt [get, set]

Detailed Description

MkBufferStreamC - the abstract class known as bus or stream is a subclass of MkBufferC and is used for package-based-io …

The MkBufferStreamC is required to send data via a socket (pipe,tcp,uds,...). The data is organized as a continuous binary-array. Each item is preceded by type and, if applicable, size information.

‍See also: MkBufferC, MkBufferListC

C-Kernel-Details

The ABSTRACT-CLASS MkBufferStreamS has the private-parent-class MkBufferS and is used to store typed-data in a continuous binary-array at MkBufferS::storage.

private-parent-class mean:

MkBufferStreamS use the features of MkBufferS but does not expose the API

In addition to the binary-array the MkBufferStreamS also include features like:

1. the encoding: MkBufferStreamS::endian_is_wrong
2. the total number of items: MkBufferStreamS::numItems
3. current position pointer: MkBufferStreamS::cur
4. support for recursion: embedding a MkBufferStreamS into a MkBufferStreamS

The MkBufferStreamS inherits the following features from MkBufferS:

1. the storage: MkBufferS::storage
2. the type: MkBufferS::type
3. the ILS: MkBufferS::ils

The ABSTRACT-CLASS MkBufferStreamS is missing the ILS-storage, the FINAL-CLASSES are:

‍MkBufferStream16384S, MkBufferStream256S, MkBufferStream64S and MkBufferStream1024S

See also

MkBufferC, MkBufferListC

Definition at line 569 of file MkBufferStreamC.cs.

Member Function Documentation

MkBufferStreamC_ObjNew()

static MkBufferStreamC csmkkernel.MkBufferStreamC.MkBufferStreamC_ObjNew ( IntPtr hdl )

inlinestatic

Definition at line 34 of file MkBufferStreamC.cs.

                                                                      {
      return hdl != IntPtr.Zero ? (MkBufferStreamC) atomObjNew(typeof(MkBufferStreamC), ctor, hdl) : MK_NULL.Value;
    }

Here is the caller graph for this function:

---

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

• MkBufferStreamC.cs