console::Channel< T, N > Class Template Reference

环形缓冲区通道，用于线程间通信。 More...

#include <channel.h>

Public Types
using	iterator = ChannelIterator<T, N>
	迭代器类型。

Public Member Functions
	Channel ()=default
	默认构造函数。
bool	operator<< (const T &value)
	向通道写入数据。
bool	operator<< (T &&value)
	向通道写入数据。
bool	operator<<= (const T &value)
	尝试向通道写入数据。
bool	operator<<= (T &&value)
	尝试向通道写入数据。
bool	operator>> (T &value)
	从通道读取数据。
bool	operator>>= (T &value)
	从通道尝试读取数据（非阻塞）。
T	operator* ()
	从通道读取数据。
std::unique_ptr< T >	operator-> ()
	从通道读取数据。
	operator bool () const
	显式转换为布尔值。
iterator	begin ()
	迭代器的 begin 函数。
iterator	end ()
	迭代器的 end 函数。
	Channel (const Channel &)=delete
	删除复制构造函数。
Channel &	operator= (const Channel &)=delete
	删除复制赋值函数。
	Channel (Channel &&)=delete
	删除移动构造函数。
Channel &	operator= (Channel &&)=delete
	删除移动赋值函数。

Private Attributes
T	buffer_ [N]
	缓冲区
size_t	read_index_ {0}
	读索引
size_t	write_index_ {0}
	写索引
std::mutex	mutex_
	互斥锁
std::condition_variable	r_cv_
	读 条件变量
std::condition_variable	w_cv_
	写 条件变量
bool	closed_ {false}
	关闭标志

Friends
void	close (Channel &channel)
	关闭通道。

Detailed Description

template<class T, size_t N = 0>
class console::Channel< T, N >

环形缓冲区通道，用于线程间通信。

无缓冲通道，用于线程间通信。

Template Parameters

T	数据类型。
N	缓冲区大小。
T	数据类型。

Member Typedef Documentation

iterator

template<class T, size_t N = 0>

using console::Channel< T, N >::iterator = ChannelIterator<T, N>

迭代器类型。

Constructor & Destructor Documentation

Channel() [1/3]

template<class T, size_t N = 0>

console::Channel< T, N >::Channel ( )

default

默认构造函数。

Channel() [2/3]

template<class T, size_t N = 0>

console::Channel< T, N >::Channel ( const Channel< T, N > & )

delete

删除复制构造函数。

Channel() [3/3]

template<class T, size_t N = 0>

console::Channel< T, N >::Channel ( Channel< T, N > && )

delete

删除移动构造函数。

Member Function Documentation

begin()

template<class T, size_t N = 0>

iterator console::Channel< T, N >::begin ( )

inline

迭代器的 begin 函数。

end()

template<class T, size_t N = 0>

iterator console::Channel< T, N >::end ( )

inline

迭代器的 end 函数。

operator bool()

template<class T, size_t N = 0>

console::Channel< T, N >::operator bool ( ) const

inlineexplicit

显式转换为布尔值。

Returns

若通道已关闭且没有剩余数据，返回 false；否则返回 true。

Note

注意，验明通道为 true 后仍然可能出现问题，因为验明和读值不是原子的。 得到 true 只能表明验明前管道有效，不代表读取时有效。

operator*()

template<class T, size_t N = 0>

T console::Channel< T, N >::operator* ( )

inline

从通道读取数据。

若通道为空，则阻塞等待直到有数据可读。

Returns

读取的值。

Exceptions

AsyncError

若通道已关闭。

Note

若通道已关闭且没有剩余数据，则抛出 AsyncError。

operator->()

template<class T, size_t N = 0>

std::unique_ptr< T > console::Channel< T, N >::operator-> ( )

inline

从通道读取数据。

若通道为空，则阻塞等待直到有数据可读。

Returns

读取的值。

Exceptions

AsyncError

若通道已关闭。

Note

若通道已关闭且没有剩余数据，则抛出 AsyncError。

operator<<() [1/2]

template<class T, size_t N = 0>

bool console::Channel< T, N >::operator<< ( const T & value )

inline

向通道写入数据。

若通道已满，则阻塞等待直到有空间可写。

Parameters

value

要写入的值。

Returns

若写入成功。

Note

若通道已关闭，则 No-OP。

operator<<() [2/2]

template<class T, size_t N = 0>

bool console::Channel< T, N >::operator<< ( T && value )

inline

向通道写入数据。

若通道已满，则阻塞等待直到有空间可写。

Parameters

value

要写入的值。

Returns

若写入成功。

Note

若通道已关闭，则 No-OP。

operator<<=() [1/2]

template<class T, size_t N = 0>

bool console::Channel< T, N >::operator<<= ( const T & value )

inline

尝试向通道写入数据。

非阻塞；若通道已满或已关闭，则立即返回失败。

Parameters

value

要写入的值。

Returns

若写入成功。

operator<<=() [2/2]

template<class T, size_t N = 0>

bool console::Channel< T, N >::operator<<= ( T && value )

inline

尝试向通道写入数据。

非阻塞；若通道已满或已关闭，则立即返回失败。

Parameters

value

要写入的值。

Returns

若写入成功。

operator=() [1/2]

template<class T, size_t N = 0>

Channel & console::Channel< T, N >::operator= ( Channel< T, N > && )

delete

删除移动赋值函数。

operator=() [2/2]

template<class T, size_t N = 0>

Channel & console::Channel< T, N >::operator= ( const Channel< T, N > & )

delete

删除复制赋值函数。

operator>>()

template<class T, size_t N = 0>

bool console::Channel< T, N >::operator>> ( T & value )

inline

从通道读取数据。

若通道为空，则阻塞等待直到有数据可读。

Parameters

value

读取的值。

Returns

若读取成功。

Note

若通道已关闭且没有剩余数据，则 No-OP。

operator>>=()

template<class T, size_t N = 0>

bool console::Channel< T, N >::operator>>= ( T & value )

inline

从通道尝试读取数据（非阻塞）。

若通道为空，则立即返回 false；否则读取数据并返回 true。

Parameters

value

读取的值。

Returns

若读取成功。

Note

若通道已关闭且没有剩余数据，返回 false。

Friends And Related Symbol Documentation

close

template<class T, size_t N = 0>

void close ( Channel< T, N > & channel )

friend

关闭通道。

Note

设置关闭标志，唤醒所有线程。

Member Data Documentation

buffer_

template<class T, size_t N = 0>

T console::Channel< T, N >::buffer_[N]

private

缓冲区

closed_

template<class T, size_t N = 0>

bool console::Channel< T, N >::closed_ {false}

private

关闭标志

mutex_

template<class T, size_t N = 0>

std::mutex console::Channel< T, N >::mutex_

mutableprivate

互斥锁

r_cv_

template<class T, size_t N = 0>

std::condition_variable console::Channel< T, N >::r_cv_

private

读 条件变量

read_index_

template<class T, size_t N = 0>

size_t console::Channel< T, N >::read_index_ {0}

private

读索引

w_cv_

template<class T, size_t N = 0>

std::condition_variable console::Channel< T, N >::w_cv_

private

写 条件变量

write_index_

template<class T, size_t N = 0>

size_t console::Channel< T, N >::write_index_ {0}

private

写索引

---

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

• include/async/channel.h