WritePort class for handling write operations. More...

#include <libxr_rw.hpp>

Inheritance diagram for LibXR::WritePort:

Collaboration diagram for LibXR::WritePort:

Data Structures
class	Stream
	WritePort 的流式写入操作器，支持链式 << 操作和批量提交。 More...

Public Types
enum class	LockState : uint32_t { LOCKED = 0 , UNLOCKED = UINT32_MAX }

Public Member Functions
	WritePort (size_t queue_size=3, size_t buffer_size=128)
	构造一个新的 WritePort 对象。 Constructs a new WritePort object.

virtual size_t	EmptySize ()
	获取数据队列的剩余可用空间。 Gets the remaining available space in the data queue.

virtual size_t	Size ()
	获取当前数据队列的已使用大小。 Gets the used size of the current data queue.

bool	Writable ()
	判断端口是否可写。 Checks whether the port is writable.

WritePort &	operator= (WriteFun fun)
	赋值运算符重载，用于设置写入函数。 Overloaded assignment operator to set the write function.

void	Finish (bool in_isr, ErrorCode ans, WriteInfoBlock &info, uint32_t size)
	更新写入操作的状态。 Updates the status of the write operation.

void	MarkAsRunning (WriteOperation &op)
	标记写入操作为运行中。 Marks the write operation as running.

ErrorCode	operator() (ConstRawData data, WriteOperation &op)
	执行写入操作。 Performs a write operation.

virtual void	Reset ()
	Resets the WritePort.

Data Fields
WriteFun	write_fun_ = nullptr

LockFreeQueue< WriteInfoBlock > *	queue_info_

LockFreeQueue< uint8_t > *	queue_data_

std::atomic< LockState >	lock_ {LockState::UNLOCKED}

size_t	write_size_ = 0

Private Member Functions
ErrorCode	CommitWrite (ConstRawData data, WriteOperation &op, bool pushed=false)

Detailed Description

WritePort class for handling write operations.

处理写入操作的WritePort类。

Definition at line 401 of file libxr_rw.hpp.

Member Enumeration Documentation

◆ LockState

enum class LibXR::WritePort::LockState : uint32_t

strong

Definition at line 404 of file libxr_rw.hpp.

  {
    LOCKED = 0,
    UNLOCKED = UINT32_MAX
  };

Constructor & Destructor Documentation

◆ WritePort()

WritePort::WritePort	(	size_t	queue_size = 3,
		size_t	buffer_size = 128 )

构造一个新的 WritePort 对象。 Constructs a new WritePort object.

该构造函数初始化无锁操作队列 queue_info_ 和数据块队列 queue_data_。 This constructor initializes the lock-free operation queue queue_info_ and the data block queue queue_data_.

Parameters

queue_size	队列的大小，默认为 3。 The size of the queue, default is 3.
block_size	缓存的数据的最大大小，默认为 128。 The maximum size of cached data, default is 128.

Definition at line 179 of file libxr_rw.cpp.

    : queue_info_(new(std::align_val_t(LIBXR_CACHE_LINE_SIZE))
                      LockFreeQueue<WriteInfoBlock>(queue_size)),
      queue_data_(buffer_size > 0 ? new(std::align_val_t(LIBXR_CACHE_LINE_SIZE))
                                        LockFreeQueue<uint8_t>(buffer_size)
                                  : nullptr)
{
}

Member Function Documentation

◆ CommitWrite()

ErrorCode WritePort::CommitWrite	(	ConstRawData	data,
		WriteOperation &	op,
		bool	pushed = false )

private

Definition at line 244 of file libxr_rw.cpp.

