块队列（ChunkQueue）用于存储和管理数据块 ChunkQueue is used to store and manage chunks of data More...

#include <chunk_queue.hpp>

Collaboration diagram for LibXR::ChunkQueue:

[legend]

Public Types
typedef uint32_t	BlockInfo
	记录块信息的类型 Type for storing block information

Public Member Functions
	ChunkQueue (size_t max_blocks, size_t data_buffer_size)
	构造一个块队列 Constructs a chunk queue

ErrorCode	CreateNewBlock ()
	创建一个新的数据块（线程安全） Creates a new data block (thread-safe)

ErrorCode	AppendToCurrentBlock (const void *data, size_t size)
	创建一个新的数据块（线程安全） Creates a new data block (thread-safe)

ErrorCode	Pop (size_t size, void *data=nullptr)
	弹出指定大小的数据（线程安全） Pops the specified size of data (thread-safe)

ErrorCode	PopFromCallback (size_t size, void *data, bool in_isr)
	从回调函数（ISR）中弹出数据 Pops data from an ISR (Interrupt Service Routine)

ErrorCode	PopBlock (void buffer, size_t out_size)
	弹出整个数据块（线程安全） Pops an entire data block (thread-safe)

ErrorCode	PopBlockFromCallback (void buffer, size_t out_size, bool in_isr)
	从回调函数（ISR）中弹出整个数据块 Pops an entire data block from an ISR

void	Reset ()
	重置队列 Resets the queue

size_t	Size ()
	获取当前数据大小 Gets the current size of the data

size_t	BlockSize ()
	获取当前数据块数量 Gets the current number of data blocks

size_t	SizeFromCallback (bool in_isr)
	从 ISR 中获取当前数据大小 Gets the current data size from an ISR

size_t	BlockSizeFromCallback (bool in_isr)
	从 ISR 中获取当前数据块数量 Gets the current number of data blocks from an ISR

size_t	EmptySize ()
	获取队列的剩余可用空间（线程安全） Gets the remaining available space in the queue (thread-safe)

size_t	EmptyBlockSize ()
	获取块信息的剩余可用空间（线程安全） Gets the remaining available space in the block information (thread-safe)

size_t	EmptySizeFromCallback (bool in_isr)
	从 ISR（中断服务例程）中获取队列的剩余可用空间 Gets the remaining available space in the queue from an ISR (Interrupt Service Routine)

size_t	EmptyBlockSizeFromCallback (bool in_isr)
	从 ISR（中断服务例程）中获取块信息的剩余可用空间 Gets the remaining available space in the block information from an ISR (Interrupt Service Routine)

	ChunkQueue (const ChunkQueue &)=delete

ChunkQueue	operator= (const ChunkQueue &)=delete

ChunkQueue	operator= (ChunkQueue &)=delete

ChunkQueue	operator= (const ChunkQueue &&)=delete

ChunkQueue	operator= (ChunkQueue &&)=delete

Private Member Functions
ErrorCode	CreateNewBlockNoLock ()

ErrorCode	AppendToCurrentBlockNoLock (const void *data, size_t size)

ErrorCode	PopNoLock (size_t size, void *data=nullptr)

ErrorCode	PopBlockNoLock (void buffer, size_t out_size)

Private Attributes
BaseQueue	block_queue_

BaseQueue	data_queue_

size_t	max_blocks_

Mutex	mutex_

Detailed Description

块队列（ChunkQueue）用于存储和管理数据块 ChunkQueue is used to store and manage chunks of data

该类实现了一个支持多块数据存储的队列，提供线程安全的访问方式，并支持从 ISR（中断服务例程）中调用。 This class implements a multi-block data storage queue, provides thread-safe access, and supports calls from an ISR (Interrupt Service Routine).

Definition at line 21 of file chunk_queue.hpp.

Member Typedef Documentation

◆ BlockInfo

typedef uint32_t LibXR::ChunkQueue::BlockInfo

