buffer_reader_sm.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2004,2009-2011,2013 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */
 
#ifndef INCLUDED_GR_RUNTIME_BUFFER_READER_SM_H
#define INCLUDED_GR_RUNTIME_BUFFER_READER_SM_H
 
#include <gnuradio/api.h>
#include <gnuradio/buffer.h>
#include <gnuradio/buffer_reader.h>
#include <gnuradio/runtime_types.h>
 
namespace gr {
 
class GR_RUNTIME_API buffer_reader_sm : public buffer_reader
{
public:
    ~buffer_reader_sm();
 
    /*!
     * \brief Return number of items available for reading.
     */
    virtual int items_available() const;
 
    /*!
     * \brief Return true if thread is ready to call input_blocked_callback,
     * false otherwise; delegate calls to buffer class's input_blkd_cb_ready()
     */
    virtual bool input_blkd_cb_ready(int items_required) const;
 
    /*!
     * \brief Callback function that the scheduler will call when it determines
     * that the input is blocked; delegate calls to buffer class's
     * input_blocked_callback()
     */
    virtual bool input_blocked_callback(int items_required, int items_avail);
 
private:
    friend class buffer;
    friend class buffer_single_mapped;
 
    friend GR_RUNTIME_API buffer_reader_sptr buffer_add_reader(buffer_sptr buf,
                                                               int nzero_preload,
                                                               block_sptr link,
                                                               int delay);
 
    //! constructor is private.  Use gr::buffer::add_reader to create instances
    buffer_reader_sm(buffer_sptr buffer, unsigned int read_index, block_sptr link);
};
 
} // namespace gr
 
#endif /* INCLUDED_GR_RUNTIME_BUFFER_READER_SM_H */