Class used to send data to a Channel. More...

#include "Channel.h"

Collaboration diagram for scl::async::details::ChannelSender< Chan >:

Public Types
using	channel_type = Chan
	The type of the channel. More...

using	sender_traits = channel_actor_traits< ChannelSender >
	The traits of the sender. More...

using	lock_type = typename sender_traits::lock_type
	The type of lock used in the sender. More...

template<class L >
using	guard_type = typename sender_traits::template guard_type< L >
	The type of guards used in the sender. More...

using	queue_type = typename sender_traits::queue_type
	The type of queue used in the channel. More...

using	value_type = typename sender_traits::value_type
	The type of values used in the channel. More...

Public Member Functions
	ChannelSender (const ChannelSender &)=delete

ChannelSender &	operator= (const ChannelSender &)=delete

	ChannelSender (ChannelSender &&)=delete

ChannelSender &	operator= (ChannelSender &&)=delete

template<class U = value_type>
ChannelSender &	push (U &&value)
	Forward a value into the queue. More...

template<class... Args>
ChannelSender &	pushEmplace (Args &&... args)
	Construct and push in-place the value. More...

template<class U = value_type>
ChannelSender &	queue (U &&value)
	Alias for ChannelSender::push. More...

template<class U = value_type>
ChannelSender &	enqueue (U &&value)
	Alias for ChannelSender::push. More...

template<class U = value_type>
ChannelSender &	send (U &&value)
	Alias for ChannelSender::push. More...

template<class U = value_type>
ChannelSender &	operator<< (U &&value)
	Alias for ChannelSender::push. More...

Public Attributes
friend	sender_traits

friend	channel_type

Protected Member Functions
	ChannelSender (channel_type &chan)
	Construct a sender from a (safe) pointer to its channel. More...

template<class... Args>
ChannelSender &	doPush (Args &&... args)
	Implementation details to push data onto the channel. More...

Protected Attributes
channel_type *	channel
	A (safe) pointer to the channel. More...

sender_traits	traits
	The traits for the sender. More...

Detailed Description

template<class Chan>
class scl::async::details::ChannelSender< Chan >

Class used to send data to a Channel.

Template Parameters

Chan	being the channel type

Definition at line 22 of file Channel.h.

Member Typedef Documentation

◆ channel_type

template<class Chan>

scl::async::details::ChannelSender< Chan >::channel_type

The type of the channel.

Definition at line 441 of file Channel.h.

◆ guard_type

template<class Chan>

template<class L >

scl::async::details::ChannelSender< Chan >::guard_type

The type of guards used in the sender.

Definition at line 460 of file Channel.h.

◆ lock_type

template<class Chan>

scl::async::details::ChannelSender< Chan >::lock_type

The type of lock used in the sender.

Definition at line 453 of file Channel.h.

◆ queue_type

template<class Chan>

scl::async::details::ChannelSender< Chan >::queue_type

The type of queue used in the channel.

Definition at line 466 of file Channel.h.

◆ sender_traits

template<class Chan>

scl::async::details::ChannelSender< Chan >::sender_traits

The traits of the sender.

Definition at line 447 of file Channel.h.

◆ value_type

template<class Chan>

scl::async::details::ChannelSender< Chan >::value_type

The type of values used in the channel.

Definition at line 472 of file Channel.h.

Constructor & Destructor Documentation

◆ ChannelSender() [1/3]

template<class Chan>

scl::async::details::ChannelSender< Chan >::ChannelSender ( channel_type & chan )

inlineexplicitprotected

Construct a sender from a (safe) pointer to its channel.

Parameters

chan	being the channel to construct from

Definition at line 492 of file Channel.h.

◆ ChannelSender() [2/3]

template<class Chan>

scl::async::details::ChannelSender< Chan >::ChannelSender ( const ChannelSender< Chan > & )

delete

◆ ChannelSender() [3/3]

template<class Chan>

scl::async::details::ChannelSender< Chan >::ChannelSender ( ChannelSender< Chan > && )