记录块信息的类型 Type for storing block information

Definition at line 24 of file chunk_queue.hpp.

Constructor & Destructor Documentation

◆ ChunkQueue()

LibXR::ChunkQueue::ChunkQueue	(	size_t	max_blocks,
		size_t	data_buffer_size
	)

inline

构造一个块队列 Constructs a chunk queue

Parameters

max_blocks	最大块数 Maximum number of blocks
data_buffer_size	数据缓冲区大小 Size of the data buffer

Definition at line 32 of file chunk_queue.hpp.

      : block_queue_(sizeof(BlockInfo), max_blocks),
        data_queue_(1, data_buffer_size),
        max_blocks_(max_blocks)
  {
    CreateNewBlock();
  }

Member Function Documentation

◆ AppendToCurrentBlock()

ErrorCode LibXR::ChunkQueue::AppendToCurrentBlock	(	const void *	data,
		size_t	size
	)

inline

创建一个新的数据块（线程安全） Creates a new data block (thread-safe)

Returns: 操作结果 ErrorCode indicating success or failure

Definition at line 56 of file chunk_queue.hpp.

  {
    Mutex::LockGuard lock_guard(mutex_);
    return AppendToCurrentBlockNoLock(data, size);
  }

◆ AppendToCurrentBlockNoLock()

ErrorCode LibXR::ChunkQueue::AppendToCurrentBlockNoLock	(	const void *	data,
		size_t	size
	)

inlineprivate

Definition at line 325 of file chunk_queue.hpp.

  {
    if (!data)
    {
      return ErrorCode::PTR_NULL;
    }
    if (size == 0)
    {
      return ErrorCode::ARG_ERR;
    }
 
    if (block_queue_.Size() == 0)
    {
      if (CreateNewBlockNoLock() != ErrorCode::OK)
      {
        return ErrorCode::FULL;
      }
    }
 
    auto index = block_queue_.GetLastElementIndex();
 
    BlockInfo *last_block = static_cast<BlockInfo *>(block_queue_[index]);
 
    if (size > data_queue_.EmptySize())
    {
      return ErrorCode::NO_BUFF;
    }
 
    if (data_queue_.PushBatch(reinterpret_cast<const uint8_t *>(data), size) !=
        ErrorCode::OK)
    {
      return ErrorCode::FULL;
    }
 
    *last_block += size;
    return ErrorCode::OK;
  }

◆ BlockSize()

size_t LibXR::ChunkQueue::BlockSize ( )

inline

获取当前数据块数量 Gets the current number of data blocks

Returns: 当前数据块数量 Current number of data blocks

Definition at line 158 of file chunk_queue.hpp.

  {
    Mutex::LockGuard lock_guard(mutex_);
 
    return block_queue_.Size();
  }

◆ BlockSizeFromCallback()

size_t LibXR::ChunkQueue::BlockSizeFromCallback ( bool in_isr )

inline

从 ISR 中获取当前数据块数量 Gets the current number of data blocks from an ISR

Parameters

in_isr 是否在 ISR 中调用 Whether it is called from an ISR

Returns: size_t 当前数据块数量 Current number of data blocks

Definition at line 190 of file chunk_queue.hpp.

  {
    Mutex::LockGuardInCallback lock_guard(mutex_, in_isr);
 
    if (!lock_guard.Locked())
    {
      return 0;
    }
 
    return block_queue_.Size();
  }

◆ CreateNewBlock()

ErrorCode LibXR::ChunkQueue::CreateNewBlock ( )

inline

创建一个新的数据块（线程安全） Creates a new data block (thread-safe)

Returns: 操作结果 ErrorCode indicating success or failure

Definition at line 45 of file chunk_queue.hpp.

  {
    Mutex::LockGuard lock_guard(mutex_);
    return CreateNewBlockNoLock();
  }

◆ CreateNewBlockNoLock()

