XWCQ C++ 对象更多...

#include <Xwcq.hxx>

xwisc::Xwcq< TSlotNum, T > 的协作图:

[图例]

Public 成员函数
	Xwcq ()

	~Xwcq ()

struct xwcq *	get ()
	获取循环队列内部对象指针

xwsz_t	capacity ()
	XWCQ API: 获取循环队列的容量 `TSlotNum`

xwsz_t	size ()
	XWCQ API: 获取循环队列的单个数据槽的大小 `sizeof(T)`

xwsz_t	availability ()
	XWCQ API: 获取循环队列中有效数据槽的数量

void	flush ()
	清空循环队列

xwer_t	eq (T data, xwsz_t size)
	将数据发送到循环队列的尾端 (入队，EnQueue)

xwer_t	jq (T data, xwsz_t size)
	将数据发送循环队列的首端 (插队，Jump the Queue)

xwer_t	dq (T data, xwsz_t size)
	等待从循环队列的首端接收数据 (离队，DeQueue)

xwer_t	dq (T data, xwsz_t size, xwtm_t to)
	限时等待从循环队列的首端接收数据 (离队，DeQueue)

xwer_t	dqUnintr (T data, xwsz_t size)
	等待从循环队列的首端接收数据 (离队，DeQueue)，并且等待不可被中断

xwer_t	tryDq (T data, xwsz_t size)
	尝试从循环队列的首端接收数据 (离队，DeQueue)

xwer_t	rq (T data, xwsz_t size)
	等待从循环队列的尾端接收数据 (反向离队，Reversely deQueue)

xwer_t	rq (T data, xwsz_t size, xwtm_t to)
	限时等待从循环队列的尾端接收数据 (反向离队，Reversely deQueue)

xwer_t	rqUnintr (T data, xwsz_t size)
	等待从循环队列的尾端接收数据 (反向离队，Reversely deQueue)，并且等待不可被中断

xwer_t	tryRq (T data, xwsz_t size)
	尝试从循环队列的尾端接收数据 (反向离队，Reversely deQueue)

xwer_t	pfq (T data, xwsz_t size)
	等待从循环队列头端拷贝数据 (Peek at the Front of Queue)

xwer_t	pfq (T data, xwsz_t size, xwtm_t to)
	限时等待从循环队列头端拷贝数据 (Peek at the Front of Queue)

xwer_t	pfqUnintr (T data, xwsz_t size)
	等待从循环队列头端拷贝数据 (Peek at the Front of Queue)，并且等待不可被中断

xwer_t	tryPfq (T data, xwsz_t size)
	尝试从循环队列头端拷贝数据 (Peek at the Front of Queue)

xwer_t	prq (T data, xwsz_t size)
	等待从循环队列尾端拷贝数据 (Peek at the Rear of Queue)

xwer_t	prq (T data, xwsz_t size, xwtm_t to)
	限时等待从循环队列尾端拷贝数据 (Peek at the Rear of Queue)

xwer_t	prqUnintr (T data, xwsz_t size)
	等待从循环队列尾端拷贝数据 (Peek at the Rear of Queue)，并且等待不可被中断

xwer_t	tryPrq (T data, xwsz_t size)
	尝试从循环队列尾端拷贝数据 (Peek at the Rear of Queue)

Private 属性
struct xwcq	mCq

xwu8_t	mPool [sizeof(T) *TSlotNum]

详细描述

template<xwsz_t TSlotNum, typename T>
class xwisc::Xwcq< TSlotNum, T >

XWCQ C++ 对象

在文件 Xwcq.hxx 第 33 行定义.

构造及析构函数说明

◆ Xwcq()

template<xwsz_t TSlotNum, typename T >

xwisc::Xwcq< TSlotNum, T >::Xwcq ( )

inline

在文件 Xwcq.hxx 第 40 行定义.

40{ xwcq_init(&mCq, sizeof(T), TSlotNum, mPool); }

