fifo.hpp

Go to the documentation of this file.

/*
 The Real-Time eXperiment Interface (RTXI)
 Copyright (C) 2011 Georgia Institute of Technology, University of Utah,
 Will Cornell Medical College

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program. If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef FIFO_H
#define FIFO_H

#include <memory>

#include <sys/types.h>

namespace RT::OS
{
class Fifo
{
public:
 Fifo() = default; // default constructor
 Fifo(const Fifo& fifo) = delete; // copy constructor
 Fifo& operator=(const Fifo& fifo) = delete; // copy assignment operator
 Fifo(Fifo&&) = default; // move constructor
 Fifo& operator=(Fifo&&) = default; // move assignment operator
 virtual ~Fifo() = default;

 virtual int64_t read(void* buf, size_t data_size) = 0;

 virtual int64_t write(void* buf, size_t data_size) = 0;

 virtual int64_t readRT(void* buf, size_t data_size) = 0;

 virtual int64_t writeRT(void* buf, size_t data_size) = 0;

 virtual size_t getCapacity() = 0;

 virtual void poll() = 0;

 virtual void close() = 0;
};

int getFifo(std::unique_ptr<Fifo>& fifo, size_t fifo_size);
} // namespace RT::OS

#endif /* FIFO_H */