openDAQ
Open data acquisition platform
IPacketReader Struct Referenceabstract

A signal reader reads packets from a signal data stream. More...

+ Inheritance diagram for IPacketReader:
+ Collaboration diagram for IPacketReader:

Detailed Description

A signal reader reads packets from a signal data stream.

Public Member Functions

virtual ErrCode INTERFACE_FUNC read (IPacket **packet)=0
 Retrieves the next available packet in the data-stream. More...
 
virtual ErrCode INTERFACE_FUNC readAll (IList **packets)=0
 Retrieves all the currently available packets in the data-stream. More...
 
- Public Member Functions inherited from IReader
virtual ErrCode INTERFACE_FUNC getAvailableCount (SizeT *count)=0
 Gets the number of segments available to read. More...
 
virtual ErrCode INTERFACE_FUNC setOnDataAvailable (IProcedure *callback)=0
 Sets the specified callback function to be called when there is available data in the reader. Pass nullptr to unset the callback. The callback should take no arguments. More...
 
virtual ErrCode INTERFACE_FUNC getEmpty (Bool *empty)=0
 Checks if there is data to read. More...
 
- Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC borrowInterface (const IntfID &intfID, void **obj) const =0
 Returns another interface which is supported by the object without incrementing the reference count. More...
 
virtual ErrCode INTERFACE_FUNC dispose ()=0
 Disposes all references held by the object. More...
 
virtual ErrCode INTERFACE_FUNC getHashCode (SizeT *hashCode)=0
 Returns hash code of the object. More...
 
virtual ErrCode INTERFACE_FUNC equals (IBaseObject *other, Bool *equal) const =0
 Compares object to another object for equality. More...
 
virtual ErrCode INTERFACE_FUNC toString (CharPtr *str)=0
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC queryInterface (const IntfID &intfID, void **obj)=0
 Returns another interface which is supported by the object and increments the reference count. More...
 
virtual int INTERFACE_FUNC addRef ()=0
 Increments the reference count for an interface on an object. More...
 
virtual int INTERFACE_FUNC releaseRef ()=0
 Decrements the reference count for an interface on an object. More...
 

Member Function Documentation

◆ read()

virtual ErrCode INTERFACE_FUNC read ( IPacket **  packet)
pure virtual

Retrieves the next available packet in the data-stream.

Parameters
[out]packetThe next available packet or nullptr if not are available.

◆ readAll()

virtual ErrCode INTERFACE_FUNC readAll ( IList **  packets)
pure virtual

Retrieves all the currently available packets in the data-stream.

Parameters
[out]packetsThe currently available packets or an empty list.