delete

Member Function Documentation

◆ doPush()

template<class Chan>

template<class... Args>

ChannelSender& scl::async::details::ChannelSender< Chan >::doPush ( Args &&... args )

inlineprotected

Implementation details to push data onto the channel.

Template Parameters

Args	being the type of the arguments for the constructor

Parameters

args	being the arguments for the constructor

Returns: a reference to this ChannelSender

Definition at line 502 of file Channel.h.

◆ enqueue()

template<class Chan>

template<class U = value_type>

ChannelSender& scl::async::details::ChannelSender< Chan >::enqueue ( U && value )

inline

Alias for ChannelSender::push.

Definition at line 549 of file Channel.h.

◆ operator<<()

template<class Chan>

template<class U = value_type>

ChannelSender& scl::async::details::ChannelSender< Chan >::operator<< ( U && value )

inline

Alias for ChannelSender::push.

Definition at line 563 of file Channel.h.

◆ operator=() [1/2]

template<class Chan>

ChannelSender& scl::async::details::ChannelSender< Chan >::operator= ( const ChannelSender< Chan > & )

delete

◆ operator=() [2/2]

template<class Chan>

ChannelSender& scl::async::details::ChannelSender< Chan >::operator= ( ChannelSender< Chan > && )

delete

◆ push()

template<class Chan>

template<class U = value_type>

ChannelSender& scl::async::details::ChannelSender< Chan >::push ( U && value )

inline

Forward a value into the queue.

Template Parameters

U	being the type of data to forward (defaults to ChannelSender::value_type)

Parameters

value being the value to forward

Returns: a reference to this ChannelSender

Definition at line 522 of file Channel.h.

◆ pushEmplace()

template<class Chan>

template<class... Args>

ChannelSender& scl::async::details::ChannelSender< Chan >::pushEmplace ( Args &&... args )

inline

Construct and push in-place the value.

Template Parameters

Args	being the types of arguments for the constructor

Parameters

args	being the arguments for the constructor

Returns: a reference to this ChannelSender

Definition at line 533 of file Channel.h.

◆ queue()

template<class Chan>

template<class U = value_type>

ChannelSender& scl::async::details::ChannelSender< Chan >::queue ( U && value )

inline

Alias for ChannelSender::push.

Definition at line 541 of file Channel.h.

◆ send()

template<class Chan>

template<class U = value_type>

ChannelSender& scl::async::details::ChannelSender< Chan >::send ( U && value )

inline

Alias for ChannelSender::push.

Definition at line 557 of file Channel.h.

Member Data Documentation

◆ channel

template<class Chan>

channel_type* scl::async::details::ChannelSender< Chan >::channel

protected

A (safe) pointer to the channel.

Definition at line 481 of file Channel.h.

◆ channel_type

template<class Chan>

friend scl::async::details::ChannelSender< Chan >::channel_type

Definition at line 475 of file Channel.h.

◆ sender_traits

template<class Chan>

friend scl::async::details::ChannelSender< Chan >::sender_traits

Definition at line 474 of file Channel.h.

◆ traits

template<class Chan>

sender_traits scl::async::details::ChannelSender< Chan >::traits

protected

The traits for the sender.

Definition at line 486 of file Channel.h.

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

include/scl/async/Channel.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<class Chan> class scl::async::details::ChannelSender< Chan >

Member Typedef Documentation

◆ channel_type

◆ guard_type

◆ lock_type

◆ queue_type

◆ sender_traits

◆ value_type

Constructor & Destructor Documentation

◆ ChannelSender() [1/3]

◆ ChannelSender() [2/3]

◆ ChannelSender() [3/3]

Member Function Documentation

◆ doPush()

◆ enqueue()

◆ operator<<()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ push()

◆ pushEmplace()

◆ queue()

◆ send()

Member Data Documentation

◆ channel

◆ channel_type

◆ sender_traits

◆ traits

template<class Chan>
class scl::async::details::ChannelSender< Chan >