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

#include <thread_safe_queue.h>

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

Public 成员函数
	ThreadSafeQueue ()
ThreadSafeQueue &	operator= (const ThreadSafeQueue &other)=delete
	ThreadSafeQueue (const ThreadSafeQueue &other)=delete
	~ThreadSafeQueue ()
void	Enqueue (const T &element)
bool	Dequeue (T *element)
bool	WaitDequeue (T *element)
std::queue< T >::size_type	Size ()
bool	Empty ()
void	BreakAllWait ()

详细描述

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

在文件 thread_safe_queue.h 第 31 行定义.

构造及析构函数说明

ThreadSafeQueue() [1/2]

template<typename T >

apollo::cyber::base::ThreadSafeQueue< T >::ThreadSafeQueue ( )

inline

在文件 thread_safe_queue.h 第 33 行定义.

{}

ThreadSafeQueue() [2/2]

template<typename T >

apollo::cyber::base::ThreadSafeQueue< T >::ThreadSafeQueue ( const ThreadSafeQueue< T > &  other )

delete

~ThreadSafeQueue()

template<typename T >

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

inline

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

{ BreakAllWait(); }

成员函数说明

BreakAllWait()

template<typename T >

void apollo::cyber::base::ThreadSafeQueue< T >::BreakAllWait ( )

inline

在文件 thread_safe_queue.h 第 76 行定义.

                      {
    break_all_wait_ = true;
    cv_.notify_all();
  }

Dequeue()

template<typename T >

bool apollo::cyber::base::ThreadSafeQueue< T >::Dequeue ( T *  element )

inline

在文件 thread_safe_queue.h 第 45 行定义.

                           {
    std::lock_guard<std::mutex> lock(mutex_);
    if (queue_.empty()) {
      return false;
    }
    *element = std::move(queue_.front());
    queue_.pop();
    return true;
  }

Empty()

template<typename T >

bool apollo::cyber::base::ThreadSafeQueue< T >::Empty ( )

inline

在文件 thread_safe_queue.h 第 71 行定义.

               {
    std::lock_guard<std::mutex> lock(mutex_);
    return queue_.empty();
  }

Enqueue()

template<typename T >

void apollo::cyber::base::ThreadSafeQueue< T >::Enqueue ( const T &  element )

inline

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

                                 {
    std::lock_guard<std::mutex> lock(mutex_);
    queue_.emplace(element);
    cv_.notify_one();
  }

operator=()

template<typename T >

ThreadSafeQueue & apollo::cyber::base::ThreadSafeQueue< T >::operator= ( const ThreadSafeQueue< T > &  other )

delete

Size()

template<typename T >

std::queue< T >::size_type apollo::cyber::base::ThreadSafeQueue< T >::Size ( )

inline

在文件 thread_safe_queue.h 第 66 行定义.

                                       {
    std::lock_guard<std::mutex> lock(mutex_);
    return queue_.size();
  }

WaitDequeue()

template<typename T >

bool apollo::cyber::base::ThreadSafeQueue< T >::WaitDequeue ( T *  element )

inline

在文件 thread_safe_queue.h 第 55 行定义.

                               {
    std::unique_lock<std::mutex> lock(mutex_);
    cv_.wait(lock, [this]() { return break_all_wait_ || !queue_.empty(); });
    if (break_all_wait_) {
      return false;
    }
    *element = std::move(queue_.front());
    queue_.pop();
    return true;
  }

---

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

• cyber/base/thread_safe_queue.h