Defines an operation with different execution modes. More...

#include <operation.hpp>

Collaboration diagram for LibXR::Operation< Args >:

Public Types
enum class	OperationType : uint8_t { CALLBACK , BLOCK , POLLING , NONE }

enum class	OperationPollingStatus : uint8_t { READY , RUNNING , DONE , ERROR }

using	Callback = LibXR::Callback<Args>

Public Member Functions
	Operation ()
	Default constructor, initializes with NONE type.

	Operation (Semaphore &sem, uint32_t timeout=UINT32_MAX)
	Constructs a blocking operation with a semaphore and timeout.

	Operation (Callback &callback)
	Constructs a callback-based operation.

	Operation (OperationPollingStatus &status)
	Constructs a polling operation.

	Operation (const Operation &op)

	Operation (Operation &&op) noexcept

Operation &	operator= (const Operation &op)
	Copy assignment operator.

Operation &	operator= (Operation &&op) noexcept
	Move assignment operator.

template<typename Status >
void	UpdateStatus (bool in_isr, Status &&status)
	Updates operation status based on type.

void	MarkAsRunning ()
	标记操作为运行状态。 Marks the operation as running.

Data Fields
union {

Callback * callback

struct {

Semaphore * sem

uint32_t timeout

} sem_info

OperationPollingStatus * status

}	data

OperationType	type

Detailed Description

template<typename Args>
class LibXR::Operation< Args >

Defines an operation with different execution modes.

定义了一种具有不同执行模式的操作。

Template Parameters

Args	The parameter types for callback operations.
Args	用于回调操作的参数类型。

Definition at line 23 of file operation.hpp.

Member Typedef Documentation

◆ Callback

template<typename Args >

using LibXR::Operation< Args >::Callback = LibXR::Callback<Args>

Definition at line 26 of file operation.hpp.

Member Enumeration Documentation

◆ OperationPollingStatus

template<typename Args >

enum class LibXR::Operation::OperationPollingStatus : uint8_t

strong

Polling operation status. 轮询操作的状态。

Definition at line 40 of file operation.hpp.

  {
    READY,
    RUNNING,
    DONE,
    ERROR
  };

◆ OperationType

template<typename Args >

enum class LibXR::Operation::OperationType : uint8_t

strong

Operation types. 操作类型。

Definition at line 30 of file operation.hpp.

  {
    CALLBACK,
    BLOCK,
    POLLING,
    NONE
  };

Constructor & Destructor Documentation

◆ Operation() [1/6]

template<typename Args >

LibXR::Operation< Args >::Operation ( )

inline

Default constructor, initializes with NONE type.

默认构造函数，初始化为NONE类型。

Definition at line 50 of file operation.hpp.

50: data{nullptr}, type(OperationType::NONE) {}

LibXR::Operation::data

union LibXR::Operation::@5 data

LibXR::Operation::type

OperationType type

Definition operation.hpp:222

◆ Operation() [2/6]

template<typename Args >

LibXR::Operation< Args >::Operation	(	Semaphore &	sem,
		uint32_t	timeout = UINT32_MAX )

inline

Constructs a blocking operation with a semaphore and timeout.

使用信号量和超时构造阻塞操作。

Parameters

sem	Semaphore reference.
timeout	Timeout duration (default is maximum).

Note: sem must be dedicated to one live BLOCK call at a time. Reuse is allowed only after that call returns.; sem 在任一时刻只能服务一个存活中的 BLOCK 调用；只有在该调用返回后才能复用。

Definition at line 63 of file operation.hpp.

64 : data{.sem_info = {&sem, timeout}}, type(OperationType::BLOCK)

65 {}

◆ Operation() [3/6]

template<typename Args >

LibXR::Operation< Args >::Operation ( Callback & callback )

inline

Constructs a callback-based operation.

构造基于回调的操作。

Parameters

callback Callback function reference.

Definition at line 72 of file operation.hpp.

73 : data{.callback = &callback}, type(OperationType::CALLBACK)

74 {}

◆ Operation() [4/6]

template<typename Args >

LibXR::Operation< Args >::Operation ( OperationPollingStatus & status )

inline

Constructs a polling operation.

构造轮询操作。

Parameters

status Reference to polling status.

Definition at line 81 of file operation.hpp.

82 : data{.status = &status}, type(OperationType::POLLING)

83 {}

◆ Operation() [5/6]

template<typename Args >

LibXR::Operation< Args >::Operation ( const Operation< Args > & op )

inline

Definition at line 85 of file operation.hpp.

                                 : data{nullptr}, type(OperationType::NONE)
  {
    *this = op;
  }

◆ Operation() [6/6]

template<typename Args >

LibXR::Operation< Args >::Operation ( Operation< Args > && op )

inlinenoexcept

Definition at line 90 of file operation.hpp.

                                     : data{nullptr}, type(OperationType::NONE)
  {
    *this = std::move(op);
  }

Member Function Documentation

◆ MarkAsRunning()

template<typename Args >

