ACE/ace/Shared_Memory.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    Shared_Memory.h
   6  *
   7  *  @author Doug Schmidt
   8  */
   9 //==========================================================================
  10
  11 #ifndef ACE_SHARED_MEMORY_H
  12 #define ACE_SHARED_MEMORY_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include /**/ "ace/ACE_export.h"
  17
  18 #include "ace/os_include/os_stddef.h"
  19
  20 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  21 # pragma once
  22 #endif /* ACE_LACKS_PRAGMA_ONCE */
  23
  24 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  25
  26 /**
  27  * @class ACE_Shared_Memory
  28  *
  29  * @brief This base class adapts both System V shared memory and "BSD"
  30  * mmap to a common API.
  31  *
  32  * This is a very simple-minded wrapper, i.e., it really is only
  33  * useful for allocating large contiguous chunks of shared
  34  * memory.  For a much more sophisticated version, please check
  35  * out the ACE_Malloc class.
  36  */
  37 class ACE_Export ACE_Shared_Memory
  38 {
  39 public:
  40   virtual ~ACE_Shared_Memory ();
  41
  42   // = Note that all the following methods are pure virtual.
  43   virtual int close () = 0;
  44   virtual int remove () = 0;
  45   virtual void *malloc (size_t = 0) = 0;
  46   virtual int free (void *p) = 0;
  47   virtual size_t get_segment_size () const = 0;
  48   virtual ACE_HANDLE get_id () const = 0;
  49 };
  50
  51 ACE_END_VERSIONED_NAMESPACE_DECL
  52
  53 #include /**/ "ace/post.h"
  54
  55 #endif /* ACE_SHARED_MEMORY_H */