ExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/exec/ExecStream.h#19 $
// 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_ExecStream_Included
#define Fennel_ExecStream_Included

#include "fennel/exec/ExecStreamDefs.h"
#include "fennel/exec/ErrorSource.h"
#include "fennel/common/ClosableObject.h"
#include "fennel/common/TraceSource.h"
#include "fennel/tuple/TupleDescriptor.h"
#include "fennel/tuple/TupleFormat.h"

#include <boost/utility.hpp>
#include <vector>

FENNEL_BEGIN_NAMESPACE

class FENNEL_EXEC_EXPORT ExecStream
    : public boost::noncopyable,
        virtual public ClosableObject,
        virtual public TraceSource,
        virtual public ErrorSource
{
    friend class ExecStreamGraphImpl;
protected:

    bool isOpen;

    ExecStreamGraph *pGraph;

    ExecStreamId id;

    std::string name;

    SharedDynamicParamManager pDynamicParamManager;


    SharedLogicalTxn pTxn;


    ExecStreamResourceQuantity resourceAllocation;

    SharedCacheAccessor pQuotaAccessor;

    SharedCacheAccessor pScratchQuotaAccessor;

    explicit ExecStream();

    // interface methods below are protected because they should only be called
    // indirectly via ExecStreamGraph interface

    virtual void closeImpl();

public:
    virtual bool canEarlyClose();

    inline ExecStreamGraph &getGraph() const;

    inline ExecStreamId getStreamId() const;

    virtual void setInputBufAccessors(
        std::vector<SharedExecStreamBufAccessor> const &inAccessors) = 0;

    virtual void setOutputBufAccessors(
        std::vector<SharedExecStreamBufAccessor> const &outAccessors) = 0;

    virtual void prepare(ExecStreamParams const &params);

    virtual void getResourceRequirements(
        ExecStreamResourceQuantity &minQuantity,
        ExecStreamResourceQuantity &optQuantity,
        ExecStreamResourceSettingType &optType);

    virtual void getResourceRequirements(
        ExecStreamResourceQuantity &minQuantity,
        ExecStreamResourceQuantity &optQuantity);

    virtual void setResourceAllocation(
        ExecStreamResourceQuantity &quantity);

    virtual void open(bool restart);

    virtual void setName(std::string const &);

    virtual std::string const &getName() const;

    virtual ExecStreamResult execute(ExecStreamQuantum const &quantum) = 0;

    virtual bool mayBlock() const;

    virtual void checkAbort() const;

    virtual ExecStreamBufProvision getOutputBufProvision() const;

    virtual ExecStreamBufProvision getOutputBufConversion() const;

    virtual ExecStreamBufProvision getInputBufProvision() const;
};

inline ExecStreamId ExecStream::getStreamId() const
{
    return id;
}

inline ExecStreamGraph &ExecStream::getGraph() const
{
    assert(pGraph);
    return *pGraph;
}

FENNEL_END_NAMESPACE

#endif

// End ExecStream.h

---