userver: concurrent::Producer< QueueType, ProducerToken, EmplaceEnablerType > Class Template Reference
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
Public Member Functions | List of all members
concurrent::Producer< QueueType, ProducerToken, EmplaceEnablerType > Class Template Referencefinal

Your opinion will help to improve our service

Leave a feedback >

Table of Contents

#include <userver/concurrent/queue_helpers.hpp>

Detailed Description

template<typename QueueType, typename ProducerToken, typename EmplaceEnablerType>
class concurrent::Producer< QueueType, ProducerToken, EmplaceEnablerType >

Producer side of concurrent queues.

Warning
A single Producer must not be used from multiple threads concurrently
See also
concurrent_queues

Definition at line 33 of file queue_helpers.hpp.

Public Member Functions

 Producer (const Producer &)=delete
 
 Producer (Producer &&) noexcept=default
 
Producer & operator= (const Producer &)=delete
 
Producer & operator= (Producer &&other) noexcept
 
bool Push (ValueType &&value, engine::Deadline deadline={}) const
 
bool PushNoblock (ValueType &&value) const
 
void Reset () &&noexcept
 
std::shared_ptr< const QueueType > Queue () const
 Const access to source queue.
 

Constructor & Destructor Documentation

◆ ~Producer()

template<typename QueueType , typename ProducerToken , typename EmplaceEnablerType >
concurrent::Producer< QueueType, ProducerToken, EmplaceEnablerType >::~Producer ( )
inline

Definition at line 52 of file queue_helpers.hpp.

Member Function Documentation

◆ operator=()

template<typename QueueType , typename ProducerToken , typename EmplaceEnablerType >
Producer & concurrent::Producer< QueueType, ProducerToken, EmplaceEnablerType >::operator= ( Producer< QueueType, ProducerToken, EmplaceEnablerType > &&  other)
inlinenoexcept

Definition at line 46 of file queue_helpers.hpp.

◆ Push()

template<typename QueueType , typename ProducerToken , typename EmplaceEnablerType >
bool concurrent::Producer< QueueType, ProducerToken, EmplaceEnablerType >::Push ( ValueType &&  value,
engine::Deadline  deadline = {} 
) const
inline

Push an element into queue. May wait asynchronously if the queue is full. Leaves the value unmodified if the operation does not succeed.

Returns
whether push succeeded before the deadline and before the task was canceled.

Definition at line 60 of file queue_helpers.hpp.

◆ PushNoblock()

template<typename QueueType , typename ProducerToken , typename EmplaceEnablerType >
bool concurrent::Producer< QueueType, ProducerToken, EmplaceEnablerType >::PushNoblock ( ValueType &&  value) const
inline

Try to push an element into queue without blocking. May be used in non-coroutine environment. Leaves the value unmodified if the operation does not succeed.

Returns
whether push succeeded.

Definition at line 70 of file queue_helpers.hpp.

◆ Queue()

template<typename QueueType , typename ProducerToken , typename EmplaceEnablerType >
std::shared_ptr< const QueueType > concurrent::Producer< QueueType, ProducerToken, EmplaceEnablerType >::Queue ( ) const
inline

Const access to source queue.

Definition at line 82 of file queue_helpers.hpp.

◆ Reset()

template<typename QueueType , typename ProducerToken , typename EmplaceEnablerType >
void concurrent::Producer< QueueType, ProducerToken, EmplaceEnablerType >::Reset ( ) &&
inlinenoexcept

Definition at line 75 of file queue_helpers.hpp.

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