MkBufferStreamC_C_API

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

Collaboration diagram for MkBufferStreamC_C_API:

Topics
	MkBufferStream64C
	MkBufferStream64S - the final class of abstract class MkBufferStreamC with 64 byte ILS-Size …
	MkBufferStream256C
	MkBufferStream256S - the final class of abstract class MkBufferStreamC with 256 byte ILS-Size …
	MkBufferStream1024C
	MkBufferStream1024S - the final class of abstract class MkBufferStreamC with 1024 byte ILS-Size …
	MkBufferStream16384C
	MkBufferStream16384S - the final class of abstract class MkBufferStreamC with 16384 byte ILS-Size …
	MkBufferStreamC_Class_C_API
	MkBufferStreamC - define the class …
	MkBufferStreamC_TOR_C_API
	MkBufferStreamC - various functions to create and destroy a MkBufferStreamC …
	MkBufferStreamC_Write_C_API
	MkBufferStreamC - various functions to write into a MkBufferStreamS …
	MkBufferStreamC_Read_C_API
	MkBufferStreamC - various functions to 'read' data from a MkBufferStreamS …
	MkBufferStreamC_Misc_C_API
	MkBufferStreamC - various functions to create and destroy a MkBufferStreamS …

Classes
struct	libmkkernel::MkBufferStreamS
	The ABSTRACT-CLASS MkBufferStreamS is used for package-based serialized IO … More...

Macros
#define	MkBufferStreamS_ils_size   (0)
	64 bytes I)instance L)ocal S)torage - the memory that adds the final-class to the abstract-class.

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 libmkkernel::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

Macro Definition Documentation

MkBufferStreamS_ils_size

#define MkBufferStreamS_ils_size   (0)

64 bytes I)instance L)ocal S)torage - the memory that adds the final-class to the abstract-class.

Definition at line 7036 of file LibMkKernel_mk.h.