Header menu logo FSharp.Data.Adaptive

Transaction Module

Module for transaction related functions. (e.g. transact)

Functions and values

Function or value Description

getCurrentTransaction ()

Full Usage: getCurrentTransaction ()

Parameters:
    () : unit

Returns: Transaction voption

Returns the currently running transaction or (if none) the current transaction for the calling thread

() : unit
Returns: Transaction voption

makeCurrent t

Full Usage: makeCurrent t

Parameters:
Returns: IDisposable
t : Transaction
Returns: IDisposable

transact action

Full Usage: transact action

Parameters:
    action : unit -> 'T

Returns: 'T

Executes a function "inside" a newly created transaction and commits the transaction.

action : unit -> 'T
Returns: 'T

useTransaction t action

Full Usage: useTransaction t action

Parameters:
Returns: 'T
t : Transaction
action : unit -> 'T
Returns: 'T

Type extensions

Type extension Description

this.MarkOutdated

Full Usage: this.MarkOutdated

Parameters:
    () : unit

Utility for marking adaptive object as outOfDate. Note that this function will actually enqueue the object to the current transaction and will fail if no current transaction can be found. However objects which are already outOfDate might also be "marked" when not having a current transaction.

Extended Type: IAdaptiveObject

() : unit

this.MarkOutdated

Full Usage: this.MarkOutdated

Parameters:
    fin : unit -> unit

Utility for marking adaptive object as outOfDate. Note that this function will actually enqueue the object to the current transaction and will fail if no current transaction can be found. However objects which are already outOfDate might Also be "marked" when not having a current transaction.

Extended Type: IAdaptiveObject

fin : unit -> unit

Type something to start searching.