LockHolderId.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/synch/LockHolderId.h#5 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2007-2009 The Eigenbase Project
// Copyright (C) 2007-2009 SQLstream, Inc.
// Copyright (C) 2007-2009 LucidEra, Inc.
//
// 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_LockHolderId_Included
#define Fennel_LockHolderId_Included

FENNEL_BEGIN_NAMESPACE

class FENNEL_SYNCH_EXPORT LockHolderId
{
    enum HolderType {
        TYPE_NULL,
        TYPE_THREAD,
        TYPE_TXN
    };

    TxnId holderId;
    HolderType holderType;

public:
    explicit inline LockHolderId();

    explicit inline LockHolderId(TxnId txnId);

    inline void assignFrom(TxnId txnId);

    inline bool isNull() const;

    inline void setNull();

    inline int operator == (LockHolderId const & other) const;
};

inline void LockHolderId::assignFrom(TxnId txnId)
{
    if (txnId == IMPLICIT_TXN_ID) {
        // NOTE jvs 2-Jun-2007:  Not exactly posixly correct,
        // but it will probably do for most environments.
        holderId = TxnId(uint(getCurrentThreadId()));
        holderType = TYPE_THREAD;
    } else {
        holderId = txnId;
        holderType = TYPE_TXN;
    }
}

void LockHolderId::setNull()
{
    holderId = NULL_TXN_ID;
    holderType = TYPE_NULL;
}

inline LockHolderId::LockHolderId()
{
    setNull();
}

inline LockHolderId::LockHolderId(TxnId txnId)
{
    assignFrom(txnId);
}

inline bool LockHolderId::isNull() const
{
    return holderType == TYPE_NULL;
}

inline int LockHolderId::operator == (LockHolderId const & other) const
{
    return (holderId == other.holderId)
        && (holderType == other.holderType);
}

FENNEL_END_NAMESPACE

#endif

// End LockHolderId.h

---