Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template segment_manager

boost::interprocess::segment_manager

Synopsis

// In header: <boost/interprocess/segment_manager.hpp>

template<typename CharType, typename MemoryAlgorithm, 
          IndexType> 
class segment_manager : public  {
public:
  // types
  typedef                                                                  ;         
  typedef                                             ;             
  typedef                                                ;                
  typedef                                          ;          
  typedef                                                                         ;                
  typedef segment_manager_base<                                          ;
  typedef                                             ;             
  typedef    ;     
  typedef  ;    

  // member classes/structs/unions
  template<typename T> 
  struct allocator {
    // types
    typedef boost::interprocess::allocator< segment_manager > ;
  };
  template<typename T> 
  struct deleter {
    // types
    typedef boost::interprocess::deleter< segment_manager > ;
  };

  // construct/copy/destruct
  ();

  // public member functions
  template<typename T>  ();
  template<typename T> 
     ();
  template<typename T>  ();
  template<typename T> 
     ();
  template<typename T> 
     
    (, );
  template<typename T> 
     
    (, );
  template<typename T> 
     ();
  template<typename T> 
     ();
  template<typename T> 
     
    (, );
  template<typename T> 
     
    (, );
  template<typename Func>  ();
  template<typename Func>  ();
  template<typename T>  ();
  template<typename T>  ();
   ();
   ();
   ();
   ();
   ();
   () ;
   () ;
   () ;
   () ;
  template<typename T> allocator<  ();
  template<typename T> deleter<  ();

  // public static functions
  template<typename T>  ();
  template<typename T>  ();
  template<typename T>  ();
   ();

  // public data members
  static  PayloadPerAllocation;
};

Description

This object is placed in the beginning of memory segment and implements the allocation (named or anonymous) of portions of the segment. This object contains two indexes that maintain an association between a name and a portion of the segment.

The first index contains the mappings for normal named objects using the char type specified in the template parameter.

The second index contains the association for unique instances. The key will be the const char * returned from type_info.name() function for the unique type to be constructed.

segment_manager<CharType, MemoryAlgorithm, IndexType> inherits publicly from segment_manager_base<MemoryAlgorithm> and inherits from it many public functions related to anonymous object and raw memory allocation. See segment_manager_base reference to know about those functions.

segment_manager public construct/copy/destruct

  1. ( segment_size);

    Constructor of the segment manager "size" is the size of the memory segment where the segment manager is being constructed. Can throw

segment_manager public member functions

  1. template<typename T>  ( name);

    Tries to find a previous named/unique allocation. Returns the address and the object count. On failure the first member of the returned pair is 0.

  2. template<typename T> 
       ( name);

    Tries to find a previous named/unique allocation. Returns the address and the object count. On failure the first member of the returned pair is 0. This search is not mutex-protected! Use it only inside atomic_func() calls, where the internal mutex is guaranteed to be locked.

  3. template<typename T> 
       ( name);

    Returns throwing "construct" proxy object

  4. template<typename T> 
       ( name);

    Returns throwing "search or construct" proxy object

  5. template<typename T> 
       
      ( name, );

    Returns no throwing "construct" proxy object

  6. template<typename T> 
       
      ( name, );

    Returns no throwing "search or construct" proxy object

  7. template<typename T> 
       ( name);
    Returns throwing "construct from iterators" proxy object.
  8. template<typename T> 
       ( name);

    Returns throwing "search or construct from iterators" proxy object

  9. template<typename T> 
       
      ( name, );

    Returns no throwing "construct from iterators" proxy object

  10. template<typename T> 
       
      ( name, );

    Returns no throwing "search or construct from iterators" proxy object

  11. template<typename Func>  ( f);

    Calls object function blocking recursive interprocess_mutex and guarantees that no new named_alloc or destroy will be executed by any process while executing the object function call

  12. template<typename Func>  ( f);

    Tries to calls a functor guaranteeing that no new construction, search or destruction will be executed by any process while executing the object function call. If the atomic function can't be immediatelly executed because the internal mutex is already locked, returns false. If the functor throws, this function throws.

  13. template<typename T>  ( name);

    Destroys a previously created named/unique instance. Returns false if the object was not present.

  14. template<typename T>  ( p);

    Destroys an anonymous, unique or named object using its address

  15.  ( num);

    Preallocates needed index resources to optimize the creation of "num" named objects in the managed memory segment. Can throw boost::interprocess::bad_alloc if there is no enough memory.

  16.  ( num);

    Preallocates needed index resources to optimize the creation of "num" unique objects in the managed memory segment. Can throw boost::interprocess::bad_alloc if there is no enough memory.

  17.  ();

    Calls shrink_to_fit in both named and unique object indexes to try to free unused memory from those indexes.

  18.  ();

    Returns the number of named objects stored in the segment.

  19.  ();

    Returns the number of unique objects stored in the segment.

  20.  () ;

    Returns a constant iterator to the beginning of the information about the named allocations performed in this segment manager

  21.  () ;

    Returns a constant iterator to the end of the information about the named allocations performed in this segment manager

  22.  () ;

    Returns a constant iterator to the beginning of the information about the unique allocations performed in this segment manager

  23.  () ;

    Returns a constant iterator to the end of the information about the unique allocations performed in this segment manager

  24. template<typename T> allocator<  ();

    Returns an instance of the default allocator for type T initialized that allocates memory from this segment manager.

  25. template<typename T> deleter<  ();

    Returns an instance of the default deleter for type T that will delete an object constructed in this segment manager.

segment_manager public static functions

  1. template<typename T>  ( ptr);

    Returns the name of an object created with construct/find_or_construct functions. Does not throw

  2. template<typename T>  ( ptr);

    Returns the length of an object created with construct/find_or_construct functions. Does not throw.

  3. template<typename T>  ( ptr);

    Returns is the the name of an object created with construct/find_or_construct functions. Does not throw

  4.  ();

    Obtains the minimum size needed by the segment manager


PrevUpHomeNext