Class template allocator . Boost , The Boost C++ Libraries BoostBook Documentation Subset , Indexes and Reference

Class template allocator

boost::interprocess::allocator

Synopsis

// In header: <boost/interprocess/allocators/allocator.hpp>
template<typename T, typename SegmentManager> 
class allocator {
public:
  // types
  typedef SegmentManager                                                                        segment_manager;
  typedef SegmentManager::void_pointer                                                          void_pointer;   
  typedef T                                                                                     value_type;     
  typedef boost::intrusive::pointer_traits< cvoid_ptr >::template rebind_pointer< T >::type     pointer;        
  typedef boost::intrusive::pointer_traits< pointer >::template rebind_pointer< const T >::type const_pointer;  
  typedef unspecified                                                                           reference;      
  typedef unspecified                                                                           const_reference;
  typedef segment_manager::size_type                                                            size_type;      
  typedef segment_manager::difference_type                                                      difference_type;
  typedef boost::interprocess::version_type< allocator, 2 >                                     version;        
  // member classes/structs/unions
  template<typename T2> 
  struct rebind {
    // types
    typedef allocator< T2, SegmentManager > other;
  };
  // construct/copy/destruct
  allocator(segment_manager *);
  allocator(const allocator &);
  template<typename T2> allocator(const allocator< T2, SegmentManager > &);
  // public member functions
  segment_manager * get_segment_manager() const;
  pointer allocate(size_type, cvoid_ptr = 0);
  void deallocate(const pointer &, size_type);
  size_type max_size() const;
  size_type size(const pointer &) const;
  pointer allocation_command(boost::interprocess::allocation_type, size_type, 
                             size_type &, pointer &);
  void allocate_many(size_type, size_type, multiallocation_chain &);
  void allocate_many(const size_type *, size_type, multiallocation_chain &);
  void deallocate_many(multiallocation_chain &);
  pointer allocate_one();
  void allocate_individual(size_type, multiallocation_chain &);
  void deallocate_one(const pointer &);
  void deallocate_individual(multiallocation_chain &);
  pointer address(reference) const;
  const_pointer address(const_reference) const;
  template<typename P> void construct(const pointer &, P &&);
  void destroy(const pointer &);
  // friend functions
  friend void swap(self_t &, self_t &);
};

Description

STL-совместимый распределитель, который использует менеджер сегментов в качестве источника памяти. Внутренний тип указателя будет того же типа (сырой, умный), что и тип «типовое имя SegmentManager::void_pointer». Это позволяет разместить распределитель в общей памяти, карт памяти-файлы и т.д.

`allocator` public construct/copy/destruct

<
```
allocator(segment_manager*segment_mngr);
```
>
Конструктор от менеджера сегмента. Никогда не бросать
<
```
allocator(constallocator&other);
```
>
Конструктор от другого распределителя. Никогда не бросать
<
```
template<typenameT2>allocator(constallocator<T2,SegmentManager>&other);
```
>
Конструктор от связанного распределителя. Никогда не бросать

`allocator` public member functions

<
```
segment_manager*get_segment_manager()const;
```
>
Возвращает менеджера сегмента. Никогда не бросайте
<
```
pointerallocate(size_typecount,cvoid_ptrhint=0);
```
>
Выделяет память на массив счетных элементов. Бросает<boost::interprocess::bad_alloc>, если не хватает памяти
<
```
voiddeallocate(constpointer&ptr,size_type);
```
>
Распределяет ранее выделенную память. Никогда не бросайте
<
```
size_typemax_size()const;
```
>
Возвращает количество элементов, которые можно было бы выделить. Никогда не бросайте
<
```
size_typesize(constpointer&p)const;
```
>
Возвращает максимальное количество объектов, которые может удерживать ранее выделенная память, указанная p. Этот размер работает только для памяти, выделенной с выделением, выделением_командой и выделением_многими.

