GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
file_descriptor_source.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2013 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23#ifndef INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H
24#define INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28
29
30namespace gr {
31namespace blocks {
32
33/*!
34 * \brief Read stream from file descriptor.
35 * \ingroup file_operators_blk
36 */
38{
39protected:
40 virtual int read_items(char* buf, int nitems) = 0;
41 virtual int handle_residue(char* buf, int nbytes_read) = 0;
42 virtual void flush_residue() = 0;
43
44public:
45 // gr::blocks::file_descriptor_source::sptr
46 typedef boost::shared_ptr<file_descriptor_source> sptr;
47
48 /*!
49 * Build a file descriptor source block. The provided file descriptor will
50 * be closed when the sink is destroyed.
51 *
52 * \param itemsize item size of the incoming data stream.
53 * \param fd file descriptor (as an integer).
54 * \param repeat repeat the data stream continuously.
55 */
56 static sptr make(size_t itemsize, int fd, bool repeat = false);
57};
58
59} /* namespace blocks */
60} /* namespace gr */
61
62#endif /* INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H */
Read stream from file descriptor.
Definition: file_descriptor_source.h:38
virtual int read_items(char *buf, int nitems)=0
virtual int handle_residue(char *buf, int nbytes_read)=0
boost::shared_ptr< file_descriptor_source > sptr
Definition: file_descriptor_source.h:46
static sptr make(size_t itemsize, int fd, bool repeat=false)
repeat each input repeat times
Definition: repeat.h:42
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
BLOCKS_API size_t itemsize(vector_type type)
Include this header to use the message passing features.
Definition: basic_block.h:45