adtf::ucom::IInputStream Class Reference

#include <stream_intf.h>

Inherits adtf::ucom::ant::IObject.

Inherited by adtf::ucom::ant::IStream.

Public Member Functions
	ADTF_IID (IInputStream, "input_stream.ant.ucom.adtf.iid")
virtual tResult	Read (void *pvBuffer, size_t nBufferSize, size_t *pnBytesRead=nullptr) const=0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Additional Inherited Members
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

An interface for reading data from a stream.

Member Function Documentation

ADTF_IID()

adtf::ucom::ant::IInputStream::ADTF_IID	(	IInputStream	,
		"input_stream.ant.ucom.adtf.iid"	)

Marks the IInputStream to be castable with the ucom_cast<>

See also

ADTF_IID(_interface, _striid)

Read()

virtual tResult adtf::ucom::ant::IInputStream::Read ( void * pvBuffer, size_t nBufferSize, size_t * pnBytesRead = nullptr ) const

pure virtual

Read data from stream. The Read method reads data from a stream.

Parameters

pvBuffer	[in] Pointer to an existing buffer.
nBufferSize	[in] Size in bytes of the existing buffer.
pnBytesRead	[in,out] Pointer to a variable that receives the number of bytes that actually have been read.

Returns

Returns a standard result code.

---

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

• src/libraries/ucom3/include/adtfucom3/interfaces/stream_intf.h