Eclipse SUMO - Simulation of Urban MObility
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes
TaskQueue< C > Class Template Reference

#include <TaskQueue.h>

Public Types

using TaskPtrType = std::unique_ptr< TaskBase< C > >
 

Public Member Functions

bool isEnabled () const
 
template<typename TaskT >
auto push (TaskT &&task) -> std::future< decltype(task(std::declval< C >()))>
 
void setEnabled (bool enabled)
 
 TaskQueue ()=default
 
bool tryPop (TaskPtrType &task)
 
template<typename TaskT >
auto tryPush (TaskT &&task, bool &success) -> std::future< decltype(task(std::declval< C >()))>
 
bool waitAndPop (TaskPtrType &task)
 
 ~TaskQueue ()=default
 

Private Types

using LockType = std::unique_lock< std::mutex >
 

Private Member Functions

TaskQueue & operator= (const TaskQueue &)=delete
 
 TaskQueue (const TaskQueue &)=delete
 

Private Attributes

bool myEnabled = true
 
std::mutex myMutex
 
std::queue< TaskPtrType > myQueue
 
std::condition_variable myReady
 

Detailed Description

template<typename C>
class TaskQueue< C >

Definition at line 56 of file TaskQueue.h.

Member Typedef Documentation

◆ LockType

template<typename C >
using TaskQueue< C >::LockType = std::unique_lock<std::mutex>
private

Definition at line 57 of file TaskQueue.h.

◆ TaskPtrType

template<typename C >
using TaskQueue< C >::TaskPtrType = std::unique_ptr<TaskBase<C> >

Definition at line 60 of file TaskQueue.h.

Constructor & Destructor Documentation

◆ TaskQueue() [1/2]

template<typename C >
TaskQueue< C >::TaskQueue ( )
default

◆ ~TaskQueue()

template<typename C >
TaskQueue< C >::~TaskQueue ( )
default

◆ TaskQueue() [2/2]

template<typename C >
TaskQueue< C >::TaskQueue ( const TaskQueue< C > &  )
privatedelete

Member Function Documentation

◆ isEnabled()

template<typename C >
bool TaskQueue< C >::isEnabled ( ) const
inline

Definition at line 74 of file TaskQueue.h.

References TaskQueue< C >::myEnabled, and TaskQueue< C >::myMutex.

◆ operator=()

template<typename C >
TaskQueue& TaskQueue< C >::operator= ( const TaskQueue< C > &  )
privatedelete

◆ push()

template<typename C >
template<typename TaskT >
auto TaskQueue< C >::push ( TaskT &&  task) -> std::future<decltype(task(std::declval<C>()))>
inline

Definition at line 91 of file TaskQueue.h.

References TaskQueue< C >::myMutex, TaskQueue< C >::myQueue, and TaskQueue< C >::myReady.

◆ setEnabled()

template<typename C >
void TaskQueue< C >::setEnabled ( bool  enabled)
inline

Definition at line 64 of file TaskQueue.h.

References TaskQueue< C >::myEnabled, TaskQueue< C >::myMutex, and TaskQueue< C >::myReady.

◆ tryPop()

template<typename C >
bool TaskQueue< C >::tryPop ( TaskPtrType &  task)
inline

Definition at line 104 of file TaskQueue.h.

References TaskQueue< C >::myEnabled, TaskQueue< C >::myMutex, and TaskQueue< C >::myQueue.

◆ tryPush()

template<typename C >
template<typename TaskT >
auto TaskQueue< C >::tryPush ( TaskT &&  task,
bool &  success 
) -> std::future<decltype(task(std::declval<C>()))>
inline

Definition at line 115 of file TaskQueue.h.

References TaskQueue< C >::myMutex, TaskQueue< C >::myQueue, and TaskQueue< C >::myReady.

◆ waitAndPop()

template<typename C >
bool TaskQueue< C >::waitAndPop ( TaskPtrType &  task)
inline

Definition at line 79 of file TaskQueue.h.

References TaskQueue< C >::myEnabled, TaskQueue< C >::myMutex, TaskQueue< C >::myQueue, and TaskQueue< C >::myReady.

Field Documentation

◆ myEnabled

template<typename C >
bool TaskQueue< C >::myEnabled = true
private

Definition at line 139 of file TaskQueue.h.

Referenced by TaskQueue< C >::isEnabled(), TaskQueue< C >::setEnabled(), TaskQueue< C >::tryPop(), and TaskQueue< C >::waitAndPop().

◆ myMutex

template<typename C >
std::mutex TaskQueue< C >::myMutex
mutableprivate

Definition at line 140 of file TaskQueue.h.

Referenced by TaskQueue< C >::isEnabled(), TaskQueue< C >::push(), TaskQueue< C >::setEnabled(), TaskQueue< C >::tryPop(), TaskQueue< C >::tryPush(), and TaskQueue< C >::waitAndPop().

◆ myQueue

template<typename C >
std::queue<TaskPtrType> TaskQueue< C >::myQueue
private

Definition at line 138 of file TaskQueue.h.

Referenced by TaskQueue< C >::push(), TaskQueue< C >::tryPop(), TaskQueue< C >::tryPush(), and TaskQueue< C >::waitAndPop().

◆ myReady

template<typename C >
std::condition_variable TaskQueue< C >::myReady
private

Definition at line 141 of file TaskQueue.h.

Referenced by TaskQueue< C >::push(), TaskQueue< C >::setEnabled(), TaskQueue< C >::tryPush(), and TaskQueue< C >::waitAndPop().

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