pipe.h

Go to the documentation of this file.

#if !defined(FLOW_PIPE_H)
     #define FLOW_PIPE_H

#include "named.h"
#include "packet.h"

#include <memory>
#include <queue>
#include <string>
#include <utility>


namespace flow
{

template<typename T>
class inpin;

template<typename T>
class outpin;

template<typename T>
class pipe : public named
{
    std::deque<std::unique_ptr<packet<T>>> d_packets;

    outpin<T> *d_input_p;
    inpin<T> *d_output_p;

    size_t d_max_length;
    size_t d_max_weight;

    size_t d_weight;

public:
    pipe(const std::string& name_r, outpin<T> *output_p, inpin<T> *input_p, const size_t max_length = 0, const size_t max_weight = 0)
        : named(name_r), d_input_p(output_p), d_output_p(input_p), d_max_length(max_length), d_max_weight(max_weight), d_weight(0)
    {}

    pipe(pipe&& pipe_rr) : named(std::move(pipe_rr)), d_packets(std::move(pipe_rr.d_packets)), d_input_p(std::move(pipe_rr.d_input_p)), d_output_p(std::move(pipe_rr.d_output_p)),
        d_max_length(std::move(pipe_rr.d_max_length)), d_max_weight(std::move(pipe_rr.d_max_weight)), d_weight(std::move(pipe_rr.d_weight))
    {}

    virtual ~pipe() {}

    virtual outpin<T>* input() const
    {
        return d_input_p;
    }

    virtual inpin<T>* output() const
    {
        return d_output_p;
    }

    virtual size_t length() const
    {
        return d_packets.size();
    }

    virtual size_t max_length() const
    {
        return d_max_length;
    }

    virtual size_t weight() const
    {
        return d_weight;
    }

    virtual size_t max_weight() const
    {
        return d_max_weight;
    }

    virtual size_t cap_length(const size_t max_length)
    {
        size_t previous_cap = d_max_length;
        d_max_length = max_length;
        return previous_cap;
    }

    virtual size_t cap_weight(const size_t max_weight)
    {
        size_t previous_cap = d_max_weight;
        d_max_weight = max_weight;
        return previous_cap;
    }
    
    virtual size_t flush()
    {
        size_t s = d_packets.size();
        d_packets.clear();

        return s;
    }

    virtual bool push(std::unique_ptr<packet<T>> packet_p)
    {
        if(d_max_length && (d_packets.size() == d_max_length)) return false;
        if(d_max_weight && (d_weight + packet_p->size() > d_max_weight)) return false;

        d_weight += packet_p->size();
        d_packets.push_back(std::move(packet_p));

        return true;
    }
    
    virtual std::unique_ptr<packet<T>> pop()
    {
        if(!d_packets.size()) return std::unique_ptr<packet<T>>();

        std::unique_ptr<packet<T>> packet_p(std::move(d_packets.front()));
        
        d_packets.pop_front();
        d_weight -= packet_p->size();

        return packet_p;
    }
};

}

#endif

/*
    (C) Copyright Thierry Seegers 2010-2012. Distributed under the following license:

    Boost Software License - Version 1.0 - August 17th, 2003

    Permission is hereby granted, free of charge, to any person or organization
    obtaining a copy of the software and accompanying documentation covered by
    this license (the "Software") to use, reproduce, display, distribute,
    execute, and transmit the Software, and to prepare derivative works of the
    Software, and to permit third-parties to whom the Software is furnished to
    do so, all subject to the following:

    The copyright notices in the Software and this entire statement, including
    the above license grant, this restriction and the following disclaimer,
    must be included in all copies of the Software, in whole or in part, and
    all derivative works of the Software, unless such copies or derivative
    works are solely in the form of machine-executable object code generated by
    a source language processor.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
    SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
    FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
    ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/