package lwt

  1. Overview
  2. Docs
Promises and event-driven I/O

Install 

dune-project
 Dependency

github.com Readme MIT License Edit opam file Versions (27)

Authors

  1. J
    Jérôme Vouillon
  2. J
    Jérémie Dimino

Maintainers

  1. R
    Raphaël Proust <code@bnwr.net>
  2. Anton Bachin

Sources

5.8.0.tar.gz
md5=2682558f405ab7c8638eeb16d0f9f46f
sha512=7f6548a1b1dbfdbc98d9352151ca7be97fa2ab63dbcc429208ce8d08308eee13f7fce31e0cca53f8880233959a60212d622270dd51bf164c3ee272f179769bd9

Description

A promise is a value that may become determined in the future.

Lwt provides typed, composable promises. Promises that are resolved by I/O are resolved by Lwt in parallel.

Meanwhile, OCaml code, including code creating and waiting on promises, runs in a single thread by default. This reduces the need for locks or other synchronization primitives. Code can be run in parallel on an opt-in basis.

Published: 24 Oct 2024

README

Lwt

version GitHub Actions status

Lwt is a concurrent programming library for OCaml. It provides a single data type: the promise, which is a value that will become determined in the future. Creating a promise spawns a computation. When that computation is I/O, Lwt runs it in parallel with your OCaml code.

OCaml code, including creating and waiting on promises, is run in a single thread by default, so you don't have to worry about locking or preemption. You can detach code to be run in separate threads on an opt-in basis.

Here is a simplistic Lwt program which requests the Google front page, and fails if the request is not completed in five seconds:

open Lwt.Syntax

let () =
  let request =
    let* addresses = Lwt_unix.getaddrinfo "google.com" "80" [] in
    let google = Lwt_unix.((List.hd addresses).ai_addr) in

    Lwt_io.(with_connection google (fun (incoming, outgoing) ->
      let* () = write outgoing "GET / HTTP/1.1\r\n" in
      let* () = write outgoing "Connection: close\r\n\r\n" in
      let* response = read incoming in
      Lwt.return (Some response)))
  in

  let timeout =
    let* () = Lwt_unix.sleep 5. in
    Lwt.return None
  in

  match Lwt_main.run (Lwt.pick [request; timeout]) with
  | Some response -> print_string response
  | None -> prerr_endline "Request timed out"; exit 1

(* ocamlfind opt -package lwt.unix -linkpkg example.ml && ./a.out *)

In the program, functions such as Lwt_io.write create promises. The let* ... in construct is used to wait for a promise to become determined; the code after in is scheduled to run in a "callback." Lwt.pick races promises against each other, and behaves as the first one to complete. Lwt_main.run forces the whole promise-computation network to be executed. All the visible OCaml code is run in a single thread, but Lwt internally uses a combination of worker threads and non-blocking file descriptors to resolve in parallel the promises that do I/O.


Overview

Lwt compiles to native code on Linux, macOS, Windows, and other systems. It's also routinely compiled to JavaScript for the front end and Node by js_of_ocaml.

In Lwt,

  • The core library Lwt provides promises...
  • ...and a few pure-OCaml helpers, such as promise-friendly mutexes, condition variables, and mvars.
  • There is a big Unix binding, Lwt_unix that binds almost every Unix system call. A higher-level module Lwt_io provides nice I/O channels.
  • Lwt_process is for subprocess handling.
  • Lwt_preemptive spawns system threads.
  • The PPX syntax allows using all of the above without going crazy!
  • There are also some other helpers, such as Lwt_react for reactive programming. See the table of contents on the linked manual pages!

Installing

  1. Use your system package manager to install a development libev package. It is often called libev-dev or libev-devel.
  2. opam install conf-libev lwt

Documentation

We are currently working on improving the Lwt documentation (drastically; we are rewriting the manual). In the meantime:

  • The current manual can be found here.
  • Mirage has a nicely-written Lwt tutorial.
  • An example of a simple server written in Lwt.
  • Concurrent Programming with Lwt is a nice source of Lwt examples. They are translations of code from the excellent Real World OCaml, but are just as useful if you are not reading the book.

