Dokumentacja klasy common::LimitOverlayStream
[Moduł Stream]

Nakładka na strumień ograniczająca liczbę odczytywanych i zapisywanych bajtów. Więcej...

#include <Stream.hpp>

Diagram dziedziczenia dla common::LimitOverlayStream

Lista wszystkich składowych.

Metody publiczne
	LimitOverlayStream (Stream *a_Stream, uint4 WriteLimit, uint4 ReadLimit)
virtual void	Write (const void *Data, size_t Size)
	Zapisuje dane.
virtual size_t	Read (void *Data, size_t Size)
	Odczytuje dane.
virtual void	Flush ()
void	SetWriteLimit (uint4 WriteLimit)
	Ustawia nowy limit.
void	SetReadLimit (uint4 ReadLimit)
	Ustawia nowy limit.

---

Opis szczegółowy

Nakładka na strumień ograniczająca liczbę odczytywanych i zapisywanych bajtów.

Jesli przekroczy limit podczas zapisywania, zapisuje ile się da i rzuca błąd zapisu. Jeśli przekroczy limit podczas odczytywania zachowuje się tak, jakby strumień osiągnął koniec.

---

Dokumentacja konstruktora i destruktora

common::LimitOverlayStream::LimitOverlayStream	(	Stream *	a_Stream,
		uint4	WriteLimit,
		uint4	ReadLimit
	)

---

Dokumentacja funkcji składowych

virtual void common::LimitOverlayStream::Write	(	const void *	Data,
		size_t	Size
	)			[virtual]

Zapisuje dane.

(W oryginale: zgłasza błąd)

Reimplementowana z common::Stream.

virtual size_t common::LimitOverlayStream::Read	(	void *	Data,
		size_t	MaxLength
	)			[virtual]

Odczytuje dane.

Jeśli osiągnięto koniec, funkcja nie zwraca błędu, a liczba odczytanych bajtów to 0. (W oryginale: zgłasza błąd)

Parametry:

Size

Liczba bajtów do odczytania

Zwraca:

Zwraca liczbę bajtów, jakie udało się odczytać

Reimplementowana z common::Stream.

virtual void common::LimitOverlayStream::Flush

(

)

[virtual]

Reimplementowana z common::OverlayStream.

void common::LimitOverlayStream::SetWriteLimit

(

uint4

WriteLimit

)

Ustawia nowy limit.

void common::LimitOverlayStream::SetReadLimit

(

uint4

ReadLimit

)

Ustawia nowy limit.

---

Dokumentacja dla tej klasy została wygenerowana z pliku:

• Stream.hpp