Used to abstract a memory read stream. More...

Inheritance diagram for OmniPvdReadStream:

Public Member Functions
virtual uint64_t OMNI_PVD_CALL	readBytes (uint8_t *bytes, const uint64_t nbrBytes)=0
	Read n bytes from the shared memory buffer.

virtual uint64_t OMNI_PVD_CALL	skipBytes (const uint64_t nbrBytes)=0
	Skip n bytes from the shared memory buffer.

virtual bool OMNI_PVD_CALL	openStream ()=0
	Opens the read stream.

virtual bool OMNI_PVD_CALL	closeStream ()=0
	Closes the read stream.

Detailed Description

Used to abstract a memory read stream.

Allows to read and skip bytes as well as open/close it.

Member Function Documentation

virtual bool OMNI_PVD_CALL OmniPvdReadStream::closeStream ( )

pure virtual

Closes the read stream.

virtual bool OMNI_PVD_CALL OmniPvdReadStream::openStream ( )

pure virtual

Opens the read stream.

virtual uint64_t OMNI_PVD_CALL OmniPvdReadStream::readBytes	(	uint8_t *	bytes,
		const uint64_t	nbrBytes
	)

pure virtual

Read n bytes from the shared memory buffer.

Parameters

bytes	Reads n bytes into the destination pointer
nbrBytes	The requested number of bytes to read

virtual uint64_t OMNI_PVD_CALL OmniPvdReadStream::skipBytes ( const uint64_t nbrBytes )

pure virtual

Skip n bytes from the shared memory buffer.

Parameters

nbrBytes The requested number of bytes to skip

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