Channel

Thread-safe typed data channel implementation.

The implementation supports multiple-reader-multiple-writer operation across multiple tasks in multiple threads.

struct Channel (

T

size_t buffer_size = 100

) {

enum bufferSize;

bool empty [@property getter];

bool empty [@property getter];

size_t bufferFill [@property getter];

size_t bufferFill [@property getter];

void close();

void close();

T consumeOne();

T consumeOne();

bool tryConsumeOne(T dst);

bool tryConsumeOne(T dst);

bool consumeAll(FixedRingBuffer!(T, buffer_size) dst);

bool consumeAll(FixedRingBuffer!(T, buffer_size) dst);

void put(T item);

void put(T item);

}

Members

Functions

close void close(): Closes the channel.
consumeAll bool consumeAll(FixedRingBuffer!(T, buffer_size) dst): Attempts to consume all elements currently in the queue.
consumeAll bool consumeAll(FixedRingBuffer!(T, buffer_size) dst): Attempts to consume all elements currently in the queue.
consumeOne T consumeOne(): Consumes a single element off the queue.
put void put(T item): Enqueues an element.
tryConsumeOne bool tryConsumeOne(T dst): Attempts to consume a single element.

Manifest constants

bufferSize enum bufferSize;: Undocumented in source.

Properties

bufferFill size_t bufferFill [@property getter]: Returns the current count of items in the buffer.
empty bool empty [@property getter]: Determines whether there is more data to read in a single-reader scenario.

Meta

Source

See Implementation

vibe core channel enums

ChannelPriority

functions

createChannel

structs