GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
backend.h
Go to the documentation of this file.
1/*
2 * Copyright 2018 Free Software Foundation, Inc.
3 *
4 * This file is part of GNU Radio
5 *
6 * GNU Radio is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3, or (at your option)
9 * any later version.
10 *
11 * GNU Radio is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with GNU Radio; see the file COPYING. If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street,
19 * Boston, MA 02110-1301, USA.
20 */
21
22#ifndef INCLUDED_GR_RUNTIME_RUNTIME_LOG_BACKEND_H
23#define INCLUDED_GR_RUNTIME_RUNTIME_LOG_BACKEND_H
24#include "gnuradio/log/entry.h"
25#include <string>
26namespace gr {
27namespace log {
28/*! Logging backend base class
29 */
31{
32public:
33 /*! logging operation
34 * \param what the log entry to log
35 * \return bool representing success of the logging operation
36 */
37 virtual bool log(const entry& what) = 0;
38 virtual const std::string description() = 0; //! Return a description of the logger
39 virtual bool flush() = 0; //! Flush the logging state out
40 virtual ~backend() = default; //! virtual dtor
41};
42
43} // namespace log
44} // namespace gr
45#endif /* INCLUDED_GR_RUNTIME_RUNTIME_LOG_BACKEND_H */
Definition: backend.h:31
virtual bool log(const entry &what)=0
virtual const std::string description()=0
virtual ~backend()=default
Flush the logging state out.
virtual bool flush()=0
Return a description of the logger.
#define GR_RUNTIME_API
Definition: gnuradio-runtime/include/gnuradio/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45