Developer documentation
Version 3.0.3-105-gd3941f44
MR::Thread::Queue< T >::Writer Class Reference

This class is used to register a writer with the queue. More...

#include "thread_queue.h"

Classes

class  Item
 This class is used to write items to the queue. More...
 

Public Member Functions

 Writer (Queue< T > &queue)
 Register a Writer object with the queue. More...
 
 Writer (const Writer &W)
 
Item placeholder () const
 

Detailed Description

template<class T>
class MR::Thread::Queue< T >::Writer

This class is used to register a writer with the queue.

Items cannot be written directly onto a Thread::Queue queue. An object of this class must first be instanciated to notify the queue that a section of code will be writing to the queue. The actual process of writing items to the queue is done via the Writer::Item class.

See also
Thread::Queue for more detailed information and examples.
Thread::run_queue() for a much more user-friendly way of setting up a queue.

Definition at line 375 of file thread_queue.h.

Constructor & Destructor Documentation

◆ Writer() [1/2]

template<class T >
MR::Thread::Queue< T >::Writer::Writer ( Queue< T > &  queue)
inline

Register a Writer object with the queue.

The Writer object will register itself with the queue as a writer.

Definition at line 380 of file thread_queue.h.

◆ Writer() [2/2]

template<class T >
MR::Thread::Queue< T >::Writer::Writer ( const Writer W)
inline

Definition at line 383 of file thread_queue.h.

Member Function Documentation

◆ placeholder()

template<class T >
Item MR::Thread::Queue< T >::Writer::placeholder ( ) const
inline

Definition at line 428 of file thread_queue.h.


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