util::Channel< T, P, C > Class Template Reference

Represents a go-like channel, a multi-producer (Sender) multi-consumer (Receiver) thread-safe data pipe. More...

#include <Channel.hpp>

Classes
class	Sender
	The sending end of a channel. More...
class	Receiver
	The receiving end of a channel. More...

Static Public Member Functions
static std::pair< Sender, Receiver >	create (auto &&context, std::size_t capacity)
	Factory function to create channel components.

Detailed Description

template<typename T, ProducerType P = ProducerType::Multi, ConsumerType C = ConsumerType::Multi>
class util::Channel< T, P, C >

Represents a go-like channel, a multi-producer (Sender) multi-consumer (Receiver) thread-safe data pipe.

Note

Use INSTANTIATE_CHANNEL_FOR_CLANG macro when using this class. See docs at the bottom of the file for more details.

Template Parameters

T	The type of data the channel transfers
P	ProducerType::Multi (default) for multi-producer or ProducerType::Single for single-producer
C	ConsumerType::Multi (default) for multi-consumer or ConsumerType::Single for single-consumer

Member Function Documentation

create()

template<typename T, ProducerType P = ProducerType::Multi, ConsumerType C = ConsumerType::Multi>

std::pair< Sender, Receiver > util::Channel< T, P, C >::create ( auto && context, std::size_t capacity )

inlinestatic

Factory function to create channel components.

Parameters

context	A supported context type (either io_context or thread_pool)
capacity	Size of the internal buffer on the channel

Returns

A pair of Sender and Receiver

---

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

• /__w/clio/clio/src/util/Channel.hpp