apollo::cyber::base::ObjectPool< T > 模板类 参考

#include <object_pool.h>

类 apollo::cyber::base::ObjectPool< T > 继承关系图:

apollo::cyber::base::ObjectPool< T > 的协作图:

Public 类型
using	InitFunc = std::function< void(T *)>
using	ObjectPoolPtr = std::shared_ptr< ObjectPool< T > >

Public 成员函数
template<typename... Args>
	ObjectPool (uint32_t num_objects, Args &&... args)
template<typename... Args>
	ObjectPool (uint32_t num_objects, InitFunc f, Args &&... args)
virtual	~ObjectPool ()
std::shared_ptr< T >	GetObject ()

详细描述

template<typename T>
class apollo::cyber::base::ObjectPool< T >

在文件 object_pool.h 第 37 行定义.

成员类型定义说明

InitFunc

template<typename T >

using apollo::cyber::base::ObjectPool< T >::InitFunc = std::function<void(T *)>

在文件 object_pool.h 第 39 行定义.

ObjectPoolPtr

template<typename T >

using apollo::cyber::base::ObjectPool< T >::ObjectPoolPtr = std::shared_ptr<ObjectPool<T> >

在文件 object_pool.h 第 40 行定义.

构造及析构函数说明

ObjectPool() [1/2]

template<typename T >

template<typename... Args>

apollo::cyber::base::ObjectPool< T >::ObjectPool ( uint32_t  num_objects, Args &&...  args  )

explicit

在文件 object_pool.h 第 69 行定义.

    : num_objects_(num_objects) {
  const size_t size = sizeof(Node);
  object_arena_ = static_cast<char *>(std::calloc(num_objects_, size));
  if (object_arena_ == nullptr) {
    throw std::bad_alloc();
  }
 
  FOR_EACH(i, 0, num_objects_) {
    T *obj = new (object_arena_ + i * size) T(std::forward<Args>(args)...);
    reinterpret_cast<Node *>(obj)->next = free_head_;
    free_head_ = reinterpret_cast<Node *>(obj);
  }
}

ObjectPool() [2/2]

template<typename T >

template<typename... Args>

apollo::cyber::base::ObjectPool< T >::ObjectPool	(	uint32_t	num_objects,
		InitFunc	f,
		Args &&...	args
	)

在文件 object_pool.h 第 86 行定义.

    : num_objects_(num_objects) {
  const size_t size = sizeof(Node);
  object_arena_ = static_cast<char *>(std::calloc(num_objects_, size));
  if (object_arena_ == nullptr) {
    throw std::bad_alloc();
  }
 
  FOR_EACH(i, 0, num_objects_) {
    T *obj = new (object_arena_ + i * size) T(std::forward<Args>(args)...);
    f(obj);
    reinterpret_cast<Node *>(obj)->next = free_head_;
    free_head_ = reinterpret_cast<Node *>(obj);
  }
}

~ObjectPool()

template<typename T >

apollo::cyber::base::ObjectPool< T >::~ObjectPool ( )

virtual

在文件 object_pool.h 第 103 行定义.

                           {
  if (object_arena_ != nullptr) {
    const size_t size = sizeof(Node);
    FOR_EACH(i, 0, num_objects_) {
      reinterpret_cast<Node *>(object_arena_ + i * size)->object.~T();
    }
    std::free(object_arena_);
  }
}

成员函数说明

GetObject()

template<typename T >

std::shared_ptr< T > apollo::cyber::base::ObjectPool< T >::GetObject

(

)

在文件 object_pool.h 第 124 行定义.

                                          {
  if (cyber_unlikely(free_head_ == nullptr)) {
    return nullptr;
  }
 
  auto self = this->shared_from_this();
  auto obj =
      std::shared_ptr<T>(reinterpret_cast<T *>(free_head_),
                         [self](T *object) { self->ReleaseObject(object); });
  free_head_ = free_head_->next;
  return obj;
}

---

该类的文档由以下文件生成:

• cyber/base/object_pool.h