Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

Unigine::StreamBase Class

Unigine Base Stream class.

To use this class, include the UnigineStream.h file.

Unigine::StreamBase Class

Members


StreamBase ()

Constructor.

virtual ~StreamBase ()

Virtual destructor.

Ptr< Stream > getStream () const

Returns a stream pointer.

Return value

The stream pointer.

virtual int isOpened () =0

Returns the status of the stream.

Return value

1 if stream is opened; otherwise, 0.

virtual int isAvailable () =0

Return the status of the stream.

Return value

1 if stream is available; otherwise, 0.

virtual size_t read (void * ptr, size_t size, size_t nmemb) =0

Reads the number of bytes from the stream.

Arguments

  • void * ptr - Destination buffer pointer.
  • size_t size - Size of the buffer in bytes.
  • size_t nmemb - Number of memory blocks to read.

Return value

The number of read bytes.

virtual size_t write (const void * ptr, size_t size, size_t nmemb) =0

Writes the number of bytes to the stream.

Arguments

  • const void * ptr - Source buffer pointer.
  • size_t size - Size of the buffer in bytes.
  • size_t nmemb - Number of memory blocks to write.

Return value

The number of written bytes.
Last update: 2017-07-03