blob: b3f34fc1abff22610c9b4751f2e82d8a77d2b506 (
plain)
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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
namespace Lucene.Net.Store
{
/// <summary> <p/>Base class for Locking implementation. <see cref="Directory" /> uses
/// instances of this class to implement locking.<p/>
///
/// <p/>Note that there are some useful tools to verify that
/// your LockFactory is working correctly: <see cref="VerifyingLockFactory" />
///, <see cref="LockStressTest" />, <see cref="LockVerifyServer" />
///.<p/>
///
/// </summary>
/// <seealso cref="LockVerifyServer">
/// </seealso>
/// <seealso cref="LockStressTest">
/// </seealso>
/// <seealso cref="VerifyingLockFactory">
/// </seealso>
public abstract class LockFactory
{
protected internal System.String internalLockPrefix = null;
/// <summary> 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.
/// </summary>
public virtual string LockPrefix
{
get { return this.internalLockPrefix; }
set { this.internalLockPrefix = value; }
}
/// <summary> Return a new Lock instance identified by lockName.</summary>
/// <param name="lockName">name of the lock to be created.
/// </param>
public abstract Lock MakeLock(System.String lockName);
/// <summary> 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.
/// </summary>
/// <param name="lockName">name of the lock to be cleared.
/// </param>
abstract public void ClearLock(System.String lockName);
}
}
|
