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

#include <libxr_rw.hpp>

Collaboration diagram for LibXR::Operation< Args >:

[legend]

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

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

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< Args... > &callback)
	Constructs a callback-based operation.

	Operation (OperationPollingStatus &status)
	Constructs a polling operation.

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

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

	Operation (const Operation &op)

	Operation (Operation &&op) noexcept
	构造一个新的 Operation 对象（移动构造函数）。 Constructs a new Operation object (move constructor).

void	UpdateStatus (bool in_isr, Args &&...args)
	Updates operation status based on type.

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

Data Fields
union {

Callback< Args... > * 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 28 of file libxr_rw.hpp.

Member Enumeration Documentation

◆ OperationPollingStatus

template<typename... Args>

enum class LibXR::Operation::OperationPollingStatus : uint8_t

strong

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

Definition at line 43 of file libxr_rw.hpp.

  {
    READY,
    RUNNING,
    DONE
  };

◆ OperationType

template<typename... Args>

enum class LibXR::Operation::OperationType : uint8_t

strong

Operation types. 操作类型。

Definition at line 33 of file libxr_rw.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 52 of file libxr_rw.hpp.

52: type(OperationType::NONE) {}

LibXR::Operation::type

OperationType type

Definition libxr_rw.hpp:259

◆ 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).

Definition at line 60 of file libxr_rw.hpp.

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

◆ Operation() [3/6]

template<typename... Args>

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

inline

Constructs a callback-based operation.

构造基于回调的操作。

Parameters

callback Callback function reference.

Definition at line 71 of file libxr_rw.hpp.

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

◆ 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 libxr_rw.hpp.

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

◆ Operation() [5/6]

template<typename... Args>

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

inline

Definition at line 146 of file libxr_rw.hpp.

                                 : type(op.type)
  {
    switch (type)
    {
      case OperationType::CALLBACK:
        data.callback = op.data.callback;
        break;
      case OperationType::BLOCK:
        data.sem = op.data.sem;
        data.timeout = op.data.timeout;
        break;
      case OperationType::POLLING:
        data.status = op.data.status;
        break;
      case OperationType::NONE:
        break;
    }
  }

◆ Operation() [6/6]

template<typename... Args>

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

inlinenoexcept

构造一个新的 Operation 对象（移动构造函数）。 Constructs a new Operation object (move constructor).

该构造函数用于移动另一个 Operation 对象，并接管其内部数据。 This constructor moves another Operation object and takes ownership of its internal data.

Parameters

op	要移动的 Operation 对象。 The Operation object to be moved.

Note: 该操作不会动态分配内存，仅仅是移动已有数据成员。 This operation does not allocate memory dynamically; it merely moves existing data members.

Definition at line 180 of file libxr_rw.hpp.

                                     : 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:
        break;
    }
  }

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 236 of file libxr_rw.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 92 of file libxr_rw.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:
          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 122 of file libxr_rw.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:
          break;
      }
    }
    return *this;
  }

◆ UpdateStatus()

template<typename... Args>

void LibXR::Operation< Args >::UpdateStatus	(	bool	in_isr,
		Args &&...	args
	)

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 205 of file libxr_rw.hpp.

  {
    switch (type)
    {
      case OperationType::CALLBACK:
        data.callback->Run(in_isr, std::forward<Args>(args)...);
        break;
      case OperationType::BLOCK:
        data.sem_info.sem->PostFromCallback(in_isr);
        break;
      case OperationType::POLLING:
        *data.status = OperationPollingStatus::DONE;
        break;
      case OperationType::NONE:
        break;
    }
  }

Field Documentation

◆ callback

template<typename... Args>

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

Definition at line 248 of file libxr_rw.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 251 of file libxr_rw.hpp.

◆ status

template<typename... Args>

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

Definition at line 254 of file libxr_rw.hpp.

◆ timeout

template<typename... Args>

uint32_t LibXR::Operation< Args >::timeout

Definition at line 252 of file libxr_rw.hpp.

◆ type

template<typename... Args>

OperationType LibXR::Operation< Args >::type

Operation type. 操作类型。

Definition at line 259 of file libxr_rw.hpp.

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

src/core/libxr_rw.hpp

Public Types

Public Member Functions

Data Fields

Detailed Description

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