LibXR::LockQueue< Data > Class Template Reference

线程安全的锁队列类，提供同步和异步操作支持 Thread-safe lock queue class with synchronous and asynchronous operation support More...

#include <lock_queue.hpp>

Collaboration diagram for LibXR::LockQueue< Data >:

Public Member Functions
	LockQueue (size_t length)
	构造函数，初始化队列 Constructor to initialize the queue
	~LockQueue ()
	析构函数，释放资源 Destructor to release resources
ErrorCode	Push (const Data &data)
	向队列中推送数据 Pushes data into the queue
ErrorCode	Pop (Data &data, uint32_t timeout)
	从队列中弹出数据（带超时） Pops data from the queue with timeout
ErrorCode	Pop ()
	无参数弹出数据 Pops data from the queue without storing it
ErrorCode	Pop (uint32_t timeout)
	带超时的弹出数据 Pops data from the queue with timeout
ErrorCode	PushFromCallback (const Data &data, bool in_isr)
	从回调函数中推送数据 Pushes data into the queue from a callback function
size_t	Size ()
	获取队列中的数据项数量 Gets the number of items in the queue
size_t	EmptySize ()
	获取队列的剩余容量 Gets the remaining capacity of the queue

Private Attributes
Queue< Data >	queue_handle_
	底层队列对象 Underlying queue object
Mutex	mutex_
	互斥锁 Mutex for thread safety
Semaphore	semaphore_handle_
	信号量 Semaphore for synchronization

Detailed Description

template<typename Data>
class LibXR::LockQueue< Data >

线程安全的锁队列类，提供同步和异步操作支持 Thread-safe lock queue class with synchronous and asynchronous operation support

Template Parameters

Data	队列存储的数据类型 The type of data stored in the queue

Definition at line 20 of file lock_queue.hpp.

Constructor & Destructor Documentation

LockQueue()

template<typename Data >

LibXR::LockQueue< Data >::LockQueue ( size_t length )

inline

构造函数，初始化队列 Constructor to initialize the queue

Parameters

length

队列的最大长度 Maximum length of the queue

Definition at line 28 of file lock_queue.hpp.

: queue_handle_(length) {}

~LockQueue()

template<typename Data >

LibXR::LockQueue< Data >::~LockQueue ( )

inline

析构函数，释放资源 Destructor to release resources

Definition at line 34 of file lock_queue.hpp.

{}

Member Function Documentation

EmptySize()

template<typename Data >

size_t LibXR::LockQueue< Data >::EmptySize ( )

inline

获取队列的剩余容量 Gets the remaining capacity of the queue

Returns

剩余空间大小 Remaining space size

Definition at line 163 of file lock_queue.hpp.

  {
    if (mutex_.Lock() != ErrorCode::OK)
    {
      return 0;
    }
    auto ans = queue_handle_.EmptySize();
    mutex_.Unlock();
    return ans;
  }

Pop() [1/3]

template<typename Data >

ErrorCode LibXR::LockQueue< Data >::Pop ( )

inline

无参数弹出数据 Pops data from the queue without storing it

Returns

操作结果 ErrorCode indicating success or failure

Definition at line 91 of file lock_queue.hpp.

  {
    const ErrorCode lock_ans = mutex_.Lock();
    if (lock_ans != ErrorCode::OK)
    {
      return lock_ans;
    }
    auto ans = queue_handle_.Pop();
    mutex_.Unlock();
    return ans;
  }

Pop() [2/3]

template<typename Data >

ErrorCode LibXR::LockQueue< Data >::Pop ( Data & data, uint32_t timeout )

inline

从队列中弹出数据（带超时） Pops data from the queue with timeout

Parameters

data	存储弹出数据的变量 Variable to store the popped data
timeout	超时时间（毫秒） Timeout in milliseconds

Returns

操作结果 ErrorCode indicating success or failure

Definition at line 66 of file lock_queue.hpp.

  {
    const ErrorCode wait_ans = semaphore_handle_.Wait(timeout);
    if (wait_ans == ErrorCode::OK)
    {
      const ErrorCode lock_ans = mutex_.Lock();
      if (lock_ans != ErrorCode::OK)
      {
        semaphore_handle_.Post();
        return lock_ans;
      }
 
      auto ans = queue_handle_.Pop(data);
      mutex_.Unlock();
      return ans;
    }
 
    return wait_ans;
  }

Pop() [3/3]

template<typename Data >

ErrorCode LibXR::LockQueue< Data >::Pop ( uint32_t timeout )

inline

带超时的弹出数据 Pops data from the queue with timeout

Parameters

timeout

超时时间（毫秒） Timeout in milliseconds

Returns

操作结果 ErrorCode indicating success or failure

Definition at line 109 of file lock_queue.hpp.

  {
    const ErrorCode wait_ans = semaphore_handle_.Wait(timeout);
    if (wait_ans == ErrorCode::OK)
    {
      const ErrorCode lock_ans = mutex_.Lock();
      if (lock_ans != ErrorCode::OK)
      {
        semaphore_handle_.Post();
        return lock_ans;
      }
 
      auto ans = queue_handle_.Pop();
      mutex_.Unlock();
      return ans;
    }
 
    return wait_ans;
  }

Push()

template<typename Data >

ErrorCode LibXR::LockQueue< Data >::Push ( const Data & data )

inline

向队列中推送数据 Pushes data into the queue

Parameters

data	要推送的数据 The data to be pushed

Returns

操作结果 ErrorCode indicating success or failure

Definition at line 42 of file lock_queue.hpp.

  {
    const ErrorCode lock_ans = mutex_.Lock();
    if (lock_ans != ErrorCode::OK)
    {
      return lock_ans;
    }
 
    auto ans = queue_handle_.Push(data);
    if (ans == ErrorCode::OK)
    {
      semaphore_handle_.Post();
    }
    mutex_.Unlock();
    return ans;
  }

PushFromCallback()

template<typename Data >

ErrorCode LibXR::LockQueue< Data >::PushFromCallback ( const Data & data, bool in_isr )

inline

从回调函数中推送数据 Pushes data into the queue from a callback function

Parameters

data	要推送的数据 The data to be pushed
in_isr	是否在中断上下文中 Whether the function is called from an ISR

Returns

操作结果 ErrorCode indicating success or failure

Definition at line 136 of file lock_queue.hpp.

  {
    UNUSED(in_isr);
    return Push(data);
  }

Size()

template<typename Data >

size_t LibXR::LockQueue< Data >::Size ( )

inline

获取队列中的数据项数量 Gets the number of items in the queue

Returns

当前队列大小 Current queue size

Definition at line 147 of file lock_queue.hpp.

  {
    if (mutex_.Lock() != ErrorCode::OK)
    {
      return 0;
    }
    auto ans = queue_handle_.Size();
    mutex_.Unlock();
    return ans;
  }

Field Documentation

mutex_

template<typename Data >

Mutex LibXR::LockQueue< Data >::mutex_

private

互斥锁 Mutex for thread safety

Definition at line 176 of file lock_queue.hpp.

queue_handle_

template<typename Data >

Queue<Data> LibXR::LockQueue< Data >::queue_handle_

private

底层队列对象 Underlying queue object

Definition at line 175 of file lock_queue.hpp.

semaphore_handle_

template<typename Data >

Semaphore LibXR::LockQueue< Data >::semaphore_handle_

private

信号量 Semaphore for synchronization

Definition at line 177 of file lock_queue.hpp.

---

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

• system/linux/lock_queue.hpp