Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
Lucene.Net.Store.SingleInstanceLockFactory Class Reference

Implements LockFactory for a single in-process instance, meaning all locking will take place through this one instance. Only use this LockFactory when you are certain all IndexReaders and IndexWriters for a given index are running against a single shared in-process Directory instance. This is currently the default locking for RAMDirectory. More...

Inherits Lucene.Net.Store.LockFactory.

Public Member Functions

override Lock MakeLock (System.String lockName)
 Return a new Lock instance identified by lockName.
 
override 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.
 

Additional Inherited Members

- Properties inherited from Lucene.Net.Store.LockFactory
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

Implements LockFactory for a single in-process instance, meaning all locking will take place through this one instance. Only use this LockFactory when you are certain all IndexReaders and IndexWriters for a given index are running against a single shared in-process Directory instance. This is currently the default locking for RAMDirectory.

See Also
LockFactory

Definition at line 34 of file SingleInstanceLockFactory.cs.

Member Function Documentation

override void Lucene.Net.Store.SingleInstanceLockFactory.ClearLock ( System.String  lockName)
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.

Implements Lucene.Net.Store.LockFactory.

Definition at line 47 of file SingleInstanceLockFactory.cs.

override Lock Lucene.Net.Store.SingleInstanceLockFactory.MakeLock ( System.String  lockName)
virtual

Return a new Lock instance identified by lockName.

Parameters
lockNamename of the lock to be created.

Implements Lucene.Net.Store.LockFactory.

Definition at line 39 of file SingleInstanceLockFactory.cs.


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