GNU Radio 3.6.0 C++ API
filedes_to_blob.h
Go to the documentation of this file.
00001 /*
00002  * Copyright 2011-2012 Free Software Foundation, Inc.
00003  * 
00004  * This file is part of GNU Radio
00005  * 
00006  * GNU Radio is free software; you can redistribute it and/or modify
00007  * it under the terms of the GNU General Public License as published by
00008  * the Free Software Foundation; either version 3, or (at your option)
00009  * any later version.
00010  * 
00011  * GNU Radio is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  * 
00016  * You should have received a copy of the GNU General Public License
00017  * along with GNU Radio; see the file COPYING.  If not, write to
00018  * the Free Software Foundation, Inc., 51 Franklin Street,
00019  * Boston, MA 02110-1301, USA.
00020  */
00021 
00022 #ifndef INCLUDED_GR_EXTRAS_FILEDES_TO_BLOB_H
00023 #define INCLUDED_GR_EXTRAS_FILEDES_TO_BLOB_H
00024 
00025 #include <gnuradio/extras/api.h>
00026 #include <gr_sync_block.h>
00027 
00028 namespace gnuradio{ namespace extras{
00029 
00030 class GR_EXTRAS_API filedes_to_blob : virtual public gr_sync_block{
00031 public:
00032     typedef boost::shared_ptr<filedes_to_blob> sptr;
00033 
00034     /*!
00035      * \brief Make a file descriptor to blob block
00036      *
00037      * Read packets/bytes from a file descriptor
00038      * and post blob messages to the "blob" subscriber group.
00039      *
00040      * \param fd the already open file descriptor
00041      * \param mtu the max bytes for a read, 0 for default
00042      * \param close_fd true to close the fd on deconstruction
00043      * \return a new file descriptor to blob block
00044      */
00045     static sptr make(
00046         const int fd, const size_t mtu = 0, const bool close_fd = false
00047     );
00048 
00049 };
00050 
00051 }}
00052 
00053 #endif /* INCLUDED_GR_EXTRAS_FILEDES_TO_BLOB_H */