#include <sampleinstream_intf.h>
Inherits adtf::ucom::ant::IObject.
|
|
| ~ISampleInStream ()=default |
| | not destructable
|
| |
|
| ~IObject ()=default |
| | Protected destructor --> Only the final implementation can be destroyed!
|
| |
The ISampleInStream interface is return by the ISampleStream::Open call which allows to read from a corresponding reader of the opened ISampleStream instance.
- See also
- ISampleStream, sample stream
◆ GetMode()
◆ Read()
| virtual tResult adtf::streaming::ant::ISampleInStream::Read |
( |
IStreamItem & | oItem, |
|
|
tTimeStamp | tmTimeOut = 0 ) const |
|
pure virtual |
This will read one Queue Item from the readers queue.
- Warning
- If working in ISampleStreamAccess::tMode::PushRead you are recommended to read until the Read return with ERR_EMPTY. Otherwise the queue items are lost !
- Parameters
-
| oItem | [out] Item interface to set the event to. See IStreamItem for default implementation provided. |
| tmTimeOut | [in] if tmTimeOut == 0 ... non blocking call, it will return immediatelly. if tmTimeOut < 0 ... blocking call, wait infinite time. if tmTimeOut > 0 ... blocking call, wait specified tmTimeOut time (in microsec). |
- Returns
- Standard Result Code
- Return values
-
| ERR_NOERROR | A item was read into oItem |
| ERR_EMPTY | Queue is empty. |
| ERR_TIMEOUT | No items in queue in the specified tmTimeOut. (only at blocking call)! |
◆ SetStreamError()
| virtual tResult adtf::streaming::ant::ISampleInStream::SetStreamError |
( |
const tResult & | oError | ) |
|
|
pure virtual |
Forward an error to the corresponding stream.
- Parameters
-
| oError | [in] The error passed to the SampleStream. |
- Returns
- Standard Result Code.
The documentation for this class was generated from the following file:
Public Member Functions inherited from adtf::ucom::ant::IObject