From 08c1e93fa36a49f49325a07fe91ff92c964c2b6c Mon Sep 17 00:00:00 2001 From: Chanho Park Date: Thu, 11 Dec 2014 18:55:56 +0900 Subject: Imported Upstream version 1.57.0 --- .../boost/interprocess/shared_memory_object.html | 88 +++++++++++----------- 1 file changed, 43 insertions(+), 45 deletions(-) (limited to 'doc/html/boost/interprocess/shared_memory_object.html') diff --git a/doc/html/boost/interprocess/shared_memory_object.html b/doc/html/boost/interprocess/shared_memory_object.html index f4e1aff45d..5197f8c897 100644 --- a/doc/html/boost/interprocess/shared_memory_object.html +++ b/doc/html/boost/interprocess/shared_memory_object.html @@ -3,11 +3,11 @@ Class shared_memory_object - + - + - + @@ -20,7 +20,7 @@
-PrevUpHomeNext +PrevUpHomeNext
@@ -29,99 +29,97 @@

boost::interprocess::shared_memory_object

Synopsis

-
// In header: <boost/interprocess/shared_memory_object.hpp>
+
// In header: <boost/interprocess/shared_memory_object.hpp>
 
 
 class shared_memory_object {
 public:
   // construct/copy/destruct
-  shared_memory_object();
-  shared_memory_object(create_only_t, const char *, mode_t, 
+  shared_memory_object();
+  shared_memory_object(create_only_t, const char *, mode_t, 
                        const permissions & = permissions());
-  shared_memory_object(open_or_create_t, const char *, mode_t, 
+  shared_memory_object(open_or_create_t, const char *, mode_t, 
                        const permissions & = permissions());
-  shared_memory_object(open_only_t, const char *, mode_t);
-  shared_memory_object(shared_memory_object &&);
-  shared_memory_object& operator=(shared_memory_object &&);
-  ~shared_memory_object();
+  shared_memory_object(open_only_t, const char *, mode_t);
+  shared_memory_object(shared_memory_object &&);
+  shared_memory_object & operator=(shared_memory_object &&);
+  ~shared_memory_object();
 
-  // public member functions
-  void swap(shared_memory_object &);
-  void truncate(offset_t);
-  const char * get_name() const;
-  bool get_size(offset_t &) const;
-  mode_t get_mode() const;
-  mapping_handle_t get_mapping_handle() const;
+  // public member functions
+  void swap(shared_memory_object &);
+  void truncate(offset_t);
+  const char * get_name() const;
+  bool get_size(offset_t &) const;
+  mode_t get_mode() const;
+  mapping_handle_t get_mapping_handle() const;
 
-  // public static functions
-  static bool remove(const char *);
+  // public static functions
+  static bool remove(const char *);
 };

 

-
Description

+
Description

 
A class that wraps a shared memory mapping that can be used to create mapped regions from the mapped files 

 

-

+

 shared_memory_object 
         public
        construct/copy/destruct

 
    
 
  1. 
-
    shared_memory_object();
    
-
    Default constructor. Represents an empty shared_memory_object. 
    
-
    2. 
+
    shared_memory_object();
    Default constructor. Represents an empty shared_memory_object. 
 
  2. 
-
    shared_memory_object(create_only_t, const char * name, mode_t mode, 
+
    shared_memory_object(create_only_t, const char * name, mode_t mode, 
                      const permissions & perm = permissions());
    
 
    Creates a shared memory object with name "name" and mode "mode", with the access mode "mode" If the file previously exists, throws an error. 
    
 
    3. 
 
  3. 
-
    shared_memory_object(open_or_create_t, const char * name, mode_t mode, 
+
    shared_memory_object(open_or_create_t, const char * name, mode_t mode, 
                      const permissions & perm = permissions());
    
 
    Tries to create a shared memory object with name "name" and mode "mode", with the access mode "mode". If the file previously exists, it tries to open it with mode "mode". Otherwise throws an error. 
    
 
    4. 
 
  4. 
-
    shared_memory_object(open_only_t, const char * name, mode_t mode);
    
+
    shared_memory_object(open_only_t, const char * name, mode_t mode);
    
 
    Tries to open a shared memory object with name "name", with the access mode "mode". If the file does not previously exist, it throws an error. 
    
 
    5. 
 
  5. 
-
    shared_memory_object(shared_memory_object && moved);
    
+
    shared_memory_object(shared_memory_object && moved);
    
 
    Moves the ownership of "moved"'s shared memory object to *this. After the call, "moved" does not represent any shared memory object. Does not throw 
    
 
    6. 
 
  6. 
-
    shared_memory_object& operator=(shared_memory_object && moved);
    
+
    shared_memory_object & operator=(shared_memory_object && moved);
    
 
    Moves the ownership of "moved"'s shared memory to *this. After the call, "moved" does not represent any shared memory. Does not throw 
    
 
    7. 
 
  7. 
-
    ~shared_memory_object();
    
+
    ~shared_memory_object();
    
 
    Destroys *this and indicates that the calling process is finished using the resource. All mapped regions are still valid after destruction. 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(). 
    
 
    8. 
 

 

 

-

-shared_memory_object public member functions

+

+shared_memory_object public member functions

 
    
 
  1. 
-
    void swap(shared_memory_object & moved);
    Swaps the shared_memory_objects. Does not throw. 
    2. 
+
    void swap(shared_memory_object & moved);
    Swaps the shared_memory_objects. Does not throw. 
 
  2. 
-
    void truncate(offset_t length);
    Sets the size of the shared memory mapping. 
    3. 
+
    void truncate(offset_t length);
    Sets the size of the shared memory mapping. 
 
  3. 
-
    const char * get_name() const;
    Returns the name of the shared memory object. 
    4. 
+
    const char * get_name() const;
    Returns the name of the shared memory object. 
 
  4. 
-
    bool get_size(offset_t & size) const;
    
+
    bool get_size(offset_t & size) const;
    
 
    Returns true if the size of the shared memory object can be obtained and writes the size in the passed reference 
    
 
    5. 
 
  5. 
-
    mode_t get_mode() const;
    Returns access mode. 
    6. 
+
    mode_t get_mode() const;
    Returns access mode. 
 
  6. 
-
    mapping_handle_t get_mapping_handle() const;
    Returns mapping handle. Never throws. 
    7. 
+
    mapping_handle_t get_mapping_handle() const;
    Returns mapping handle. Never throws. 
 

 

 

-

-shared_memory_object public static functions

+

+shared_memory_object public static functions

 
  1. 
-
    static bool remove(const char * name);
    
+
    static bool remove(const char * name);
    
 
    Erases a shared memory object from the system. Returns false on error. Never throws 
    
 

 

@@ -129,7 +127,7 @@
 

 
-

 
Copyright © 2005-2011 Ion Gaztanaga

+
Copyright © 2005-2012 Ion Gaztanaga

         Distributed under the Boost Software License, Version 1.0. (See accompanying
         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
       

@@ -137,7 +135,7 @@
 

 

 

-PrevUpHomeNext
+PrevUpHomeNext
 

 
 
-- 
cgit v1.2.3