ErrorCode LibXR::ChunkQueue::CreateNewBlockNoLock ( )

inlineprivate

Definition at line 304 of file chunk_queue.hpp.

  {
    auto index = block_queue_.GetLastElementIndex();
 
    if (index >= 0)
    {
      BlockInfo *last_block = reinterpret_cast<BlockInfo *>(block_queue_[index]);
      if (*last_block == 0)
      {
        return ErrorCode::OK;
      }
    }
 
    if (block_queue_.Size() >= max_blocks_)
    {
      return ErrorCode::FULL;
    }
    BlockInfo new_block{0};
    return block_queue_.Push(&new_block);
  }

◆ EmptyBlockSize()

size_t LibXR::ChunkQueue::EmptyBlockSize ( )

inline

获取块信息的剩余可用空间（线程安全） Gets the remaining available space in the block information (thread-safe)

Returns: size_t

Definition at line 236 of file chunk_queue.hpp.

  {
    Mutex::LockGuard lock_guard(mutex_);
    return block_queue_.EmptySize();
  }

◆ EmptyBlockSizeFromCallback()

size_t LibXR::ChunkQueue::EmptyBlockSizeFromCallback ( bool in_isr )

inline

从 ISR（中断服务例程）中获取块信息的剩余可用空间 Gets the remaining available space in the block information from an ISR (Interrupt Service Routine)

Parameters

in_isr 是否在 ISR 中调用 Whether it is called from an ISR

Returns: size_t 剩余可用空间 The remaining available space

Definition at line 285 of file chunk_queue.hpp.

  {
    Mutex::LockGuardInCallback lock_guard(mutex_, in_isr);
 
    if (!lock_guard.Locked())
    {
      return 0;
    }
 
    return block_queue_.EmptySize();
  }

◆ EmptySize()

size_t LibXR::ChunkQueue::EmptySize ( )

inline

获取队列的剩余可用空间（线程安全） Gets the remaining available space in the queue (thread-safe)

Returns: 可用空间大小 The size of available space

该方法通过互斥锁保证线程安全，检查 block_queue_ 是否还有空余块，若有，则返回 data_queue_ 的剩余空间，否则返回 0。

This method ensures thread safety using a mutex lock. It checks whether block_queue_ has available blocks. If available, it returns the remaining space in data_queue_, otherwise, it returns 0.

Definition at line 216 of file chunk_queue.hpp.

  {
    Mutex::LockGuard lock_guard(mutex_);
 
    if (block_queue_.EmptySize() > 0)
    {
      return data_queue_.EmptySize();
    }
    else
    {
      return 0;
    }
  }

◆ EmptySizeFromCallback()

size_t LibXR::ChunkQueue::EmptySizeFromCallback ( bool in_isr )

inline

从 ISR（中断服务例程）中获取队列的剩余可用空间 Gets the remaining available space in the queue from an ISR (Interrupt Service Routine)

Parameters

in_isr 是否在 ISR 中调用 Whether it is called from an ISR

Returns: 可用空间大小 The size of available space

该方法在中断服务例程（ISR）中安全使用，通过 Mutex::LockGuardInCallback 进行锁保护。若 block_queue_ 仍有可用块，则返回 data_queue_ 的剩余空间，否则返回 0。

This method is safe to use in an ISR (Interrupt Service Routine), protected by Mutex::LockGuardInCallback. If block_queue_ has available blocks, it returns the remaining space in data_queue_, otherwise, it returns 0.

Definition at line 258 of file chunk_queue.hpp.

  {
    Mutex::LockGuardInCallback lock_guard(mutex_, in_isr);
 
    if (!lock_guard.Locked())
    {
      return 0;
    }
 
    if (block_queue_.EmptySize() > 0)
    {
      return data_queue_.EmptySize();
    }
    else
    {
      return 0;
    }
  }

◆ Pop()

ErrorCode LibXR::ChunkQueue::Pop	(	size_t	size,
		void *	data = `nullptr`
	)