xwisc::Xwcq::mCq

struct xwcq mCq

Definition Xwcq.hxx:36

xwisc::Xwcq::mPool

xwu8_t mPool[sizeof(T) *TSlotNum]

Definition Xwcq.hxx:37

xwcq_init

xwer_t xwcq_init(struct xwcq *cq, xwsz_t slotsize, xwsz_t slotnum, xwu8_t *mem)

XWCQ API：初始化循环队列

Definition xwcq.c:94

函数调用图:

◆ ~Xwcq()

template<xwsz_t TSlotNum, typename T >

xwisc::Xwcq< TSlotNum, T >::~Xwcq ( )

inline

在文件 Xwcq.hxx 第 41 行定义.

41{}

成员函数说明

◆ availability()

template<xwsz_t TSlotNum, typename T >

xwsz_t xwisc::Xwcq< TSlotNum, T >::availability ( )

inline

XWCQ API: 获取循环队列中有效数据槽的数量

返回: 有效数据槽的数量

注解

上下文：任意

在文件 Xwcq.hxx 第 79 行定义.

                          {
        xwsz_t availability;
        xwcq_get_availability(&mCq, &availability);
        return availability;
    }

函数调用图:

这是这个函数的调用关系图:

◆ capacity()

template<xwsz_t TSlotNum, typename T >

xwsz_t xwisc::Xwcq< TSlotNum, T >::capacity ( )

inline

XWCQ API: 获取循环队列的容量 TSlotNum

返回: 容量

注解

上下文：任意

在文件 Xwcq.hxx 第 55 行定义.

                      {
        xwsz_t cap;
        xwcq_get_capacity(&mCq, &cap);
        return cap;
    }

函数调用图:

◆ dq() [1/2]

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::dq	(	T *	data,
		xwsz_t *	size
	)

inline

