LogicalTxnParticipant.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/txn/LogicalTxnParticipant.h#10 $
// 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_LogicalTxnParticipant_Included
#define Fennel_LogicalTxnParticipant_Included

#include <boost/utility.hpp>

FENNEL_BEGIN_NAMESPACE

class FENNEL_TXN_EXPORT LogicalTxnParticipant
{
    friend class LogicalTxn;

    LogicalTxn *pTxn;

    bool loggingEnabled;

    void clearLogicalTxn();

    void enableLogging(bool);

protected:
    explicit LogicalTxnParticipant();

    LogicalTxn *getLogicalTxn();

    bool isLoggingEnabled() const;

public:
    virtual ~LogicalTxnParticipant();

    virtual LogicalTxnClassId getParticipantClassId() const = 0;

    virtual void describeParticipant(
        ByteOutputStream &logStream) = 0;

    virtual void undoLogicalAction(
        LogicalActionType actionType,
        ByteInputStream &logStream) = 0;

    virtual void redoLogicalAction(
        LogicalActionType actionType,
        ByteInputStream &logStream) = 0;
};

inline LogicalTxn *LogicalTxnParticipant::getLogicalTxn()
{
    return pTxn;
}

inline bool LogicalTxnParticipant::isLoggingEnabled() const
{
    return loggingEnabled;
}

FENNEL_END_NAMESPACE

#endif

// End LogicalTxnParticipant.h

---