Imported Upstream version 3.0
[debian/gnuradio] / gnuradio-core / src / lib / runtime / gr_vmcircbuf_createfilemapping.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2003,2005 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 2, 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_CREATEFILEMAPPING_H_
24 #define _GR_VMCIRCBUF_CREATEFILEMAPPING_H_
25
26 #include <gr_vmcircbuf.h>
27
28 #ifdef HAVE_CREATEFILEMAPPING
29 #include <windows.h>
30 #endif
31 /*!
32  * \brief concrete class to implement circular buffers with mmap and shm_open
33  */
34 class gr_vmcircbuf_createfilemapping : public gr_vmcircbuf
35 {
36  public:
37    // CREATORS
38    gr_vmcircbuf_createfilemapping (int size);
39    virtual ~gr_vmcircbuf_createfilemapping ();
40 #ifdef HAVE_CREATEFILEMAPPING
41  private:
42    HANDLE d_handle;
43    LPVOID d_first_copy;
44    LPVOID d_second_copy;
45 #endif
46 };
47
48 /*!
49  * \brief concrete factory for circular buffers built using mmap and shm_open
50  */
51 class gr_vmcircbuf_createfilemapping_factory : public gr_vmcircbuf_factory
52 {
53  private:
54   static gr_vmcircbuf_factory *s_the_factory;
55
56  public:
57   static gr_vmcircbuf_factory *singleton ();
58
59   virtual const char *name () const { return "gr_vmcircbuf_createfilemapping_factory"; }
60
61   /*!
62    * \brief return granularity of mapping, typically equal to page size
63    */
64   virtual int granularity ();
65
66   /*!
67    * \brief return a gr_vmcircbuf, or 0 if unable.
68    *
69    * Call this to create a doubly mapped circular buffer.
70    */
71   virtual gr_vmcircbuf *make (int size);
72 };
73
74 #endif /* _GR_VMCIRCBUF_CREATEFILEMAPPING_H_ */