Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template basic_managed_xsi_shared_memory

boost::interprocess::basic_managed_xsi_shared_memory

Synopsis

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

template<typename CharType, typename AllocationAlgorithm, 
          IndexType> 
class basic_managed_xsi_shared_memory {
public:
  // types
  typedef  ;

  // construct/copy/destruct
  () ;
  (create_only_t, xsi_key &, , 
                                   = , 
                                  permissions & = permissions());
  (open_or_create_t, xsi_key &, 
                                  ,  = , 
                                  permissions & = permissions());
  (open_read_only_t, xsi_key &, 
                                   = );
  (open_only_t, xsi_key &, 
                                   = );
  (basic_managed_xsi_shared_memory &&) ;
  basic_managed_xsi_shared_memory & 
  (basic_managed_xsi_shared_memory &&) ;
  ~();

  // public member functions
   (basic_managed_xsi_shared_memory &) ;
   () ;

  // public static functions
   ();
};

Description

A basic X/Open System Interface (XSI) shared memory named object creation class. Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType>

basic_managed_xsi_shared_memory public construct/copy/destruct

  1. () ;

    Default constructor. Does nothing. Useful in combination with move semantics

  2. (create_only_t, xsi_key & key, 
                                     size,  addr = , 
                                    permissions & perm = permissions());

    Creates shared memory and creates and places the segment manager. This can throw.

  3. (open_or_create_t, xsi_key & key, 
                                     size,  addr = , 
                                    permissions & perm = permissions());

    Creates shared memory and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw.

  4. (open_read_only_t, xsi_key & key, 
                                     addr = );

    Connects to a created shared memory and its segment manager. in read-only mode. This can throw.

  5. (open_only_t, xsi_key & key, 
                                     addr = );

    Connects to a created shared memory and its segment manager. This can throw.

  6. (basic_managed_xsi_shared_memory && moved) ;

    Moves the ownership of "moved"'s managed memory to *this. Does not throw

  7. basic_managed_xsi_shared_memory & 
    (basic_managed_xsi_shared_memory && moved) ;

    Moves the ownership of "moved"'s managed memory to *this. Does not throw

  8. ~();

    Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove().

basic_managed_xsi_shared_memory public member functions

  1.  (basic_managed_xsi_shared_memory & other) ;

    Swaps the ownership of the managed shared memories managed by *this and other. Never throws.

  2.  () ;

basic_managed_xsi_shared_memory public static functions

  1.  ( shmid);

    Erases a XSI shared memory object identified by shmid from the system. Returns false on error. Never throws


PrevUpHomeNext