Memory Streams [Various]

Memory Streams. More...

Collaboration diagram for Memory Streams:

---

Description

Memory Streams.

This module allows to use a memory area (RAM or ROM) using a Data Streams interface.

Data Structures
struct	MemStreamVMT
	MemStream virtual methods table. More...
struct	MemoryStream
	Memory stream object. More...
Defines
#define	_memory_stream_data
	RamStream specific data.
Functions
void	msObjectInit (MemoryStream *msp, uint8_t *buffer, size_t size, size_t eos)
	Memory stream object initialization.

---

Define Documentation

#define _memory_stream_data

Value:

_base_sequential_stream_data                                              \
  /* Pointer to the stream buffer.*/                                        \
  uint8_t               *buffer;                                            \
  /* Size of the stream.*/                                                  \
  size_t                size;                                               \
  /* Current end of stream.*/                                               \
  size_t                eos;                                                \
  /* Current read offset.*/                                                 \
  size_t                offset;

RamStream specific data.

Definition at line 41 of file memstreams.h.

---

Function Documentation

void msObjectInit	(	MemoryStream *	msp,
		uint8_t *	buffer,
		size_t	size,
		size_t	eos
	)

Memory stream object initialization.

Parameters:

[out]	msp	pointer to the MemoryStream object to be initialized
[in]	buffer	pointer to the memory buffer for the memory stream
[in]	size	total size of the memory stream buffer
[in]	eos	initial End Of Stream offset. Normally you need to put this to zero for RAM buffers or equal to size for ROM streams.