scl::async Namespace Reference

Base namespace for asynchronous APIs. More...

Namespaces
	details

Classes
class	Active
	A class that allow task execution on a separate thread using RAII semantics. More...
class	AsyncQueue
class	Channel
	A channel to use for asynchronous communication of data in a queued manner. More...
class	Mutexed
	A wrapper class that protects a value with a lock. More...
struct	with_traits
	Traits for use with the scl::async::with function. More...
struct	with_traits< Mutexed< T > >
struct	with_traits< std::mutex >

Functions
template<class U , class T , class L , template< class > class G, class C >
void	operator>> (U &&value, Channel< T, L, G, C > &channel)
	Forward a value into a channel. More...
template<class U , class T , class L , template< class > class G, class C >
void	operator<< (U &value, Channel< T, L, G, C > &channel)
	Extract a value from the channel. More...
template<class Resource , class F >
auto	with (Resource &&res, F &&f) -> scl::tools::meta ::return_t< F >
	Execute a transaction in a guarded manner. More...

Detailed Description

Base namespace for asynchronous APIs.

Function Documentation

operator<<()

template<class U , class T , class L , template< class > class G, class C >

void scl::async::operator<<	(	U &	value,
		Channel< T, L, G, C > &	channel
	)

Extract a value from the channel.

Template Parameters

U	being the type to store the data into
T	being the type of values in the channel
L	being the type of locks in the channel
G	being the type of lock guards in the channel
C	being the type of container used in the channel

Parameters

value	being the place to store the extracted data
channel	being the channel to extract data from

Definition at line 425 of file Channel.h.

operator>>()

template<class U , class T , class L , template< class > class G, class C >

void scl::async::operator>>	(	U &&	value,
		Channel< T, L, G, C > &	channel
	)

Forward a value into a channel.

Template Parameters

U	being the type of data to forward
T	being the type of values in the channel
L	being the type of locks in the channel
G	being the type of lock guards in the channel
C	being the type of container used in the channel

Parameters

value	being the value to forward
channel	being the channel to forward the value into

Definition at line 410 of file Channel.h.

with()

template<class Resource , class F >

auto scl::async::with	(	Resource &&	res,
		F &&	f
	)		-> scl::tools::meta ::return_t<F>

Execute a transaction in a guarded manner.

Template Parameters

Resource	being the guarded/guarding resource type
F	being the transaction type

Parameters

res	being the guarded/guarding resource
f	being the transaction to execute

Definition at line 14 of file with.h.