Pipes reads on SC::AsyncReadableStream to SC::AsyncWritableStream. More...

#include <AsyncStreams.h>

Public Member Functions
	AsyncPipeline (const AsyncPipeline &)=delete

	AsyncPipeline (AsyncPipeline &&)=delete

AsyncPipeline &	operator= (const AsyncPipeline &)=delete

AsyncPipeline &	operator= (AsyncPipeline &&)=delete

Result	pipe (AsyncReadableStream &asyncSource, Span< AsyncWritableStream * > asyncSinks)
	Reports errors by source, transforms or sinks.

Result	pipe (AsyncReadableStream &asyncSource, Span< AsyncDuplexStream * > asyncTransforms, Span< AsyncWritableStream * > asyncSinks)
	Inits the pipeline with a source, transforms and some writable sinks.

bool	unpipe ()
	Unregisters all events from source, transforms ans sinks.

Result	start ()
	Starts the pipeline.

Public Attributes
Event< MaxListeners, Result >	eventError

Static Public Attributes
static constexpr int	MaxListeners = 8

Detailed Description

Pipes reads on SC::AsyncReadableStream to SC::AsyncWritableStream.

Back-pressure happens when the source provides data at a faster rate than what the sink (writable) is able to process. When this happens, AsyncPipeline will AsyncReadableStream::pause the (source). It will also AsyncReadableStream::resume it when some writable has finished writing, freeing one buffer. Caller needs to set AsyncPipeline::source field and AsyncPipeline::sinks with valid streams.

Note: It's crucial to use the same AsyncBuffersPool for the AsyncReadableStream and all AsyncWritableStream

Member Function Documentation

◆ pipe() [1/2]

Result SC::AsyncPipeline::pipe	(	AsyncReadableStream &	asyncSource,
		Span< AsyncDuplexStream * >	asyncTransforms,
		Span< AsyncWritableStream * >	asyncSinks )

Inits the pipeline with a source, transforms and some writable sinks.

◆ pipe() [2/2]

Result SC::AsyncPipeline::pipe	(	AsyncReadableStream &	asyncSource,
		Span< AsyncWritableStream * >	asyncSinks )

Reports errors by source, transforms or sinks.

Inits the pipeline with a source and some writable sinks

◆ start()

Result SC::AsyncPipeline::start ( )

Starts the pipeline.

Note: Both source and sinks must have been already setup by the caller

◆ unpipe()

bool SC::AsyncPipeline::unpipe ( )

nodiscard

Unregisters all events from source, transforms ans sinks.

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

AsyncStreams.h

Public Member Functions