Module Stdlib.Atomic
Contents
Instructions: Use this module in your project
In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:
Add the following to your project's
dependencies/CMakeLists.txt:DkSDKProject_DeclareAvailable(ocaml CONSTRAINT "= 4.14.0" FINDLIBS str unix runtime_events threads dynlink) DkSDKProject_MakeAvailable(ocaml)Add the
Findlib::ocamllibrary to any desired targets insrc/*/CMakeLists.txt:target_link_libraries(YourPackage_YourLibraryName # ... existing libraries, if any ... Findlib::ocaml)Click your IDE's
Buildbutton
Not using DkSDK?
FIRST, do one or all of the following:
Run:
opam install ocaml.4.14.0Edit your
dune-projectand add:(package (name YourExistingPackage) (depends ; ... existing dependenices ... (ocaml (>= 4.14.0))))Then run:
dune build *.opam # if this fails, run: dune buildEdit your
<package>.opamfile and add:depends: [ # ... existing dependencies ... "ocaml" {>= "4.14.0"} ]Then run:
opam install . --deps-only
FINALLY, add the library to any desired (library)and/or (executable) targets in your **/dune files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
))type``!'a t
An atomic (mutable) reference to a value of type 'a.
valmake :'a->'at
Create an atomic reference.
valget :'at->'a
Get the current value of the atomic reference.
valset :'at->'a->unit
Set a new value for the atomic reference.
valexchange :'at->'a->'a
Set a new value for the atomic reference, and return the current value.
valcompare_and_set :'at->'a->'a->bool
compare_and_set r seen v sets the new value of r to v only if its
current value is physically equal to seen -- the comparison and the
set occur atomically. Returns true if the comparison succeeded (so the
set happened) and false otherwise.
valfetch_and_add : ``intt->``int->int
fetch_and_add r n atomically increments the value of r by n, and
returns the current value (before the increment).
valincr : ``intt->unit
incr r atomically increments the value of r by 1.
valdecr : ``intt->unit
decr r atomically decrements the value of r by 1.