Note: much of the current manual refers to 'a Lwt.t as "lightweight threads" or just "threads." This will be fixed in the new manual. 'a Lwt.t is a promise, and has nothing to do with system or preemptive threads.


Contact

Open an issue, visit Discord chat, ask on discuss.ocaml.org, or on Stack Overflow.

Release announcements are made in /r/ocaml, and on discuss.ocaml.org. Watching the repo for "Releases only" is also an option.


Contributing

  • CONTRIBUTING.md contains tips for working on the code, such as how to check the code out, how review works, etc. There is also a high-level outline of the code base.
  • Ask us anything, whether it's about working on Lwt, or any question at all about it :)
  • The documentation always needs proofreading and fixes.
  • You are welcome to pick up any other issue, review a PR, add your opinion, etc.
  • Any feedback is welcome, including how to make contributing easier!

Libraries to use with Lwt

Dependencies (5)

  1. ocplib-endian
  2. dune-configurator
  3. cppo build & >= "1.1.0"
  4. ocaml >= "4.08"
  5. dune >= "1.12"

Dev Dependencies (2)

  1. odoc with-doc & >= "2.3.0"
  2. ocamlfind dev & >= "1.7.3-1"

  1. 0install >= "2.15.1"
  2. aches-lwt
  3. activitypub
  4. albatross
  5. alcotest-lwt
  6. alcotest-mirage
  7. ambient-context-lwt
  8. amqp-client >= "1.1.0"
  9. amqp-client-lwt
  10. angstrom-lwt-unix >= "0.11.0"
  11. anthill
  12. anycache-lwt
  13. archi-lwt
  14. arp
  15. awa-mirage
  16. aws-lwt
  17. aws-s3-lwt < "4.4.0" | >= "4.8.1"
  18. awsm-lwt
  19. azure-cosmos-db
  20. balancer
  21. bastet_lwt
  22. bimage-lwt
  23. bistro
  24. brisk-reconciler
  25. brozip
  26. builder
  27. builder-web
  28. bun >= "0.3.3"
  29. cachet-lwt
  30. calculon
  31. caldav
  32. camltc
  33. canary
  34. capnp-rpc-lwt < "2.0"
  35. capnp-rpc-unix < "2.1"
  36. caqti-lwt
  37. caqti-mirage
  38. carton < "1.0.0"
  39. carton-git
  40. carton-lwt
  41. catala-format >= "0.2.0"
  42. cf-lwt
  43. chamelon
  44. chamelon-unix
  45. chamo
  46. charrua-client
  47. charrua-unix
  48. chess_com_api
  49. clz
  50. cmdtui-lambda-term
  51. coap
  52. coap-server-lwt
  53. cohttp-curl-lwt
  54. cohttp-lwt
  55. cohttp-lwt-jsoo
  56. cohttp-lwt-unix
  57. cohttp-mirage
  58. cohttp-server-lwt-unix
  59. comby
  60. comby-semantic
  61. conan-lwt
  62. conduit-lwt
  63. conduit-lwt-unix
  64. cowabloga
  65. crunch
  66. cstruct-lwt
  67. csv-lwt
  68. ctypes >= "0.15.0" & < "0.21.1"
  69. ctypes-foreign >= "0.21.1"
  70. curl_lwt
  71. current
  72. current-albatross-deployer
  73. current_docker
  74. current_examples
  75. current_git
  76. current_github
  77. current_gitlab
  78. current_ocluster
  79. current_rpc
  80. current_slack
  81. current_web
  82. DkSDKFFIOCaml_Std
  83. dap
  84. data-encoding < "0.1.1"
  85. devkit >= "1.2"
  86. distributed-lwt
  87. dkim-bin < "0.8.0"
  88. dkim-lwt-unix
  89. dkim-mirage
  90. dlm
  91. dns-certify
  92. dns-cli
  93. dns-client < "7.0.3"
  94. dns-client-lwt
  95. dns-client-mirage
  96. dns-forward
  97. dns-forward-lwt-unix
  98. dns-lwt
  99. dns-mirage
  100. dns-resolver
  101. dns-server
  102. dns-stub
  103. dnssd
  104. docker_hub
  105. docteur >= "0.0.2"
  106. docteur-solo5
  107. docteur-unix >= "0.0.5"
  108. doi2bib
  109. dream
  110. dream-httpaf
  111. dream-pure
  112. dream-serve
  113. dropbox
  114. dune >= "3.17.2"
  115. dune-rpc-lwt
  116. earlybird
  117. elasticsearch-cli
  118. emoji >= "2.0.0"
  119. equinoxe
  120. ethernet
  121. ez_api >= "1.2.0"
  122. ezcurl-lwt
  123. ezjs_min < "0.2"
  124. ezjsonm-lwt
  125. ezresto
  126. ezresto-directory >= "0.5"
  127. faraday-lwt
  128. faraday-lwt-unix
  129. fat-filesystem
  130. fiber-lwt
  131. fsevents-lwt
  132. fswatch_lwt
  133. fuseau-lwt
  134. gdbprofiler
  135. git
  136. git-cohttp
  137. git-cohttp-unix
  138. git-mirage
  139. git-paf
  140. git-unix >= "3.2.0"
  141. github
  142. github-hooks
  143. github-unix >= "4.4.0"
  144. gitlab-unix
  145. gitlab_pipeline_notifier
  146. gluten-lwt
  147. gluten-lwt-unix < "0.4.0"
  148. gluten-mirage < "0.4.0"
  149. graphql-lwt
  150. gremlin
  151. grpc-lwt
  152. guardian
  153. gufo
  154. h1
  155. h1-lwt-unix
  156. h2-lwt
  157. h2-lwt-unix < "0.10.0"
  158. h2-mirage
  159. happy-eyeballs-lwt
  160. happy-eyeballs-mirage
  161. hidapi-lwt
  162. hiredis >= "0.6"
  163. hl_yaml
  164. hockmd
  165. http-lwt-client
  166. http-mirage-client
  167. http-multipart-formdata >= "2.0.0" & < "3.0.0"
  168. httpaf-lwt-unix
  169. httpun-lwt
  170. httpun-mirage
  171. httpun-ws-lwt
  172. hvsock
  173. i3ipc
  174. influxdb-lwt
  175. inotify >= "2.4"
  176. inquire < "0.3.0"
  177. interface-prime-lwt
  178. ip2location
  179. ip2locationio
  180. ip2whois
  181. ipv6-multicast-lwt
  182. irc-client-lwt
  183. irc-client-lwt-ssl
  184. irc-client-tls
  185. irmin
  186. irmin-bench
  187. irmin-chunk
  188. irmin-cli
  189. irmin-client
  190. irmin-containers
  191. irmin-fs
  192. irmin-git
  193. irmin-graphql
  194. irmin-http
  195. irmin-indexeddb
  196. irmin-layers
  197. irmin-mirage-git
  198. irmin-mirage-graphql
  199. irmin-pack
  200. irmin-server
  201. irmin-test
  202. irmin-unix
  203. irmin-watcher
  204. joolog
  205. jose < "0.9.0"
  206. js_of_ocaml-lwt >= "3.5.0"
  207. jsoo_broadcastchannel
  208. jsoo_storage
  209. jupyter
  210. jupyter-kernel
  211. kafka < "0.5"
  212. kafka_lwt
  213. kappa-library
  214. ke >= "0.5"
  215. kinetic-client
  216. kubecaml
  217. lambda-runtime
  218. lambda-term
  219. lambda_streams_lwt
  220. launchd
  221. ldp
  222. learn-ocaml
  223. learn-ocaml-client
  224. ledgerwallet >= "0.4.0"
  225. letsencrypt
  226. letsencrypt-app
  227. letsencrypt-dns
  228. letters
  229. lichess_api
  230. links >= "0.9.1"
  231. linol-lwt
  232. llama
  233. lru_cache
  234. lwt-canceler
  235. lwt-dllist
  236. lwt-exit
  237. lwt-parallel
  238. lwt-pipe
  239. lwt-pipeline
  240. lwt-watcher
  241. lwt_camlp4
  242. lwt_domain
  243. lwt_eio
  244. lwt_glib
  245. lwt_log
  246. lwt_ppx
  247. lwt_react
  248. lwt_retry
  249. lwt_ssl
  250. mariadb >= "1.2.0"
  251. markup = "0.7.6"
  252. markup-lwt
  253. mdx
  254. mechaml
  255. mehari-lwt-unix
  256. mehari-mirage
  257. memtrace-mirage
  258. metrics-influx
  259. metrics-lwt
  260. metrics-unix
  261. mimic
  262. mindstorm-lwt
  263. mirage < "4.0.0"
  264. mirage-block >= "2.0.1"
  265. mirage-block-ccm
  266. mirage-block-combinators
  267. mirage-block-lwt
  268. mirage-block-partition
  269. mirage-block-ramdisk
  270. mirage-block-solo5
  271. mirage-block-unikraft
  272. mirage-block-unix >= "2.14.2"
  273. mirage-block-xen
  274. mirage-channel >= "4.0.1"
  275. mirage-channel-lwt
  276. mirage-clock-lwt
  277. mirage-clock-unix < "4.2.0"
  278. mirage-console-lwt
  279. mirage-crypto-rng < "0.11.3"
  280. mirage-crypto-rng-lwt
  281. mirage-crypto-rng-mirage
  282. mirage-device >= "2.0.0"
  283. mirage-flow >= "3.0.0"
  284. mirage-flow-combinators
  285. mirage-flow-lwt
  286. mirage-flow-unix
  287. mirage-fs >= "4.0.0"
  288. mirage-fs-lwt
  289. mirage-kv >= "3.0.1"
  290. mirage-kv-lwt
  291. mirage-kv-unix
  292. mirage-net >= "4.0.0"
  293. mirage-net-lwt
  294. mirage-net-macosx
  295. mirage-net-solo5
  296. mirage-net-unikraft
  297. mirage-net-unix
  298. mirage-net-xen
  299. mirage-profile
  300. mirage-protocols >= "7.0.0"
  301. mirage-protocols-lwt
  302. mirage-qubes
  303. mirage-qubes-ipv4
  304. mirage-runtime
  305. mirage-sleep
  306. mirage-solo5
  307. mirage-stack = "3.0.0"
  308. mirage-stack-lwt
  309. mirage-time >= "3.0.0"
  310. mirage-time-lwt
  311. mirage-time-unix
  312. mirage-types-lwt
  313. mirage-unikraft
  314. mirage-unix
  315. mirage-vnetif
  316. mirage-xen
  317. monorobot
  318. moonpool-lwt
  319. mqtt
  320. mrmime >= "0.5.0"
  321. multipart-form-data
  322. multipart_form >= "0.2.0" & < "0.4.0"
  323. multipart_form-cohttp-lwt < "0.6.0"
  324. multipart_form-lwt
  325. mwt
  326. naboris
  327. nbd >= "4.0.3"
  328. nbd-tool
  329. nbd-unix
  330. nocrypto
  331. nottui-lwt
  332. nproc
  333. nsq
  334. obuilder
  335. obus >= "1.2.1"
  336. ocluster
  337. ocluster-api
  338. ocluster-worker
  339. ocplib-resto
  340. ocsigenserver
  341. ocsipersist
  342. ocsipersist-dbm
  343. ocsipersist-lib
  344. ocsipersist-pgsql
  345. ocsipersist-sqlite
  346. octez-distributed-lwt-internal
  347. octez-internal-libs
  348. octez-l2-libs
  349. octez-libs
  350. octez-proto-libs
  351. octez-protocol-compiler
  352. octez-proxy-server
  353. octez-rpc-process
  354. octez-shell-libs
  355. octez-smart-rollup-wasm-benchmark-lib
  356. oframl
  357. ojs_base
  358. omigrate
  359. oneffs
  360. opencage
  361. opentelemetry-client-cohttp-lwt
  362. opentelemetry-cohttp-lwt >= "0.4"
  363. opentelemetry-lwt
  364. opium
  365. opium-graphql
  366. opium_kernel
  367. opomodoro
  368. order-i3-xfce
  369. ordma
  370. oskel >= "0.3.0"
  371. ounit-lwt < "2.2.0"
  372. ounit2-lwt
  373. owork
  374. ozulip
  375. paf
  376. paf-cohttp
  377. passage
  378. pcap-format < "0.5.2"
  379. petrol
  380. pgn_parser
  381. pgx_lwt
  382. pgx_lwt_mirage
  383. pgx_lwt_unix < "2.0"
  384. piaf < "0.2.0"
  385. picos >= "0.3.0" & < "0.5.0"
  386. picos_lwt
  387. picos_meta
  388. plebeia >= "2.0.0"
  389. plist-xml-lwt
  390. plotkicadsch
  391. ppx_defer >= "0.4.0"
  392. ppx_deriving_rpc
  393. ppx_rapper_lwt
  394. proc-smaps
  395. prof_spacetime
  396. prometheus
  397. prometheus-app
  398. promise_jsoo_lwt
  399. protocol-9p
  400. protocol-9p-unix
  401. proton
  402. qcow
  403. qcow-stream
  404. qcow-tool
  405. qcow-types
  406. qfs >= "0.5"
  407. quests
  408. rawlink < "2.1"
  409. rawlink-lwt
  410. rdf_json_ld
  411. rdf_lwt
  412. redis-lwt
  413. reparse-lwt
  414. reparse-lwt-unix
  415. resource-pooling
  416. resp
  417. resp-mirage >= "0.10.0"
  418. resp-unix >= "0.10.0"
  419. resto
  420. resto-cohttp-client >= "0.4"
  421. resto-cohttp-self-serving-client
  422. resto-cohttp-server >= "0.4" & < "0.6" | >= "0.9"
  423. resto-directory >= "0.4"
  424. riak
  425. ringo-lwt
  426. river
  427. rock
  428. rpclib-js
  429. rpclib-lwt
  430. SZXX < "4.0.0"
  431. sanddb
  432. scgi
  433. sendmail-lwt
  434. sendmail-mirage
  435. serial
  436. server-reason-react
  437. session-cohttp-lwt
  438. session-cookie-lwt
  439. session-postgresql-lwt
  440. sessions
  441. shared-block-ring
  442. shared-memory-ring-lwt
  443. sherlodoc
  444. sihl < "0.2.0"
  445. slack
  446. slacko
  447. slipshow
  448. smtml >= "0.7.0"
  449. speed
  450. spin < "0.8.0"
  451. spoke
  452. stk
  453. stog
  454. swapfs
  455. syguslib-utils
  456. syndic >= "1.4" & < "1.6.0"
  457. tar-mirage
  458. tar-unix
  459. tcpip
  460. telegraml
  461. terminus
  462. testo-lwt
  463. tezos-base >= "16.0"
  464. tezos-clic >= "16.0"
  465. tezos-crypto >= "16.0"
  466. tezos-crypto-dal
  467. tezos-error-monad >= "16.0"
  468. tezos-lwt-result-stdlib
  469. tezos-p2p = "12.3"
  470. tezos-protocol-environment
  471. tezos-proxy >= "17.3"
  472. tezos-stdlib
  473. tezos-stdlib-unix >= "16.0"
  474. tezos-test-helpers >= "12.3"
  475. tezos-wasmer
  476. tezos-webassembly-interpreter-extra
  477. tezt
  478. tidy_email
  479. timmy-lwt
  480. tls >= "0.10.6" & < "0.16.0"
  481. tls-lwt
  482. tls-mirage
  483. tube
  484. tuntap
  485. twirp_cohttp_lwt_unix
  486. uring
  487. uspf
  488. uspf-lwt
  489. uspf-mirage
  490. utop
  491. uwt
  492. vchan
  493. vchan-unix
  494. vchan-xen
  495. vercel
  496. vhd-format-lwt
  497. vmnet
  498. vpnkit
  499. vue-jsoo < "0.3"
  500. wayland < "2.0"
  501. webauthn
  502. xen-evtchn
  503. xen-evtchn-unix
  504. xen-gnt
  505. xen-gnt-unix
  506. xenstore
  507. xenstore-tool
  508. xenstore_transport
  509. xlsx2csv
  510. yocaml_git
  511. yocaml_unix < "2.0.0"
  512. zarr-lwt
  513. zmq-lwt >= "5.2.1"

Conflicts

None