LogicalTxn.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/txn/LogicalTxn.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) 1999-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_LogicalTxn_Included
#define Fennel_LogicalTxn_Included

#include <boost/utility.hpp>
#include <boost/enable_shared_from_this.hpp>
#include "fennel/txn/LogicalTxnStoredStructs.h"

#include <vector>

FENNEL_BEGIN_NAMESPACE

class LogicalTxnParticipant;

class FENNEL_TXN_EXPORT LogicalTxn
    : public boost::noncopyable,
        public boost::enable_shared_from_this<LogicalTxn>
{
    friend class LogicalTxnLog;

    enum State
    {
        STATE_LOGGING_TXN,

        STATE_LOGGING_ACTION,

        STATE_ROLLING_BACK,

        STATE_ROLLED_BACK,

        STATE_COMMITTED
    };

    TxnId txnId;

    SharedLogicalTxnLog pLog;

    SharedCacheAccessor pCacheAccessor;

    SharedSpillOutputStream pOutputStream;

    State state;

    bool checkpointed;

    LogicalTxnSavepoint svpt;

    std::vector<LogicalTxnSavepoint> savepoints;

    std::vector<SharedLogicalTxnParticipant> participants;

    explicit LogicalTxn(
        TxnId txnId,
        SharedLogicalTxnLog pLog,
        SharedCacheAccessor pCacheAccessor);

    void describeParticipant(SharedLogicalTxnParticipant);
    void describeAllParticipants();
    void forgetAllParticipants();

    void rollbackToSavepoint(LogicalTxnSavepoint &oldSvpt);
    ByteOutputStream &beginLogicalAction(
        LogicalTxnParticipant *pParticipant,
        LogicalActionType actionType);

public:

    virtual ~LogicalTxn();

    void addParticipant(SharedLogicalTxnParticipant pParticipant);

    ByteOutputStream &beginLogicalAction(
        LogicalTxnParticipant &participant,
        LogicalActionType actionType);

    void endLogicalAction();

    SavepointId createSavepoint();

    void commitSavepoint(SavepointId svptId);

    void rollback(SavepointId const *pSvptId = NULL);

    void commit();

    SharedLogicalTxnLog getLog();

    TxnId getTxnId() const;

    bool isEnded() const;
};

FENNEL_END_NAMESPACE

#endif

// End LogicalTxn.h

---