Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SimpleFSLockFactory

    Implements LockFactory using WriteAllText(string, string, Encoding) (writes the file with UTF8 encoding and no byte order mark).

    Special care needs to be taken if you change the locking implementation: First be certain that no writer is in fact writing to the index otherwise you can easily corrupt your index. Be sure to do the LockFactory change to all Lucene instances and clean up all leftover lock files before starting the new configuration for the first time. Different implementations can not work together!

    If you suspect that this or any other LockFactory is not working properly in your environment, you can easily test it by using VerifyingLockFactory, LockVerifyServer and LockStressTest.

    Inheritance
    object
    LockFactory
    FSLockFactory
    SimpleFSLockFactory
    Inherited Members
    FSLockFactory.m_lockDir
    FSLockFactory.SetLockDir(DirectoryInfo)
    FSLockFactory.LockDir
    FSLockFactory.ToString()
    LockFactory.m_lockPrefix
    LockFactory.LockPrefix
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Store
    Assembly: Lucene.Net.dll
    Syntax
    public class SimpleFSLockFactory : FSLockFactory

    Constructors

    SimpleFSLockFactory()

    Create a SimpleFSLockFactory instance, with null (unset) lock directory. When you pass this factory to a FSDirectory subclass, the lock directory is automatically set to the directory itself. Be sure to create one instance for each directory your create!

    Declaration
    public SimpleFSLockFactory()
    See Also
    LockFactory

    SimpleFSLockFactory(DirectoryInfo)

    Instantiate using the provided directory (as a DirectoryInfo instance).

    Declaration
    public SimpleFSLockFactory(DirectoryInfo lockDir)
    Parameters
    Type Name Description
    DirectoryInfo lockDir

    where lock files should be created.

    See Also
    LockFactory

    SimpleFSLockFactory(string)

    Instantiate using the provided directory name (string).

    Declaration
    public SimpleFSLockFactory(string lockDirName)
    Parameters
    Type Name Description
    string lockDirName

    where lock files should be created.

    See Also
    LockFactory

    Methods

    ClearLock(string)

    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.

    Declaration
    public override void ClearLock(string lockName)
    Parameters
    Type Name Description
    string lockName

    name of the lock to be cleared.

    Overrides
    LockFactory.ClearLock(string)
    See Also
    LockFactory

    MakeLock(string)

    Return a new Lock instance identified by lockName.

    Declaration
    public override Lock MakeLock(string lockName)
    Parameters
    Type Name Description
    string lockName

    name of the lock to be created.

    Returns
    Type Description
    Lock
    Overrides
    LockFactory.MakeLock(string)
    See Also
    LockFactory

    See Also

    LockFactory
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.