Loading...
Searching...
No Matches
file_descriptor_source.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2004,2013 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H
#define INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H
#include <gnuradio/blocks/api.h>
#include <gnuradio/sync_block.h>
namespace gr {
namespace blocks {
/*!
* \brief Read stream from file descriptor.
* \ingroup file_operators_blk
*/
class BLOCKS_API file_descriptor_source : virtual public sync_block
{
protected:
virtual int read_items(char* buf, int nitems) = 0;
virtual int handle_residue(char* buf, int nbytes_read) = 0;
virtual void flush_residue() = 0;
public:
// gr::blocks::file_descriptor_source::sptr
typedef std::shared_ptr<file_descriptor_source> sptr;
/*!
* Build a file descriptor source block. The provided file descriptor will
* be closed when the sink is destroyed.
*
* \param itemsize item size of the incoming data stream.
* \param fd file descriptor (as an integer).
* \param repeat repeat the data stream continuously.
*/
static sptr make(size_t itemsize, int fd, bool repeat = false);
};
} /* namespace blocks */
} /* namespace gr */
#endif /* INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H */
gr::blocks::file_descriptor_source
Read stream from file descriptor.
Definition file_descriptor_source.h:26
gr::blocks::file_descriptor_source::flush_residue
virtual void flush_residue()=0
gr::blocks::file_descriptor_source::read_items
virtual int read_items(char *buf, int nitems)=0
gr::blocks::file_descriptor_source::handle_residue
virtual int handle_residue(char *buf, int nbytes_read)=0
gr::blocks::file_descriptor_source::sptr
std::shared_ptr< file_descriptor_source > sptr
Definition file_descriptor_source.h:34
gr::blocks::file_descriptor_source::make
static sptr make(size_t itemsize, int fd, bool repeat=false)
gr::blocks::repeat
repeat each input repeat times
Definition repeat.h:30
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
BLOCKS_API
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:18
gr::blocks
Definition abs_blk.h:20
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h