Module Lwt_gc

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:

Copy

DkSDKProject_DeclareAvailable(lwt
    CONSTRAINT "= 5.6.1"
    FINDLIBS lwt lwt.unix)
DkSDKProject_MakeAvailable(lwt)

Add the Findlib::lwt library to any desired targets in src/*/CMakeLists.txt:

Copy

target_link_libraries(YourPackage_YourLibraryName
     # ... existing libraries, if any ...
     Findlib::lwt)

Click your IDE's Build button

Not using DkSDK?

FIRST, do one or all of the following:

Run:
Copy
```
opam install lwt.5.6.1
```

Edit your dune-project and add:

Copy

(package
  (name YourExistingPackage)
  (depends
  ; ... existing dependenices ...
  (lwt (>= 5.6.1))))

Then run:

Copy

dune build *.opam # if this fails, run: dune build

Edit your <package>.opam file and add:

Copy

depends: [
  # ... existing dependencies ...
  "lwt" {>= "5.6.1"}
]

Then run:

Copy

opam install . --deps-only

FINALLY, add the lwt.unix library to any desired (library)and/or (executable) targets in your **/dune files:

Copy

(library
  (name YourLibrary)
  ; ... existing library options ...
  (libraries
    ; ... existing libraries ...
    lwt.unix))

(executable
  (name YourExecutable)
  ; ... existing executable options ...
  (libraries
    ; ... existing libraries ...
    lwt.unix))

This module offers a convenient way to add a finaliser launching a thread to a value, without having to use Lwt_unix.run in the finaliser.

val finalise : ``('a ->``unitLwt.t)`` -> 'a -> unit

finalise f x ensures f x is evaluated after x has been garbage collected. If f x yields, then Lwt will wait for its termination at the end of the program.

Note that f x is not called at garbage collection time, but later in the main loop.

val finalise_or_exit : ``('a ->``unitLwt.t)`` -> 'a -> unit

finalise_or_exit f x call f x when x is garbage collected or (exclusively) when the program exits.

Module Lwt_gc

Contents

Not using DkSDK?

More from the DkSDK Book