void LibXR::Operation< Args >::MarkAsRunning ( )

inline

标记操作为运行状态。 Marks the operation as running.

该函数用于在操作类型为 POLLING 时，将 data.status 设置为 RUNNING，以指示该操作正在执行中。 This function sets data.status to RUNNING when the operation type is POLLING, indicating that the operation is currently in progress.

Note: 该方法仅适用于 OperationType::POLLING 类型的操作，其他类型不会受到影响。 This method only applies to operations of type OperationType::POLLING, and other types remain unaffected.

Definition at line 199 of file operation.hpp.

  {
    if (type == OperationType::POLLING)
    {
      *data.status = OperationPollingStatus::RUNNING;
    }
  }

◆ operator=() [1/2]

template<typename Args >

Operation & LibXR::Operation< Args >::operator= ( const Operation< Args > & op )

inline

Copy assignment operator.

复制赋值运算符。

Parameters

op	Another Operation instance.

Returns: Reference to this operation.

Definition at line 101 of file operation.hpp.

  {
    if (this != &op)
    {
      type = op.type;
      switch (type)
      {
        case OperationType::CALLBACK:
          data.callback = op.data.callback;
          break;
        case OperationType::BLOCK:
          data.sem_info.sem = op.data.sem_info.sem;
          data.sem_info.timeout = op.data.sem_info.timeout;
          break;
        case OperationType::POLLING:
          data.status = op.data.status;
          break;
        case OperationType::NONE:
          data.callback = nullptr;
          break;
      }
    }
    return *this;
  }

◆ operator=() [2/2]

template<typename Args >

Operation & LibXR::Operation< Args >::operator= ( Operation< Args > && op )

inlinenoexcept

Move assignment operator.

移动赋值运算符。

Parameters

op	Another Operation instance.

Returns: Reference to this operation.

Definition at line 132 of file operation.hpp.

  {
    if (this != &op)
    {
      type = op.type;
      switch (type)
      {
        case OperationType::CALLBACK:
          data.callback = op.data.callback;
          break;
        case OperationType::BLOCK:
          data.sem_info.sem = op.data.sem_info.sem;
          data.sem_info.timeout = op.data.sem_info.timeout;
          break;
        case OperationType::POLLING:
          data.status = op.data.status;
          break;
        case OperationType::NONE:
          data.callback = nullptr;
          break;
      }
    }
    return *this;
  }

◆ UpdateStatus()

template<typename Args >

template<typename Status >

void LibXR::Operation< Args >::UpdateStatus	(	bool	in_isr,
		Status &&	status )

inline

Updates operation status based on type.

根据类型更新操作状态。

Parameters

in_isr	Indicates if executed within an interrupt.
args	Parameters passed to the callback.

Definition at line 164 of file operation.hpp.

  {
    switch (type)
    {
      case OperationType::CALLBACK:
        data.callback->Run(in_isr, std::forward<Status>(status));
        break;
      case OperationType::BLOCK:
        // BLOCK waits are signaled by semaphore only; the owning port keeps the
        // final ErrorCode in its block_result_ handoff state.
        // BLOCK 只通过信号量唤醒；最终 ErrorCode 由端口侧 block_result_ 交接。
        data.sem_info.sem->PostFromCallback(in_isr);
        break;
      case OperationType::POLLING:
        *data.status = (status == ErrorCode::OK) ? OperationPollingStatus::DONE
                                                 : OperationPollingStatus::ERROR;
        break;
      case OperationType::NONE:
        break;
    }
  }

Field Documentation

◆ callback

template<typename Args >

Callback* LibXR::Operation< Args >::callback

Definition at line 211 of file operation.hpp.

◆ [union]

union { ... } LibXR::Operation< Args >::data

Data storage for different operation types. 存储不同操作类型的数据。

◆ sem

template<typename Args >

Semaphore* LibXR::Operation< Args >::sem

Definition at line 214 of file operation.hpp.

◆ status

template<typename Args >

OperationPollingStatus* LibXR::Operation< Args >::status

Definition at line 217 of file operation.hpp.

◆ timeout

template<typename Args >

uint32_t LibXR::Operation< Args >::timeout

Definition at line 215 of file operation.hpp.

◆ type

template<typename Args >

OperationType LibXR::Operation< Args >::type

Operation type. 操作类型。

Definition at line 222 of file operation.hpp.

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

src/core/rw/operation.hpp

Public Types

Public Member Functions

Data Fields

Detailed Description

Member Typedef Documentation

◆ Callback

Member Enumeration Documentation

◆ OperationPollingStatus

◆ OperationType

Constructor & Destructor Documentation

◆ Operation() [1/6]

◆ Operation() [2/6]

◆ Operation() [3/6]

◆ Operation() [4/6]

◆ Operation() [5/6]

◆ Operation() [6/6]

Member Function Documentation

◆ MarkAsRunning()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ UpdateStatus()

Field Documentation

◆ callback

◆ [union]

◆ sem

◆ status

◆ timeout

◆ type