trikRuntime
trikHal::FifoInterface Class Referenceabstract

Abstraction of Linux FIFO used to receive events. To write to FIFO, use OutputDeviceFileInterface. More...

#include <fifoInterface.h>

Inheritance diagram for trikHal::FifoInterface:
Collaboration diagram for trikHal::FifoInterface:

Signals

void newData (const QString &data)
 Emitted when new data is read from FIFO. More...
 
void readError ()
 Emitted when something is wrong with opened FIFO file and reading failed. More...
 

Public Member Functions

virtual bool open ()=0
 Opens FIFO file and starts listening for events. More...
 
virtual bool close ()=0
 Closes FIFO file and stops listening for events. More...
 
virtual QString fileName ()=0
 Returns file name of a FIFO file. More...
 

Detailed Description

Abstraction of Linux FIFO used to receive events. To write to FIFO, use OutputDeviceFileInterface.

Member Function Documentation

virtual bool trikHal::FifoInterface::close ( )
pure virtual

Closes FIFO file and stops listening for events.

Returns
true, if closed successfully.

Implemented in trikHal::trik::TrikFifo, and trikHal::stub::StubFifo.

virtual QString trikHal::FifoInterface::fileName ( )
pure virtual

Returns file name of a FIFO file.

Implemented in trikHal::trik::TrikFifo, and trikHal::stub::StubFifo.

void trikHal::FifoInterface::newData ( const QString &  data)
signal

Emitted when new data is read from FIFO.

virtual bool trikHal::FifoInterface::open ( )
pure virtual

Opens FIFO file and starts listening for events.

Returns
true, if opened successfully.

Implemented in trikHal::trik::TrikFifo, and trikHal::stub::StubFifo.

void trikHal::FifoInterface::readError ( )
signal

Emitted when something is wrong with opened FIFO file and reading failed.

It may be caused, for example, by another process reading from the same FIFO, it may partially read data.


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