C/C++ API Reference
Loading...
Searching...
No Matches
pw::async2::ChannelStorage< T, kCapacity > Class Template Reference

Overview

template<typename T, uint16_t kCapacity>
class pw::async2::ChannelStorage< T, kCapacity >

Fixed capacity storage for an asynchronous channel which supports multiple producers and multiple consumers.

ChannelStorage is used to create a channel vi

ChannelStorage must outlive the channel in which it is used.

Inheritance diagram for pw::async2::ChannelStorage< T, kCapacity >:
pw::containers::internal::ArrayStorage< T, kCapacity > pw::async2::internal::Channel< T >

Public Member Functions

bool active () const
 
- Public Member Functions inherited from pw::async2::internal::Channel< T >
bool closed () const
 

Additional Inherited Members

- Static Public Member Functions inherited from pw::async2::internal::Channel< T >
static ChannelAllocated (Allocator &alloc, uint16_t capacity)
 
- Protected Member Functions inherited from pw::async2::internal::Channel< T >
 Channel (FixedDeque< T > &&deque)
 
template<size_t kAlignment, size_t kCapacity>
 Channel (containers::Storage< kAlignment, kCapacity > &storage)
 
uint16_t ref_count () const
 

Member Function Documentation

◆ active()

template<typename T , uint16_t kCapacity>
bool pw::async2::ChannelStorage< T, kCapacity >::active ( ) const
inline

Returns true if this channel storage is in use. If false, the storage can either be reused or safely destroyed.


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