等待从循环队列的首端接收数据 (离队，DeQueue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EINTR	等待被中断
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出，或等待被中断。
如果等待被中断，此C++API将返回 -EINTR 。

在文件 Xwcq.hxx 第 159 行定义.

                                       {
        return xwcq_dq(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ dq() [2/2]

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::dq	(	T *	data,
		xwsz_t *	size,
		xwtm_t	to
	)

inline

限时等待从循环队列的首端接收数据 (离队，DeQueue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小
[in]	to	期望唤醒的时间点

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EINTR	等待被中断
-ETIMEDOUT	超时
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出，或等待被中断，或等待超时。
如果等待被中断，此C++API将返回 -EINTR 。
to 表示等待超时的时间点：
- to 通常是未来的时间，即 当前系统时间 + delta ，可以使用 xwtm_ft(delta) 表示；
- 如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

在文件 Xwcq.hxx 第 190 行定义.

                                                  {
        return xwcq_dq_to(&mCq, (xwu8_t *)data, size, to);
    }

函数调用图:

◆ dqUnintr()

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::dqUnintr	(	T *	data,
		xwsz_t *	size
	)

inline

等待从循环队列的首端接收数据 (离队，DeQueue)，并且等待不可被中断

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出。
调用此C++API的线程的阻塞等待不可被中断。

在文件 Xwcq.hxx 第 214 行定义.

                                             {
        return xwcq_dq_unintr(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ eq()

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::eq	(	T *	data,
		xwsz_t *	size
	)

inline

将数据发送到循环队列的尾端 (入队，EnQueue)

参数

[in]	data	数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示待入队的数据大小 (O) 作为输出时，返回实际入队的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针

注解

上下文：任意

如果传入的数据大小 *size 超过初始化循环队列时指定的 sizeof(T) ，数据将被截断。
如果循环队列数据已被填满，循环队列会循环回队列首端的位置，覆盖掉原数据。
此C++API不会阻塞调用者，因此可以在中断中使用。

在文件 Xwcq.hxx 第 112 行定义.

                                       {
        return xwcq_eq(&mCq, (const xwu8_t *)data, size);
    }

函数调用图:

◆ flush()

template<xwsz_t TSlotNum, typename T >

void xwisc::Xwcq< TSlotNum, T >::flush ( )

inline

清空循环队列

注解

上下文：任意

在文件 Xwcq.hxx 第 91 行定义.

91{ xwcq_flush(&mCq); }

xwcq_flush

xwer_t xwcq_flush(struct xwcq *cq)

XWCQ API: 清空循环队列

Definition xwcq.c:633

函数调用图:

◆ get()

template<xwsz_t TSlotNum, typename T >

struct xwcq * xwisc::Xwcq< TSlotNum, T >::get ( )

inline

获取循环队列内部对象指针

在文件 Xwcq.hxx 第 46 行定义.

46{ return &mCq; }

◆ jq()

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::jq	(	T *	data,
		xwsz_t *	size
	)

inline

将数据发送循环队列的首端 (插队，Jump the Queue)

参数

[in]	data	数据
[in]	size	数据的大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针

注解

上下文：任意

如果传入的数据大小 *size 超过初始化循环队列时指定的 sizeof(T) ，数据将被截断。
如果循环队列数据已被填满，循环队列会循环回队列尾端的位置，覆盖掉原数据。
此C++API不会阻塞调用者，因此可以在中断中使用。

在文件 Xwcq.hxx 第 132 行定义.

                                       {
        return xwcq_jq(&mCq, (const xwu8_t *)data, size);
    }

函数调用图:

◆ pfq() [1/2]

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::pfq	(	T *	data,
		xwsz_t *	size
	)

inline

等待从循环队列头端拷贝数据 (Peek at the Front of Queue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EINTR	等待被中断
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

拷贝数据不会取走数据，也不会释放数据槽，数据可被重复拷贝，也可继续被接收。
若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出，或等待被中断。
如果等待被中断，此C++API将返回 -EINTR 。

在文件 Xwcq.hxx 第 360 行定义.

                                        {
        return xwcq_pfq(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ pfq() [2/2]

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::pfq	(	T *	data,
		xwsz_t *	size,
		xwtm_t	to
	)

inline

限时等待从循环队列头端拷贝数据 (Peek at the Front of Queue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小
[in]	to	期望唤醒的时间点

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EINTR	等待被中断
-ETIMEDOUT	超时
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

拷贝数据不会取走数据，也不会释放数据槽，数据可被重复拷贝，也可继续被接收。
若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出，或等待被中断，或等待超时。
如果等待被中断，此CAPI将返回 -EINTR 。
to 表示等待超时的时间点：
- to 通常是未来的时间，即 当前系统时间 + delta ，可以使用 xwtm_ft(delta) 表示；
- 如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

在文件 Xwcq.hxx 第 392 行定义.

                                                   {
        return xwcq_pfq_to(&mCq, (xwu8_t *)data, size, to);
    }

函数调用图:

◆ pfqUnintr()

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::pfqUnintr	(	T *	data,
		xwsz_t *	size
	)

inline

等待从循环队列头端拷贝数据 (Peek at the Front of Queue)，并且等待不可被中断

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

拷贝数据不会取走数据，也不会释放数据槽，数据可被重复拷贝，也可继续被接收。
若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出。
调用此C++API的线程的阻塞等待不可被中断。

在文件 Xwcq.hxx 第 418 行定义.

                                              {
        return xwcq_pfq_unintr(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ prq() [1/2]

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::prq	(	T *	data,
		xwsz_t *	size
	)

inline

等待从循环队列尾端拷贝数据 (Peek at the Rear of Queue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EINTR	等待被中断
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

拷贝数据不会取走数据，也不会释放数据槽，数据可被重复拷贝，也可继续被接收。
若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出，或等待被中断。
如果等待被中断，此C++API将返回 -EINTR 。

在文件 Xwcq.hxx 第 464 行定义.

                                        {
        return xwcq_prq(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ prq() [2/2]

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::prq	(	T *	data,
		xwsz_t *	size,
		xwtm_t	to
	)

inline

限时等待从循环队列尾端拷贝数据 (Peek at the Rear of Queue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小
[in]	to	期望唤醒的时间点

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EINTR	等待被中断
-ETIMEDOUT	超时
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

拷贝数据不会取走数据，也不会释放数据槽，数据可被重复拷贝，也可继续被接收。
若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出，或等待被中断，或等待超时。
如果等待被中断，此C++API将返回 -EINTR 。
to 表示等待超时的时间点：
- to 通常是未来的时间，即 当前系统时间 + delta ，可以使用 xwtm_ft(delta) 表示；
- 如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

在文件 Xwcq.hxx 第 496 行定义.

                                                   {
        return xwcq_prq_to(&mCq, (xwu8_t *)data, size, to);
    }

函数调用图:

◆ prqUnintr()

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::prqUnintr	(	T *	data,
		xwsz_t *	size
	)

inline

等待从循环队列尾端拷贝数据 (Peek at the Rear of Queue)，并且等待不可被中断

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

拷贝数据不会取走数据，也不会释放数据槽，数据可被重复拷贝，也可继续被接收。
若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出。
调用此C++API的线程的阻塞等待不可被中断。

在文件 Xwcq.hxx 第 522 行定义.

                                              {
        return xwcq_prq_unintr(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ rq() [1/2]

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::rq	(	T *	data,
		xwsz_t *	size
	)

inline

等待从循环队列的尾端接收数据 (反向离队，Reversely deQueue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EINTR	等待被中断
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出，或等待被中断。
如果等待被中断，此C++API将返回 -EINTR 。

在文件 Xwcq.hxx 第 259 行定义.

                                       {
        return xwcq_rq(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ rq() [2/2]

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::rq	(	T *	data,
		xwsz_t *	size,
		xwtm_t	to
	)

inline

限时等待从循环队列的尾端接收数据 (反向离队，Reversely deQueue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小
[in]	to	期望唤醒的时间点

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-EINTR	等待被中断
-ETIMEDOUT	超时
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出，或等待被中断，或等待超时。
如果等待被中断，此C++API将返回 -EINTR 。
to 表示等待超时的时间点：
- to 通常是未来的时间，即 当前系统时间 + delta ，可以使用 xwtm_ft(delta) 表示；
- 如果 to 是过去的时间点，将直接返回 -ETIMEDOUT 。

在文件 Xwcq.hxx 第 290 行定义.

                                                  {
        return xwcq_rq_to(&mCq, (xwu8_t *)data, size, to);
    }

函数调用图:

◆ rqUnintr()

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::rqUnintr	(	T *	data,
		xwsz_t *	size
	)

inline

等待从循环队列的尾端接收数据 (反向离队，Reversely deQueue)，并且等待不可被中断

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENOTTHDCTX	不在线程上下文中
-EDISIRQ	中断被关闭
-EDISPMPT	抢占被关闭
-EDISBH	中断底半部被关闭

注解

上下文：线程

若循环队列中数据为空，调用此C++API的线程会阻塞等待，直到循环队列中有消息可取出。
调用此C++API的线程的阻塞等待不可被中断。

在文件 Xwcq.hxx 第 315 行定义.

                                             {
        return xwcq_rq_unintr(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ size()

template<xwsz_t TSlotNum, typename T >

xwsz_t xwisc::Xwcq< TSlotNum, T >::size ( )

inline

XWCQ API: 获取循环队列的单个数据槽的大小 sizeof(T)

返回: 单个数据槽的大小

注解

上下文：任意

在文件 Xwcq.hxx 第 67 行定义.

                  {
        xwsz_t size;
        xwcq_get_size(&mCq, &size);
        return size;
    }

函数调用图:

这是这个函数的调用关系图:

◆ tryDq()

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::tryDq	(	T *	data,
		xwsz_t *	size
	)

inline

尝试从循环队列的首端接收数据 (离队，DeQueue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENODATA	循环队列为空

注解

上下文：任意

若循环队列中为空，就立即返回 -ENODATA 。
此C++API可在中断中使用。

在文件 Xwcq.hxx 第 234 行定义.

                                          {
        return xwcq_trydq(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ tryPfq()

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::tryPfq	(	T *	data,
		xwsz_t *	size
	)

inline

尝试从循环队列头端拷贝数据 (Peek at the Front of Queue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENODATA	循环队列为空

注解

上下文：任意

拷贝数据不会取走数据，也不会释放数据槽，数据可被重复拷贝，也可继续被接收。
若循环队列中为空，就立即返回 -ENODATA ，此CAPI可在中断中使用。

在文件 Xwcq.hxx 第 438 行定义.

                                           {
        return xwcq_trypfq(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ tryPrq()

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::tryPrq	(	T *	data,
		xwsz_t *	size
	)

inline

尝试从循环队列尾端拷贝数据 (Peek at the Rear of Queue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENODATA	循环队列为空

注解

上下文：任意

拷贝数据不会取走数据，也不会释放数据槽，数据可被重复拷贝，也可继续被接收。
若循环队列中为空，就立即返回 -ENODATA ，此CAPI可在中断中使用。

在文件 Xwcq.hxx 第 542 行定义.

                                           {
        return xwcq_tryprq(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

◆ tryRq()

template<xwsz_t TSlotNum, typename T >

xwer_t xwisc::Xwcq< TSlotNum, T >::tryRq	(	T *	data,
		xwsz_t *	size
	)

inline

尝试从循环队列的尾端接收数据 (反向离队，Reversely deQueue)

参数

[out]	data	指向缓冲区的指针，此缓冲区用于接收数据
[in,out]	size	指向缓冲区的指针，此缓冲区： (I) 作为输入时，表示接收缓冲区的大小 (O) 作为输出时，返回实际接收的数据大小

返回: 错误码

返回值

XWOK	没有错误
-EFAULT	空指针
-ENODATA	循环队列为空

注解

上下文：任意

若循环队列中为空，就立即返回 -ENODATA ，此C++API可在中断中使用。

在文件 Xwcq.hxx 第 334 行定义.

                                          {
        return xwcq_tryrq(&mCq, (xwu8_t *)data, size);
    }

函数调用图:

结构体成员变量说明

◆ mCq

template<xwsz_t TSlotNum, typename T >

struct xwcq xwisc::Xwcq< TSlotNum, T >::mCq

private

在文件 Xwcq.hxx 第 36 行定义.

◆ mPool

template<xwsz_t TSlotNum, typename T >

xwu8_t xwisc::Xwcq< TSlotNum, T >::mPool[sizeof(T) *TSlotNum]

private

在文件 Xwcq.hxx 第 37 行定义.

该类的文档由以下文件生成:

xwmd/isc/xwcq/cxx/Xwcq.hxx

Public 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ Xwcq()

◆ ~Xwcq()

成员函数说明

◆ availability()

◆ capacity()

◆ dq() [1/2]

◆ dq() [2/2]

◆ dqUnintr()

◆ eq()

◆ flush()

◆ get()

◆ jq()

◆ pfq() [1/2]

◆ pfq() [2/2]

◆ pfqUnintr()

◆ prq() [1/2]

◆ prq() [2/2]

◆ prqUnintr()

◆ rq() [1/2]

◆ rq() [2/2]

◆ rqUnintr()

◆ size()

◆ tryDq()

◆ tryPfq()

◆ tryPrq()

◆ tryRq()

结构体成员变量说明

◆ mCq

◆ mPool