Statistics
| Branch: | Tag: | Revision:

root / gnuradio-core / src / lib / runtime / gr_vmcircbuf_mmap_shm_open.h @ cda71d95

History | View | Annotate | Download (1.8 kB)

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_MMAP_SHM_OPEN_H_
24
#define _GR_VMCIRCBUF_MMAP_SHM_OPEN_H_
25
26
#include <gr_vmcircbuf.h>
27
28
/*!
29
 * \brief concrete class to implement circular buffers with mmap and shm_open
30
 * \ingroup base
31
 */
32
class gr_vmcircbuf_mmap_shm_open : public gr_vmcircbuf {
33
 public:
34
35
  // CREATORS
36
37
  gr_vmcircbuf_mmap_shm_open (int size);
38
  virtual ~gr_vmcircbuf_mmap_shm_open ();
39
};
40
41
/*!
42
 * \brief concrete factory for circular buffers built using mmap and shm_open
43
 */
44
class gr_vmcircbuf_mmap_shm_open_factory : public gr_vmcircbuf_factory {
45
 private:
46
  static gr_vmcircbuf_factory        *s_the_factory;
47
48
 public:
49
  static gr_vmcircbuf_factory *singleton ();
50
51
  virtual const char *name () const { return "gr_vmcircbuf_mmap_shm_open_factory"; }
52
53
  /*!
54
   * \brief return granularity of mapping, typically equal to page size
55
   */
56
  virtual int granularity ();
57
58
  /*!
59
   * \brief return a gr_vmcircbuf, or 0 if unable.
60
   *
61
   * Call this to create a doubly mapped circular buffer.
62
   */
63
  virtual gr_vmcircbuf *make (int size);
64
};
65
66
#endif /* _GR_VMCIRCBUF_MMAP_SHM_OPEN_H_ */