BarrierExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/exec/BarrierExecStream.h#12 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2005-2009 SQLstream, Inc.
// Copyright (C) 2005-2009 LucidEra, Inc.
// Portions Copyright (C) 2004-2009 John V. Sichi
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2 of the License, or (at your option)
// any later version approved by The Eigenbase Project.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef Fennel_BarrierExecStream_Included
#define Fennel_BarrierExecStream_Included

#include "fennel/common/FemEnums.h"
#include "fennel/exec/ConfluenceExecStream.h"
#include "fennel/exec/DynamicParam.h"
#include "fennel/tuple/TupleData.h"
#include "fennel/tuple/TupleAccessor.h"
#include <boost/scoped_array.hpp>

FENNEL_BEGIN_NAMESPACE

struct FENNEL_EXEC_EXPORT BarrierExecStreamParams
    : public ConfluenceExecStreamParams
{
    BarrierReturnMode returnMode;

    std::vector<DynamicParamId> parameterIds;
};

class FENNEL_EXEC_EXPORT BarrierExecStream
    : public ConfluenceExecStream
{
    TupleData inputTuple;

    bool isDone;

    TupleData compareTuple;

    TupleAccessor *outputTupleAccessor;

    uint outputBufSize;

    boost::scoped_array<FixedBuffer> outputTupleBuffer;

    uint iInput;

    BarrierReturnMode returnMode;

    uint curOutputPos;

    std::vector<DynamicParamId> parameterIds;

    TupleData dynParamVal;

    void processInputTuple();

    uint copyInputData(
        PBuffer destBuffer,
        SharedExecStreamBufAccessor &pInAccessor);

    inline bool returnFirstInput();

    inline bool returnAnyInput();

    inline bool returnAllInputs();

public:
    // implement ExecStream
    virtual void prepare(BarrierExecStreamParams const &params);
    virtual void open(bool restart);
    virtual ExecStreamResult execute(ExecStreamQuantum const &quantum);
    virtual ExecStreamBufProvision getOutputBufProvision() const;
    virtual void closeImpl();
};

inline bool BarrierExecStream::returnFirstInput()
{
    return (returnMode == BARRIER_RET_FIRST_INPUT);
}

inline bool BarrierExecStream::returnAnyInput()
{
    return (returnMode == BARRIER_RET_ANY_INPUT);
}

inline bool BarrierExecStream::returnAllInputs()
{
    return (returnMode == BARRIER_RET_ALL_INPUTS);
}

FENNEL_END_NAMESPACE

#endif

// End BarrierExecStream.h

---