inline

弹出指定大小的数据（线程安全） Pops the specified size of data (thread-safe)

Parameters

size	要弹出的数据大小 Size of the data to pop
data	存储弹出数据的缓冲区（可选） Buffer to store popped data (optional)

Returns: 操作结果 ErrorCode indicating success or failure

Definition at line 69 of file chunk_queue.hpp.

  {
    Mutex::LockGuard lock_guard(mutex_);
 
    return PopNoLock(size, data);
  }

◆ PopBlock()

ErrorCode LibXR::ChunkQueue::PopBlock	(	void *	buffer,
		size_t *	out_size
	)

inline

弹出整个数据块（线程安全） Pops an entire data block (thread-safe)

Parameters

buffer	存储数据的缓冲区 Buffer to store popped data
out_size	返回的块大小 Output parameter for block size

Returns: 操作结果 ErrorCode indicating success or failure

Definition at line 103 of file chunk_queue.hpp.

  {
    Mutex::LockGuard lock_guard(mutex_);
 
    return PopBlockNoLock(buffer, out_size);
  }

◆ PopBlockFromCallback()

ErrorCode LibXR::ChunkQueue::PopBlockFromCallback	(	void *	buffer,
		size_t *	out_size,
		bool	in_isr
	)

inline

从回调函数（ISR）中弹出整个数据块 Pops an entire data block from an ISR

Parameters

buffer	存储数据的缓冲区 Buffer to store popped data
out_size	返回的块大小 Output parameter for block size
in_isr	是否在 ISR 中调用 Whether it is called from an ISR

Returns: 操作结果 ErrorCode indicating success or failure

Definition at line 118 of file chunk_queue.hpp.

  {
    Mutex::LockGuardInCallback lock_guard(mutex_, in_isr);
 
    if (!lock_guard.Locked())
    {
      return ErrorCode::TIMEOUT;
    }
 
    return PopBlockNoLock(buffer, out_size);
  }

◆ PopBlockNoLock()

ErrorCode LibXR::ChunkQueue::PopBlockNoLock	(	void *	buffer,
		size_t *	out_size
	)

inlineprivate

Definition at line 409 of file chunk_queue.hpp.

  {
    auto index = block_queue_.GetFirstElementIndex();
 
    if (index >= 0)
    {
      BlockInfo *last_block = static_cast<BlockInfo *>(block_queue_[index]);
      if (*last_block == 0)
      {
        return ErrorCode::EMPTY;
      }
    }
    else
    {
      return ErrorCode::EMPTY;
    }
 
    BlockInfo block;  // NOLINT
    if (block_queue_.Pop(&block) != ErrorCode::OK)
    {
      ASSERT(false);
      return ErrorCode::EMPTY;
    }
 
    if (data_queue_.PopBatch(buffer, block) != ErrorCode::OK)
    {
      ASSERT(false);
      return ErrorCode::CHECK_ERR;
    }
    *out_size = block;
    return ErrorCode::OK;
  }

◆ PopFromCallback()

ErrorCode LibXR::ChunkQueue::PopFromCallback	(	size_t	size,
		void *	data,
		bool	in_isr
	)

inline

从回调函数（ISR）中弹出数据 Pops data from an ISR (Interrupt Service Routine)

Parameters

size	要弹出的数据大小 Size of the data to pop
data	存储弹出数据的缓冲区 Buffer to store popped data
in_isr	是否在中断服务程序（ISR）中调用 Whether it is called from an ISR

Returns: 操作结果 ErrorCode indicating success or failure

Definition at line 84 of file chunk_queue.hpp.

  {
    Mutex::LockGuardInCallback lock_guard(mutex_, in_isr);
 
    if (!lock_guard.Locked())
    {
      return ErrorCode::TIMEOUT;
    }
 
    return PopNoLock(size, data);
  }

◆ PopNoLock()

