AsyncReaderWriterLockUpgradeableReader Interface

    Package: @esfx/async-readerwriterlock
    Declaration
    export interface AsyncReaderWriterLockUpgradeableReader extends UpgradeableLockHandle<AsyncReaderWriterLockUpgradeableReader, AsyncReaderWriterLockWriter> 
    Inheritance
    UpgradeableLockHandle<AsyncReaderWriterLockUpgradeableReader, AsyncReaderWriterLockWriter>
    AsyncReaderWriterLockUpgradeableReader
    Inherited Members
    upgrade(cancelable)

    Properties

    owner

    Gets the AsyncReaderWriterLock that owns this object.

    Declaration
    readonly owner: AsyncReaderWriterLock;
    Property Value
    AsyncReaderWriterLock

    Methods

    createWriter()

    Creates a AsyncReaderWriterLockWriter that can be used to take and release "write" locks on a resource.

    Declaration
    createWriter(): AsyncReaderWriterLockWriter;
    Returns
    AsyncReaderWriterLockWriter

    upgrade(cancelable)

    Asynchronously waits for and takes a write lock on a resource.

    Declaration
    upgrade(cancelable?: Cancelable): Promise<AsyncReaderWriterLockWriter>;
    Parameters
    cancelable
    Cancelable

    A Cancelable used to cancel the request.

    Returns
    Promise<AsyncReaderWriterLockWriter>

    Generated by DocFX