Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | Properties | List of all members
Lucene.Net.Store.LockFactory Class Referenceabstract

Base class for Locking implementation. Directory uses instances of this class to implement locking. More...

Inherited by Lucene.Net.Store.FSLockFactory, Lucene.Net.Store.NoLockFactory, Lucene.Net.Store.SingleInstanceLockFactory, and Lucene.Net.Store.VerifyingLockFactory.

Public Member Functions

abstract Lock MakeLock (System.String lockName)
 Return a new Lock instance identified by lockName.
 
abstract void ClearLock (System.String lockName)
 Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use.
 

Properties

virtual string LockPrefix [get, set]
 Gets or sets the prefix in use for all locks created in this LockFactory. This is normally called once, when a Directory gets this LockFactory instance. However, you can also call this (after this instance is assigned to a Directory) to override the prefix in use. This is helpful if you're running Lucene on machines that have different mount points for the same shared directory.
 

Detailed Description

Base class for Locking implementation. Directory uses instances of this class to implement locking.

Note that there are some useful tools to verify that your LockFactory is working correctly: VerifyingLockFactory , LockStressTest, LockVerifyServer .

See Also
LockVerifyServer
See Also
LockStressTest
See Also
VerifyingLockFactory

Definition at line 39 of file LockFactory.cs.

Member Function Documentation

abstract void Lucene.Net.Store.LockFactory.ClearLock ( System.String  lockName)
pure virtual

Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use.

Parameters
lockNamename of the lock to be cleared.

Implemented in Lucene.Net.Store.VerifyingLockFactory, Lucene.Net.Store.NativeFSLockFactory, Lucene.Net.Store.SimpleFSLockFactory, Lucene.Net.Store.NoLockFactory, and Lucene.Net.Store.SingleInstanceLockFactory.

abstract Lock Lucene.Net.Store.LockFactory.MakeLock ( System.String  lockName)
pure virtual

Return a new Lock instance identified by lockName.

Parameters
lockNamename of the lock to be created.

Implemented in Lucene.Net.Store.VerifyingLockFactory, Lucene.Net.Store.NativeFSLockFactory, Lucene.Net.Store.SimpleFSLockFactory, Lucene.Net.Store.NoLockFactory, and Lucene.Net.Store.SingleInstanceLockFactory.

Property Documentation

virtual string Lucene.Net.Store.LockFactory.LockPrefix
getset

Gets or sets the prefix in use for all locks created in this LockFactory. This is normally called once, when a Directory gets this LockFactory instance. However, you can also call this (after this instance is assigned to a Directory) to override the prefix in use. This is helpful if you're running Lucene on machines that have different mount points for the same shared directory.

Definition at line 53 of file LockFactory.cs.


The documentation for this class was generated from the following file: