GNU Radio 3.6.5 C++ API

file_sink_base.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2007,2008,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_SINK_BASE_H
00024 #define INCLUDED_GR_FILE_SINK_BASE_H
00025 
00026 #include <blocks/api.h>
00027 #include <boost/thread.hpp>
00028 #include <cstdio>
00029 
00030 namespace gr {
00031   namespace blocks {
00032 
00033     /*!
00034      * \brief Common base class for file sinks
00035      */
00036     class BLOCKS_API file_sink_base
00037     {
00038     protected:
00039       FILE        *d_fp;        // current FILE pointer
00040       FILE        *d_new_fp;    // new FILE pointer
00041       bool         d_updated;   // is there a new FILE pointer?
00042       bool         d_is_binary;
00043       boost::mutex d_mutex;
00044       bool         d_unbuffered;
00045 
00046     protected:
00047       file_sink_base(const char *filename, bool is_binary);
00048 
00049     public:
00050       file_sink_base() {}
00051       ~file_sink_base();
00052 
00053       /*!
00054        * \brief Open filename and begin output to it.
00055        */
00056       bool open(const char *filename);
00057 
00058       /*!
00059        * \brief Close current output file.
00060        *
00061        * Closes current output file and ignores any output until
00062        * open is called to connect to another file.
00063        */
00064       void close();
00065 
00066       /*!
00067        * \brief if we've had an update, do it now.
00068        */
00069       void do_update();
00070 
00071       /*!
00072        * \brief turn on unbuffered writes for slower outputs
00073        */
00074       void set_unbuffered(bool unbuffered);
00075     };
00076 
00077   } /* namespace blocks */
00078 } /* namespace gr */
00079 
00080 #endif /* INCLUDED_GR_FILE_SINK_BASE_H */