API Documentation
The stlab libraries
Source Code
The source code is hosted on github.
License
Boost Software License, Version 1.0
Examples
stlab::async
|
async_example.cpp |
Creates a future running on a given executor |
await
|
await_example.cpp |
Called on an await-process whenever a new value was received from upstream. |
stlab::buffer_size
|
buffer_size_example.cpp |
|
process
|
process_example.cpp |
Describes a process that gets executed whenever a value is passed into the channel |
operator co_await
|
operator_co_await_example.cpp |
Creates a awaitable object on a given future. |
operator|
|
then_continuation_example.cpp then_split_example.cpp |
Creates a continuation on the current future. |
operator^
|
recover_example.cpp |
Creates a recoverable future on the current object. |
stlab::package
|
package_example.cpp |
Create a promise/future pair |
recover
|
recover_example.cpp |
Creates a recoverable future on the current object. |
then
|
then_continuation_example.cpp then_split_example.cpp |
Creates a continuation on the current future. |
stlab::when_all
|
when_all_example.cpp when_all_void_example.cpp |
Creates a joining future |
stlab::when_any
|
when_any_example.cpp when_any_void_example.cpp |
Creates a future that continues on the first success of any futures passed |
operator|
|
operator_pipe_example.cpp |
Attaches a new process to the channel. |
set_ready
|
set_ready_example.cpp |
Sets the receiver ready to receive values. |
stlab::sender::operator()
|
call_operator_example.cpp |
Sends a new value into the channel |
stlab::channel
|
channel_example.cpp |
Creates a pair that consists of a sender and a receiver |
stlab::for_each_argument
|
for_each_argument_example.cpp |
Execute a function for each passed argument |
stlab::serial_queue
|
serial_queue_example.cpp |
An executor wrapper that causes enqueued tasks to be run serially. |
stlab::executor
|
executor_example.cpp |
Executor wrapper class |
stlab::join
|
zip_with_example.cpp |
Creates a future that joins all passed arguments. This function is deprecated and it will soon be removed. Please use instead of `zip_with` |
stlab::merge
|
merge_channel_example.cpp |
Creates a receiver that merges all passed arguments. This function is deprecated and will be removed soon. Please instead `merge_channel |
stlab::merge_channel
|
merge_channel_example.cpp |
Creates a channel that merges all passed arguments |
stlab::scope
|
scope_example.cpp scope_example_return.cpp |
Explicitly scope the lifetime of an object |
stlab::zip
|
zip_example.cpp |
It zips the values in step from all upstream receivers. (The functionality has changed after release 1.2.0!) |
stlab::zip_with
|
zip_with_example.cpp |
Creates a channel that zips multiple channels into a single one |