SharedMemorySegment.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLIO/src/ICLIO/SharedMemorySegment.h                  **
** Module : ICLIO                                                  **
** Authors: Viktor Richter                                         **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/Time.h>
#include <ICLUtils/Thread.h>
#include <ICLUtils/Exception.h>
#include <set>


namespace icl {
  namespace io {


    class ICLIO_API SharedMemorySegment{
      public:


        SharedMemorySegment(std::string name="", int minsize=1);

        ~SharedMemorySegment();


        void release();

        std::string getName();


        void reset(std::string name, int minsize=0);


        bool isAttached();


        bool lock(int minsize=0);


        bool unlock();


        void forceMinSize(int minsize);


        int getSize();


        bool isEmpty() const;


        void* data();


        const void* data() const;


        const void* constData() const;

        struct Impl;
      private:
        mutable utils::Mutex m_Mutex;

        Impl* m_Impl;

        std::string m_Name;

        int m_Minsize;
    };

    struct ICLIO_API SharedMemorySegmentLocker{
        SharedMemorySegment &segment;

        SharedMemorySegmentLocker(SharedMemorySegment &seg, int minSize=0);

        SharedMemorySegmentLocker(SharedMemorySegment* seg, int minSize=0);

        ~SharedMemorySegmentLocker();
    };


    class ICLIO_API SharedMemorySegmentRegister
    {
      public:
        friend struct SharedMemorySegment::Impl;

        static std::set<std::string> getSegmentSet();


        static void freeSegment(std::string name);

        static void freeAllSegments();


        static void resetBus();

      private:
        static void addSegment(std::string name);

        static void removeSegment(std::string name);
    };

  } // namespace io
}  // namespace icl