boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType > Class Template Reference

A basic shared memory named object creation class. More...

#include <managed_shared_memory.hpp>

Inheritance diagram for boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >:

Collaboration diagram for boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >:

Public Types
typedef shared_memory_object	device_type
typedef base_t::size_type	size_type

Public Member Functions
	~basic_managed_shared_memory ()
	Destroys *this and indicates that the calling process is finished using the resource. More...
	basic_managed_shared_memory ()
	Default constructor. More...
	basic_managed_shared_memory (create_only_t, const char *name, size_type size, const void *addr=0, const permissions &perm=permissions())
	Creates shared memory and creates and places the segment manager. More...
	basic_managed_shared_memory (open_or_create_t, const char *name, size_type size, const void *addr=0, const permissions &perm=permissions())
	Creates shared memory and creates and places the segment manager if segment was not created. More...
	basic_managed_shared_memory (open_copy_on_write_t, const char *name, const void *addr=0)
	Connects to a created shared memory and its segment manager. More...
	basic_managed_shared_memory (open_read_only_t, const char *name, const void *addr=0)
	Connects to a created shared memory and its segment manager. More...
	basic_managed_shared_memory (open_only_t, const char *name, const void *addr=0)
	Connects to a created shared memory and its segment manager. More...
	basic_managed_shared_memory (BOOST_RV_REF(basic_managed_shared_memory) moved)
	Moves the ownership of "moved"'s managed memory to *this. More...
basic_managed_shared_memory &	operator= (BOOST_RV_REF(basic_managed_shared_memory) moved)
	Moves the ownership of "moved"'s managed memory to *this. More...
void	swap (basic_managed_shared_memory &other)
	Swaps the ownership of the managed shared memories managed by *this and other. More...
template<class T >
std::pair< T *, size_type >	find (char_ptr_holder_t name)
	Tries to find a previous named allocation address. More...

Static Public Member Functions
static bool	grow (const char *shmname, size_type extra_bytes)
	Tries to resize the managed shared memory object so that we have room for more objects. More...
static bool	shrink_to_fit (const char *shmname)
	Tries to resize the managed shared memory to minimized the size of the file. More...

Detailed Description

template<class CharType, class AllocationAlgorithm, template< class IndexConfig > class IndexType>
class boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >

A basic shared memory named object creation class.

Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType>

Member Typedef Documentation

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

typedef shared_memory_object boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::device_type

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

typedef base_t::size_type boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::size_type

Constructor & Destructor Documentation

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::~basic_managed_shared_memory ( )

inline

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().

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::basic_managed_shared_memory ( )

inline

Default constructor.

Does nothing. Useful in combination with move semantics

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::basic_managed_shared_memory ( create_only_t  , const char *  name, size_type  size, const void *  addr = 0, const permissions &  perm = permissions()  )

inline

Creates shared memory and creates and places the segment manager.

This can throw.

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::basic_managed_shared_memory ( open_or_create_t  , const char *  name, size_type  size, const void *  addr = 0, const permissions &  perm = permissions()  )

inline

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.

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::basic_managed_shared_memory ( open_copy_on_write_t  , const char *  name, const void *  addr = 0  )

inline

Connects to a created shared memory and its segment manager.

in copy_on_write mode. This can throw.

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::basic_managed_shared_memory ( open_read_only_t  , const char *  name, const void *  addr = 0  )

inline

Connects to a created shared memory and its segment manager.

in read-only mode. This can throw.

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::basic_managed_shared_memory ( open_only_t  , const char *  name, const void *  addr = 0  )

inline

Connects to a created shared memory and its segment manager.

This can throw.

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::basic_managed_shared_memory ( BOOST_RV_REF(basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >)  moved )

inline

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

Does not throw

References boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::swap().

Member Function Documentation

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

template<class T >

std::pair<T*, size_type> boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::find ( char_ptr_holder_t  name )

inline

Tries to find a previous named allocation address.

Returns a memory buffer and the object count. If not found returned pointer is 0. Never throws.

References boost::iostreams::gzip::flags::name, and template.

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

static bool boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::grow ( const char *  shmname, size_type  extra_bytes  )

inlinestatic

Tries to resize the managed shared memory object so that we have room for more objects.

This function is not synchronized so no other thread or process should be reading or writing the file

References template.

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

basic_managed_shared_memory& boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::operator= ( BOOST_RV_REF(basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >)  moved )

inline

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

Does not throw

References boost::move(), and boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::swap().

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

static bool boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::shrink_to_fit ( const char *  shmname )

inlinestatic

Tries to resize the managed shared memory to minimized the size of the file.

This function is not synchronized so no other thread or process should be reading or writing the file

References template.

template<class CharType , class AllocationAlgorithm , template< class IndexConfig > class IndexType>

void boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::swap ( basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType > &  other )

inline

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

Never throws.

References boost::swap.

Referenced by boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::basic_managed_shared_memory(), and boost::interprocess::basic_managed_shared_memory< CharType, AllocationAlgorithm, IndexType >::operator=().

---

The documentation for this class was generated from the following files:

• boost_1_57_0/boost/interprocess/interprocess_fwd.hpp
• boost_1_57_0/boost/interprocess/managed_shared_memory.hpp