/usr/include/casacore/tables/Tables/TableLockData.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 | //# TableLockData.h: Class to hold table lock data
//# Copyright (C) 1997,1998,1999,2000,2002,2003
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library 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 Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef TABLES_TABLELOCKDATA_H
#define TABLES_TABLELOCKDATA_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/Tables/TableLock.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Class to hold table lock data.
// </summary>
// <use visibility=local>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tTable" demos="">
// </reviewed>
// <prerequisite>
// <li> class <linkto class=Table>TableLock</linkto>
// </prerequisite>
// <synopsis>
// This class keeps the <src>LockFile</src> object used to do the
// actual locking/unlocking.
// It also keeps the synchronization information.
// </synopsis>
// <motivation>
// Encapsulate Table locking data.
// </motivation>
class TableLockData : public TableLock
{
public:
// Define the signature of the callback function when a lock is released.
// The flag <src>always</src> tells if the callback function should
// always write its main data (meant for case that table gets closed).
// The callback function has to write the synchronization data
// (preferably in canonical format) in a MemoryIO object.
// A pointer to this MemoryIO object has to be returned. A zero pointer
// can be returned when no synchronization data is available.
typedef MemoryIO* ReleaseCallBack (void* parentObject, Bool always);
// Construct from the given TableLock object.
TableLockData (const TableLock& lockOptions, ReleaseCallBack* = 0,
void* releaseParentObject = 0);
~TableLockData();
// Create the <src>LockFile</src> object and acquire a read or write
// lock when permanent locking is in effect.
// It throws an exception when acquiring the lock failed.
void makeLock (const String& name, Bool create, FileLocker::LockType,
uInt locknr = 0);
// Acquire a read or write lock.
// It throws an exception when acquire failed while it had to wait.
Bool acquire (MemoryIO* info, FileLocker::LockType, uInt nattempts);
// Release the lock. When always==False, the lock is not released
// when a permanent lock is used.
// It does nothing when permanent locking is used.
// It throws an exception when the release failed.
// When the lock is released, the release callback function (if defined)
// is called to write the synchronization data.
void release (Bool always = False);
// When the inspection interval has expired, inspect if another process
// needs the lock. If so, release the lock.
// <src>always=True</src> means that the inspection is always done,
// thus not every 25th call or so.
void autoRelease (Bool always=False);
// Has this process the read or write lock, thus can the table
// be read or written safely?
Bool hasLock (FileLocker::LockType) const;
// Is the table in use (i.e. open) in another process?
Bool isMultiUsed() const;
// Get or put the info in the lock file.
// <group>
void getInfo (MemoryIO& info);
void putInfo (const MemoryIO& info);
// </group>
private:
// Copy constructor is forbidden.
TableLockData (const TableLockData& that);
// Assignment is forbidden.
TableLockData& operator= (const TableLockData& that);
//# Define the lock file.
LockFile* itsLock;
//# Define if the file is already read or write locked.
ReleaseCallBack* itsReleaseCallBack;
void* itsReleaseParent;
};
inline Bool TableLockData::hasLock (FileLocker::LockType type) const
{
return (itsLock == 0 ? True : itsLock->hasLock (type));
}
inline void TableLockData::autoRelease (Bool always)
{
if (option() == AutoLocking && itsLock->inspect(always)) {
release();
}
}
inline Bool TableLockData::isMultiUsed() const
{
return itsLock->isMultiUsed();
}
inline void TableLockData::getInfo (MemoryIO& info)
{
itsLock->getInfo (info);
}
inline void TableLockData::putInfo (const MemoryIO& info)
{
itsLock->putInfo (info);
}
} //# NAMESPACE CASACORE - END
#endif
|