source: pacpusframework/trunk/include/Pacpus/PacpusTools/ShMemBase.h@ 66

// This file is part of the PACPUS framework distributed under the
// CECILL-C License, Version 1.0.
// 
/// @file
/// @author  Firstname Surname <firstname.surname@utc.fr>
/// @date    Month, Year
/// @version $Id: ShMemBase.h 66 2013-01-09 16:54:11Z kurdejma $
/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
/// @brief Brief description.
///
/// Detailed description.

#ifndef DEF_PACPUS_SHMEMBASE_H
#define DEF_PACPUS_SHMEMBASE_H

class ShMemBase
{
public:
  ShMemBase()
  {
      /*printf("ShMemBase::ShMemBase() not implemented !\n");*/
  }

  virtual ~ShMemBase()
  {
      /*printf("ShMemBase::~ShMemBase() not implemented !\n");*/
  }

  // Use this method to get the data of the shared memory
  virtual void *read() = 0; 

  // Use this method to write data in shared memory
  virtual void write(void *data, int size, unsigned long offset = 0) = 0; 

  // Use this method to wait the incoming of new data
  // you can specify a timeout in ms to avoid infinite blocking or 0 (infinite)
  // return true if new data available before the timeout or else false
  virtual bool wait(unsigned long timeout = 0) = 0; 

  // To lock the access to the memory
  virtual void lockMemory() = 0; 

  // To unlock the access to the memory
  virtual void unlockMemory() = 0; 

#ifdef WIN32
  // Return the event handle under Windows 
  // ... under Linux ? 
  virtual void * getEventIdentifier() = 0; 
#endif 
  
protected:
  void * shMem_; 
        
private:
};

#endif // DEF_PACPUS_SHMEMBASE_H