module Netmcore_ref: sig .. end
Shared mutable variables
type 'a sref
type 'a sref_descr
The marshallable descriptor of a reference
val sref : Netmcore.res_id -> 'a -> 'a sref
The shared version of ref: Creates a mutable shared variable in
the give memory pool
val assign : 'a sref -> 'a -> unit
assign sr x: Sets the contents of sr to a deep copy of x.
While performing the assignment the heap is write-locked,
and no other assign can run.
val deref_ro : 'a sref -> 'a
Dereferences the variable and returns the contents, comparable to
!. Note that this returns a value that lives in shared memory,
and there is no guarantee that this value still exists if
assign operations are done in parallel, and old version are
garbage-collected. If such values are accessed the program may
crash!
val deref_p : 'a sref -> ('a -> 'b) -> 'b
deref_p sr f: Runs f with the contents of sr, and returns
the result of f. While f is being executed, the current contents
are specially protected so that they cannot be garbage collected,
even if a parallel assign changes the current value of the
variable. (Suffix "_p" = pinning version.)
val deref_c : 'a sref -> 'a
deref_c sr: Returns a copy of the contents of sr. The copy is
created in normal memory. (Suffix "_c" = copying version.)
val heap : 'a sref -> Obj.t Netmcore_heap.heap
Returns the backing heap structure
val descr_of_sref : 'a sref -> 'a sref_descr
Returns the descriptor
val sref_of_descr : Netmcore.res_id -> 'a sref_descr -> 'a sref
Look up the reference for this descriptor
