PrevUpHomeNext

Class template queue_back

boost::pipeline::queue_back

Synopsis

// In header: <boost/pipeline/queue.hpp>

template<typename T> 
class queue_back {
public:
  // types
  typedef queue< T >::value_type value_type;

  // construct/copy/destruct
  queue_back(queue< T > &);

  // public member functions
  void push(const T &);
  void push(T &&);
  void close();
};

Description

Producer handle to buffer queue between segments.

Each transformation producing multiple items on each call receive a queue_back instance which is used to access to the downstream queue.

A handle is valid until the downstream segment terminates.

Template arguments:

  • T Value type of the underlying queue

queue_back public types

  1. typedef queue< T >::value_type value_type;

    Value type of the underlying queue

queue_back public construct/copy/destruct

  1. queue_back(queue< T > & queue);

    Creates a handle to the given queue.

    The constructed object does not take ownership of the give queue.

queue_back public member functions

  1. void push(const T & item);

    Pushes an item to the underlying queue.

    Parameters:

    item

    Item to be added to the queue

    Requires:

    queue is not closed

    Throws:

    <tt>boost::sync_queue_is_closed</tt> If the queue is already closed
  2. void push(T && item);

    Pushes an item to the underlying queue.

    Parameters:

    item

    Item to be added to the queue

    Requires:

    queue is not closed

    Throws:

    <tt>boost::sync_queue_is_closed</tt> If the queue is already closed
  3. void close();

    Closes the underlying queue.

    Queue will not receive additional items.


PrevUpHomeNext