GNU Radio 3.4.0 C++ API
gr_vmcircbuf_mmap_tmpfile.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2003 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 _GR_VMCIRCBUF_MMAP_TMPFILE_H_
00024 #define _GR_VMCIRCBUF_MMAP_TMPFILE_H_
00025 
00026 #include <gr_vmcircbuf.h>
00027 
00028 /*!
00029  * \brief concrete class to implement circular buffers with mmap and shm_open
00030  * \ingroup internal
00031  */
00032 class gr_vmcircbuf_mmap_tmpfile : public gr_vmcircbuf {
00033  public:
00034 
00035   // CREATORS
00036 
00037   gr_vmcircbuf_mmap_tmpfile (int size);
00038   virtual ~gr_vmcircbuf_mmap_tmpfile ();
00039 };
00040 
00041 /*!
00042  * \brief concrete factory for circular buffers built using mmap and shm_open
00043  */
00044 class gr_vmcircbuf_mmap_tmpfile_factory : public gr_vmcircbuf_factory {
00045  private:
00046   static gr_vmcircbuf_factory   *s_the_factory;
00047 
00048  public:
00049   static gr_vmcircbuf_factory *singleton ();
00050 
00051   virtual const char *name () const { return "gr_vmcircbuf_mmap_tmpfile_factory"; }
00052 
00053   /*!
00054    * \brief return granularity of mapping, typically equal to page size
00055    */
00056   virtual int granularity ();
00057 
00058   /*!
00059    * \brief return a gr_vmcircbuf, or 0 if unable.
00060    *
00061    * Call this to create a doubly mapped circular buffer.
00062    */
00063   virtual gr_vmcircbuf *make (int size);
00064 };
00065 
00066 #endif /* _GR_VMCIRCBUF_MMAP_TMPFILE_H_ */