GNU Radio 3.6.5 C++ API

file_descriptor_source.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2013 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H
00024 #define INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 
00030 namespace gr {
00031   namespace blocks {
00032 
00033     /*!
00034      * \brief Read stream from file descriptor.
00035      * \ingroup file_operators_blk
00036      */
00037     class BLOCKS_API file_descriptor_source : virtual public gr_sync_block
00038     {
00039     protected:
00040       virtual int read_items(char *buf, int nitems) = 0;
00041       virtual int handle_residue(char *buf, int nbytes_read) = 0;
00042       virtual void flush_residue() = 0;
00043 
00044     public:
00045       // gr::blocks::file_descriptor_source::sptr
00046       typedef boost::shared_ptr<file_descriptor_source> sptr;
00047 
00048       /*!
00049        * Build a file descriptor source block.
00050        *
00051        * \param itemsize item size of the incoming data stream.
00052        * \param fd file descriptor (as an integer).
00053        * \param repeat repeat the data stream continuously.
00054        */
00055       static sptr make(size_t itemsize, int fd, bool repeat);
00056     };
00057 
00058   } /* namespace blocks */
00059 } /* namespace gr */
00060 
00061 #endif /* INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H */