File-src-minisql-platform-lock-ml-271785262.md

src/minisql/platform/lock.ml

Home · Files

Provides minisql platform lock facilities for this project.

Package: minisql.platform.lock

Reachable from entry: yes

Imports

• minisql/platform/file.ml as file_api → src/minisql/platform/file.ml
• minisql/platform/file_win32.ml as native → src/minisql/platform/file_win32.ml

Declarations

acquireExclusive

function acquireExclusive(file, failImmediately)

Acquires the exclusive. Inputs: file, failImmediately. Returns the produced value or propagates a structured error from validation or delegated operations.

Parameter	Type	Default	Description
file	dynamic	—	file value consumed by this operation.
failImmediately	dynamic	—	failImmediately value consumed by this operation.

View source

acquireShared

function acquireShared(file, failImmediately)

Acquires the shared. Inputs: file, failImmediately. Returns the produced value or propagates a structured error from validation or delegated operations.

Parameter	Type	Default	Description
file	dynamic	—	file value consumed by this operation.
failImmediately	dynamic	—	failImmediately value consumed by this operation.

View source

componentName

function componentName()

Performs the componentName operation for the minisql platform lock module. Takes no caller-supplied inputs. Returns the produced value or propagates a structured error from validation or delegated operations.

View source

fail

function fail(code, operation, message)

Performs the fail operation for the minisql platform lock module. Inputs: code, operation, message. Returns the produced value or propagates a structured error from validation or delegated operations.

Parameter	Type	Default	Description
code	dynamic	—	code value consumed by this operation.
operation	dynamic	—	operation value consumed by this operation.
message	dynamic	—	Human-readable message associated with the operation.

View source

• minisql.platform.lock.FileLock — struct

INVALID_ARGUMENT

const INVALID_ARGUMENT = 9001

Process-visible file-region locks used to coordinate database readers and

View source

isImplemented

function isImplemented()

Returns whether implemented satisfies the condition required by the minisql platform lock module. Takes no caller-supplied inputs. Returns a boolean result; invalid input or delegated failures are reported as structured errors.

View source

LOCK_CONFLICT

const LOCK_CONFLICT = 9007

Defines the lock conflict constant used by the minisql platform lock module.

View source

release

function release(lock)

Performs the release operation for the minisql platform lock module. Inputs: lock. Returns the operation result and propagates validation, storage, or platform errors unchanged.

Parameter	Type	Default	Description
lock	dynamic	—	lock value consumed by this operation.

View source

targetMilestone

function targetMilestone()

Performs the targetMilestone operation for the minisql platform lock module. Takes no caller-supplied inputs. Returns the produced value or propagates a structured error from validation or delegated operations.

View source