ErrorCode LibXR::ChunkQueue::PopNoLock	(	size_t	size,
		void *	data = `nullptr`
	)

inlineprivate

Definition at line 363 of file chunk_queue.hpp.

  {
    if (data_queue_.Size() < size)
    {
      return ErrorCode::EMPTY;
    }
 
    size_t remaining_size = size;
 
    while (remaining_size > 0)
    {
      auto index = block_queue_.GetFirstElementIndex();
      if (index < 0)
      {
        return ErrorCode::CHECK_ERR;
      }
 
      BlockInfo *block = static_cast<BlockInfo *>(block_queue_[index]);
 
      if (remaining_size < *block)
      {
        if (data_queue_.PopBatch(data, remaining_size) != ErrorCode::OK)
        {
          ASSERT(false);
          return ErrorCode::CHECK_ERR;
        }
 
        *block -= remaining_size;
        remaining_size = 0;
      }
      else
      {
        if (data_queue_.PopBatch(data, *block) != ErrorCode::OK)
        {
          ASSERT(false);
          return ErrorCode::CHECK_ERR;
        }
        remaining_size -= *block;
        data = static_cast<uint8_t *>(data) + *block;
        block_queue_.Pop();
      }
    }
 
    return ErrorCode::OK;
  }

◆ Reset()

void LibXR::ChunkQueue::Reset ( )

inline

重置队列 Resets the queue

Definition at line 134 of file chunk_queue.hpp.

  {
    block_queue_.Reset();
    data_queue_.Reset();
  }

◆ Size()

size_t LibXR::ChunkQueue::Size ( )

inline

获取当前数据大小 Gets the current size of the data

Returns: 当前数据大小 Current data size

Definition at line 145 of file chunk_queue.hpp.

  {
    Mutex::LockGuard lock_guard(mutex_);
 
    return data_queue_.Size();
  }

◆ SizeFromCallback()

size_t LibXR::ChunkQueue::SizeFromCallback ( bool in_isr )

inline

从 ISR 中获取当前数据大小 Gets the current data size from an ISR

Parameters

in_isr 是否在 ISR 中调用 Whether it is called from an ISR

Returns: 当前数据大小 Current data size

Definition at line 171 of file chunk_queue.hpp.

  {
    Mutex::LockGuardInCallback lock_guard(mutex_, in_isr);
 
    if (!lock_guard.Locked())
    {
      return 0;
    }
 
    return data_queue_.Size();
  }

Field Documentation

◆ block_queue_

BaseQueue LibXR::ChunkQueue::block_queue_

private

Definition at line 442 of file chunk_queue.hpp.

◆ data_queue_

BaseQueue LibXR::ChunkQueue::data_queue_

private

Definition at line 443 of file chunk_queue.hpp.

◆ max_blocks_

size_t LibXR::ChunkQueue::max_blocks_

private

Definition at line 444 of file chunk_queue.hpp.

◆ mutex_

Mutex LibXR::ChunkQueue::mutex_

private

Definition at line 445 of file chunk_queue.hpp.

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

src/structure/chunk_queue.hpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ BlockInfo

Constructor & Destructor Documentation

◆ ChunkQueue()

Member Function Documentation

◆ AppendToCurrentBlock()

◆ AppendToCurrentBlockNoLock()

◆ BlockSize()

◆ BlockSizeFromCallback()

◆ CreateNewBlock()

◆ CreateNewBlockNoLock()

◆ EmptyBlockSize()

◆ EmptyBlockSizeFromCallback()

◆ EmptySize()

◆ EmptySizeFromCallback()

◆ Pop()

◆ PopBlock()

◆ PopBlockFromCallback()

◆ PopBlockNoLock()

◆ PopFromCallback()

◆ PopNoLock()

◆ Reset()

◆ Size()

◆ SizeFromCallback()

Field Documentation

◆ block_queue_

◆ data_queue_

◆ max_blocks_

◆ mutex_