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