Class NIOFSDirectory

An FSDirectory implementation that uses System.IO.FileStream's positional read, which allows multiple threads to read from the same file without synchronizing.

This class only uses System.IO.FileStream when reading; writing is achieved with FSDirectory.FSIndexOutput.

NOTE: Since the .NET NIOFSDirectory uses additional seeking during reads, it will generally be slightly less efficient than SimpleFSDirectory. This class has poor concurrent read performance (multiple threads will bottleneck) as it synchronizes when multiple threads read from the same file. It's usually better to use MMapDirectory for reading.

NOTE: Unlike in Java, it is not recommended to use System.Threading.Thread.Interrupt in .NET in conjunction with an open FSDirectory because it is not guaranteed to exit atomically. Any lock statement or System.Threading.Monitor.Enter(System.Object) call can throw a System.Threading.ThreadInterruptedException, which makes shutting down unpredictable. To exit parallel tasks safely, we recommend using System.Threading.Tasks.Tasks and "interrupt" them with System.Threading.CancellationTokens.

Inheritance

System.Object

Directory

BaseDirectory

FSDirectory

NIOFSDirectory

Implements

System.IDisposable

Inherited Members

FSDirectory.DEFAULT_READ_CHUNK_SIZE

FSDirectory.m_directory

FSDirectory.Open(DirectoryInfo)

FSDirectory.Open(String)

FSDirectory.Open(DirectoryInfo, LockFactory)

FSDirectory.Open(String, LockFactory)

FSDirectory.SetLockFactory(LockFactory)

FSDirectory.ListAll(DirectoryInfo)

FSDirectory.ListAll()

FSDirectory.FileExists(String)

FSDirectory.FileLength(String)

FSDirectory.DeleteFile(String)

FSDirectory.CreateOutput(String, IOContext)

FSDirectory.EnsureCanWrite(String)

FSDirectory.OnIndexOutputClosed(FSDirectory.FSIndexOutput)

FSDirectory.Sync(ICollection<String>)

FSDirectory.GetLockID()

FSDirectory.Dispose(Boolean)

FSDirectory.Directory

FSDirectory.ToString()

FSDirectory.ReadChunkSize

BaseDirectory.IsOpen

BaseDirectory.m_lockFactory

BaseDirectory.MakeLock(String)

BaseDirectory.ClearLock(String)

BaseDirectory.LockFactory

BaseDirectory.EnsureOpen()

Directory.OpenChecksumInput(String, IOContext)

Directory.Dispose()

Directory.Copy(Directory, String, String, IOContext)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Lucene.Net.Store

Assembly: Lucene.Net.dll

Syntax

public class NIOFSDirectory : FSDirectory, IDisposable

Constructors

NIOFSDirectory(DirectoryInfo)

Create a new NIOFSDirectory for the named location and NativeFSLockFactory.

Declaration

public NIOFSDirectory(DirectoryInfo path)

Parameters

Type	Name	Description
System.IO.DirectoryInfo	path	the path of the directory

Exceptions

Type	Condition
System.IO.IOException	if there is a low-level I/O error

NIOFSDirectory(DirectoryInfo, LockFactory)

Create a new NIOFSDirectory for the named location.

Declaration

public NIOFSDirectory(DirectoryInfo path, LockFactory lockFactory)

Parameters

Type	Name	Description
System.IO.DirectoryInfo	path	the path of the directory
LockFactory	lockFactory	the lock factory to use, or null for the default (NativeFSLockFactory);

Exceptions

Type	Condition
System.IO.IOException	if there is a low-level I/O error

NIOFSDirectory(String)

Create a new NIOFSDirectory for the named location and NativeFSLockFactory.

LUCENENET specific overload for convenience using string instead of System.IO.DirectoryInfo.

Declaration

public NIOFSDirectory(string path)

Parameters

Type	Name	Description
System.String	path	the path of the directory

Exceptions

Type	Condition
System.IO.IOException	if there is a low-level I/O error

NIOFSDirectory(String, LockFactory)

Create a new NIOFSDirectory for the named location.

LUCENENET specific overload for convenience using string instead of System.IO.DirectoryInfo.

Declaration

public NIOFSDirectory(string path, LockFactory lockFactory)

Parameters

Type	Name	Description
System.String	path	the path of the directory
LockFactory	lockFactory	the lock factory to use, or null for the default (NativeFSLockFactory);

Exceptions

Type	Condition
System.IO.IOException	if there is a low-level I/O error

Methods

CreateSlicer(String, IOContext)

Declaration

public override Directory.IndexInputSlicer CreateSlicer(string name, IOContext context)

Parameters

Type	Name	Description
System.String	name
IOContext	context

Returns

Type	Description
Directory.IndexInputSlicer

Overrides

Directory.CreateSlicer(String, IOContext)

OpenInput(String, IOContext)

Creates an IndexInput for the file with the given name.

Declaration

public override IndexInput OpenInput(string name, IOContext context)

Parameters

Type	Name	Description
System.String	name
IOContext	context

Returns

Type	Description
IndexInput

Overrides

Directory.OpenInput(String, IOContext)

Implements

System.IDisposable