Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / io / gri_logger.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006 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 #ifndef INCLUDED_GRI_LOGGER_H
23 #define INCLUDED_GRI_LOGGER_H
24
25 #include <stddef.h>
26 #include <gnuradio/omnithread.h>
27 #include <gr_buffer.h>
28
29 class gri_log_poster;
30 class gri_logger;
31 typedef boost::shared_ptr<gri_logger> gri_logger_sptr;
32
33
34 /*!
35  * \brief non-blocking logging to a file.
36  *
37  * In reality, this may block, but only for a bounded time.
38  * Trust me, it's safe to use from portaudio and JACK callbacks.
39  */
40 class gri_logger
41 {
42   gri_log_poster        *d_poster;
43   omni_mutex             d_write_mutex;
44
45 public:
46   static gri_logger_sptr singleton();
47
48   gri_logger(const char *filename);
49   ~gri_logger();
50
51   void write(const void *buf, size_t count);
52   void printf(const char *format, ...);
53 };
54
55 #endif /* INCLUDED_GRI_LOGGER_H */