Files
libremetaverse/LibreMetaverse/Threading/Disposers/IUpgradeableLock.cs
2024-08-30 19:52:52 -05:00

53 lines
2.0 KiB
C#

/*
* Copyright (c) 2024, Sjofn LLC
* All rights reserved.
*
* - Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* - Neither the name of the openmetaverse.co nor the names
* of its contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
using System;
namespace LibreMetaverse.Threading.Disposers
{
/// <summary>
/// Interface implemented by ReaderWriterLocks' result to the
/// UpgradeableLock method.
/// </summary>
public interface IUpgradeableLock:
IDisposable
{
/// <summary>
/// Upgrades this lock to a write-lock, returning an object
/// so you can return to the upgradeable lock mode.
/// </summary>
IDisposable DisposableUpgrade();
/// <summary>
/// Upgrades this lock to an write lock, but it is
/// not possible to return to the upgradeable lock any more.
/// At the end, both the upgradeable and the write-lock
/// will be released.
/// </summary>
bool Upgrade();
}
}