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