GNU Radio C++ API
gr_vmcircbuf_sysv_shm.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2003 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 
23 #ifndef _GR_VMCIRCBUF_SYSV_SHM_H_
24 #define _GR_VMCIRCBUF_SYSV_SHM_H_
25 
26 #include <gr_core_api.h>
27 #include <gr_vmcircbuf.h>
28 
29 /*!
30  * \brief concrete class to implement circular buffers with mmap and shm_open
31  * \ingroup internal
32  */
34  public:
35 
36  // CREATORS
37 
38  gr_vmcircbuf_sysv_shm (int size);
39  virtual ~gr_vmcircbuf_sysv_shm ();
40 };
41 
42 /*!
43  * \brief concrete factory for circular buffers built using mmap and shm_open
44  */
46  private:
47  static gr_vmcircbuf_factory *s_the_factory;
48 
49  public:
50  static gr_vmcircbuf_factory *singleton ();
51 
52  virtual const char *name () const { return "gr_vmcircbuf_sysv_shm_factory"; }
53 
54  /*!
55  * \brief return granularity of mapping, typically equal to page size
56  */
57  virtual int granularity ();
58 
59  /*!
60  * \brief return a gr_vmcircbuf, or 0 if unable.
61  *
62  * Call this to create a doubly mapped circular buffer.
63  */
64  virtual gr_vmcircbuf *make (int size);
65 };
66 
67 #endif /* _GR_VMCIRCBUF_SYSV_SHM_H_ */