{
  if (!pushed && queue_info_->EmptySize() < 1)
  {
    lock_.store(LockState::UNLOCKED, std::memory_order_release);
    return ErrorCode::FULL;
  }
 
  if (queue_data_)
  {
    ErrorCode ans = ErrorCode::OK;
    if (!pushed)
    {
      if (queue_data_->EmptySize() < data.size_)
      {
        lock_.store(LockState::UNLOCKED, std::memory_order_release);
        return ErrorCode::FULL;
      }
 
      ans = queue_data_->PushBatch(reinterpret_cast<const uint8_t*>(data.addr_),
                                   data.size_);
      UNUSED(ans);
      ASSERT(ans == ErrorCode::OK);
 
      WriteInfoBlock info{data, op};
      ans = queue_info_->Push(info);
 
      ASSERT(ans == ErrorCode::OK);
    }
 
    op.MarkAsRunning();
 
    ans = write_fun_(*this);
 
    lock_.store(LockState::UNLOCKED, std::memory_order_release);
 
    if (ans == ErrorCode::OK)
    {
      write_size_ = data.size_;
      if (op.type != WriteOperation::OperationType::BLOCK)
      {
        op.UpdateStatus(false, ErrorCode::OK);
      }
      return ErrorCode::OK;
    }
 
    if (op.type == WriteOperation::OperationType::BLOCK)
    {
      return op.data.sem_info.sem->Wait(op.data.sem_info.timeout);
    }
 
    return ErrorCode::OK;
  }
  else
  {
    WriteInfoBlock info{data, op};
    auto ans = queue_info_->Push(info);
 
    ASSERT(ans == ErrorCode::OK);
 
    op.MarkAsRunning();
 
    ans = write_fun_(*this);
 
    lock_.store(LockState::UNLOCKED, std::memory_order_release);
 
    if (ans == ErrorCode::OK)
    {
      write_size_ = data.size_;
      if (op.type != WriteOperation::OperationType::BLOCK)
      {
        op.UpdateStatus(false, ErrorCode::OK);
      }
      return ErrorCode::OK;
    }
 
    if (op.type == WriteOperation::OperationType::BLOCK)
    {
      return op.data.sem_info.sem->Wait(op.data.sem_info.timeout);
    }
    else
    {
      return ErrorCode::OK;
    }
  }
}

◆ EmptySize()

size_t WritePort::EmptySize ( )

virtual

获取数据队列的剩余可用空间。 Gets the remaining available space in the data queue.

Returns: 返回数据队列的空闲大小。 Returns the empty size of the data queue.

Reimplemented in LibXR::ESP32UARTWritePort, and LibXR::TinyUSBUARTWritePort.

Definition at line 188 of file libxr_rw.cpp.

{
  ASSERT(queue_data_ != nullptr);
  return queue_data_->EmptySize();
}

◆ Finish()

void WritePort::Finish	(	bool	in_isr,
		ErrorCode	ans,
		WriteInfoBlock &	info,
		uint32_t	size )

更新写入操作的状态。 Updates the status of the write operation.

该函数在写入操作过程中更新 write_size_ 并调用 UpdateStatus 方法更新 op 的状态。 This function updates write_size_ and calls UpdateStatus on op during a write operation.

Parameters

in_isr	指示是否在中断上下文中执行。 Indicates whether the operation is executed in an interrupt context.
ans	错误码，用于指示操作的结果。 Error code indicating the result of the operation.
op	需要更新状态的 `WriteOperation` 引用。 Reference to the `WriteOperation` whose status needs to be updated.
size	写入的数据大小。 The size of the written data.

Definition at line 208 of file libxr_rw.cpp.

{
  write_size_ = size;
  info.op.UpdateStatus(in_isr, std::forward<ErrorCode>(ans));
}

◆ MarkAsRunning()

void WritePort::MarkAsRunning ( WriteOperation & op )

标记写入操作为运行中。 Marks the write operation as running.

该函数用于将 op 标记为运行状态，以指示当前正在进行写入操作。 This function marks op as running to indicate an ongoing write operation.

Parameters

op	需要更新状态的 `WriteOperation` 引用。 Reference to the `WriteOperation` whose status needs to be updated.

Definition at line 214 of file libxr_rw.cpp.

214{ op.MarkAsRunning(); }

◆ operator()()

ErrorCode WritePort::operator()	(	ConstRawData	data,
		WriteOperation &	op )

执行写入操作。 Performs a write operation.

该函数检查端口是否可写，并根据 data.size_ 和 op 的类型执行不同的操作。 This function checks if the port is writable and performs different actions based on data.size_ and the type of op.

Parameters