pointerallocation_command(boost::interprocess::allocation_typecommand,
                          size_typelimit_size,
                          size_type&prefer_in_recvd_out_size,
                          pointer&reuse);

<
```
voidallocate_many(size_typeelem_size,size_typenum_elements,
                  multiallocation_chain&chain);
```
>
Выделяет множество элементов размера elem_size в смежный блок памяти. Минимальное число, которое должно быть выделено, - это min_элементы, предпочтительное и максимальное число - предпочтительные_элементы. Количество фактически выделенных элементов будет присвоено для receive_size. Элементы должны быть размещены с помощью соглашения (...)
<
```
voidallocate_many(constsize_type*elem_sizes,size_typen_elements,
                  multiallocation_chain&chain);
```
>
Выделяет элементы n_элементов, каждый из которых размером elem_sizes[i] в смежный блок памяти. Элементы должны быть размещены
<
```
voiddeallocate_many(multiallocation_chain&chain);
```
>
Выделяет множество элементов размера elem_size в смежный блок памяти. Минимальное число, которое должно быть выделено, - это min_элементы, предпочтительное и максимальное число - предпочтительные_элементы. Количество фактически выделенных элементов будет присвоено для receive_size. Элементы должны быть размещены с помощью соглашения (...)
<
```
pointerallocate_one();
```
>
Выделяют только один объект. Память, выделенная с этой функцией, должна быть размещена только с помощью deallocate_one(). Бросает<boost::interprocess::bad_alloc>, если не хватает памяти
<
```
voidallocate_individual(size_typenum_elements,
                        multiallocation_chain&chain);
```
>
Выделяет множество элементов размера == 1 в смежном блоке памяти. Минимальное число, которое должно быть выделено, - это min_элементы, предпочтительное и максимальное число - предпочтительные_элементы. Количество фактически выделенных элементов будет присвоено для receive_size. Память, выделенная с этой функцией, должна быть размещена только с помощью deallocate_one().
<
```
voiddeallocate_one(constpointer&p);
```
>
Выделяет память, ранее выделенную с выделением_one(). Вы никогда не должны использовать deallocate_one для обработки памяти, выделенной с другими функциями, отличными от allocate_one(). Никогда не бросайте
<
```
voiddeallocate_individual(multiallocation_chain&chain);
```
>
Выделяет множество элементов размера == 1 в смежном блоке памяти. Минимальное число, которое должно быть выделено, - это min_элементы, предпочтительное и максимальное число - предпочтительные_элементы. Количество фактически выделенных элементов будет присвоено для receive_size. Память, выделенная с этой функцией, должна быть размещена только с помощью deallocate_one().
<
```
pointeraddress(referencevalue)const;
```
>
Возвращает адрес изменяемого объекта. Никогда не бросайте
<
```
const_pointeraddress(const_referencevalue)const;
```
>
Возвращает адрес неизменяемого объекта. Никогда не бросайте
<
```
template<typenameP>voidconstruct(constpointer&ptr,P&&p);
```
>
Построение объекта Бросает, если конструктор Т бросает Для обратной совместимости с библиотеками с помощью распределителей C++03
<
```
voiddestroy(constpointer&ptr);
```
>
Уничтожает объект. Бросает, если разрушитель объекта бросает

`allocator` friend functions

<
```
friendvoidswap(self_t&alloc1,self_t&alloc2);
```
>
Менеджер сегмента свопа. Не бросает. Если каждый распределитель размещен в разных сегментах памяти, результат не определен.

Статья Class template allocator раздела The Boost C++ Libraries BoostBook Documentation Subset Indexes and Reference может быть полезна для разработчиков на c++ и boost.

Class template allocator

Boost , The Boost C++ Libraries BoostBook Documentation Subset , Indexes and Reference

Boost C++ Libraries

Class template allocator

Synopsis

Description

allocator public construct/copy/destruct

allocator public member functions

allocator friend functions

`allocator` public construct/copy/destruct

`allocator` public member functions

`allocator` friend functions