data	需要写入的原始数据。 Raw data to be written.
op	写入操作对象，包含操作类型和同步机制。 Write operation object containing the operation type and synchronization mechanism.

Returns: 返回操作的 ErrorCode，指示操作结果。 Returns an ErrorCode indicating the result of the operation.

Definition at line 216 of file libxr_rw.cpp.

{
  if (Writable())
  {
    if (data.size_ == 0)
    {
      write_size_ = 0;
      if (op.type != WriteOperation::OperationType::BLOCK)
      {
        op.UpdateStatus(false, ErrorCode::OK);
      }
      return ErrorCode::OK;
    }
 
    LockState expected = LockState::UNLOCKED;
    if (!lock_.compare_exchange_strong(expected, LockState::LOCKED))
    {
      return ErrorCode::BUSY;
    }
 
    return CommitWrite(data, op);
  }
  else
  {
    return ErrorCode::NOT_SUPPORT;
  }
}

◆ operator=()

WritePort & WritePort::operator= ( WriteFun fun )

赋值运算符重载，用于设置写入函数。 Overloaded assignment operator to set the write function.

该函数允许使用 WriteFun 类型的函数对象赋值给 WritePort，从而设置 write_fun_。 This function allows assigning a WriteFun function object to WritePort, setting write_fun_.

Parameters

fun	要分配的写入函数。 The write function to be assigned.

Returns: 返回自身的引用，以支持链式调用。 Returns a reference to itself for chaining.

Definition at line 202 of file libxr_rw.cpp.

{
  write_fun_ = fun;
  return *this;
}

◆ Reset()

void WritePort::Reset ( )

virtual

Resets the WritePort.

重置WritePort。

Reimplemented in LibXR::ESP32UARTWritePort, and LibXR::TinyUSBUARTWritePort.

Definition at line 331 of file libxr_rw.cpp.

{
  ASSERT(queue_data_ != nullptr);
  queue_data_->Reset();
  queue_info_->Reset();
}

◆ Size()

size_t WritePort::Size ( )

virtual

获取当前数据队列的已使用大小。 Gets the used size of the current data queue.

Returns: 返回数据队列的已使用大小。 Returns the size of the data queue.

Reimplemented in LibXR::ESP32UARTWritePort, and LibXR::TinyUSBUARTWritePort.

Definition at line 194 of file libxr_rw.cpp.

{
  ASSERT(queue_data_ != nullptr);
  return queue_data_->Size();
}

◆ Writable()

bool WritePort::Writable ( )

判断端口是否可写。 Checks whether the port is writable.

Returns: 如果 write_fun_ 不为空，则返回 true，否则返回 false。 Returns true if write_fun_ is not null, otherwise returns false.

Definition at line 200 of file libxr_rw.cpp.

200{ return write_fun_ != nullptr; }

Field Documentation

◆ lock_

std::atomic<LockState> LibXR::WritePort::lock_ {LockState::UNLOCKED}

Definition at line 413 of file libxr_rw.hpp.

413{LockState::UNLOCKED};

◆ queue_data_

LockFreeQueue<uint8_t>* LibXR::WritePort::queue_data_

Definition at line 412 of file libxr_rw.hpp.

◆ queue_info_

LockFreeQueue<WriteInfoBlock>* LibXR::WritePort::queue_info_

Definition at line 411 of file libxr_rw.hpp.

◆ write_fun_

WriteFun LibXR::WritePort::write_fun_ = nullptr

Definition at line 410 of file libxr_rw.hpp.

◆ write_size_

size_t LibXR::WritePort::write_size_ = 0

Definition at line 414 of file libxr_rw.hpp.

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

src/core/libxr_rw.hpp
src/core/libxr_rw.cpp

Data Structures

Public Types

Public Member Functions

Data Fields

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ LockState

Constructor & Destructor Documentation

◆ WritePort()

Member Function Documentation

◆ CommitWrite()

◆ EmptySize()

◆ Finish()

◆ MarkAsRunning()

◆ operator()()

◆ operator=()

◆ Reset()

◆ Size()

◆ Writable()

Field Documentation

◆ lock_

◆ queue_data_

◆ queue_info_

◆ write_fun_

◆ write_size_