Skip to content

Commit

Permalink
Merge pull request #337 from talex5/readme
Browse files Browse the repository at this point in the history
Minor README improvements
  • Loading branch information
talex5 authored Oct 4, 2022
2 parents e9ad2b0 + 56e6631 commit 4c743ba
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Platform support:

- Unix and macos: should be fully working using the libuv backend.
- Linux: can additionally use io_uring for better performance on recent kernels.
- Windows: should be mostly working - see [#123](https://github.com/ocaml-multicore/eio/issues/125) for remaining tasks.
- Windows: should be mostly working - see [#125](https://github.com/ocaml-multicore/eio/issues/125) for remaining tasks.
- MirageOS: waiting for [ocaml-freestanding](https://github.com/mirage/ocaml-freestanding) to be updated to OCaml 5.0.
- Browsers: waiting for [js_of_ocaml](https://github.com/ocsigen/js_of_ocaml/issues/1088) to be updated to OCaml 5.0.

Expand All @@ -92,7 +92,7 @@ Feature status:
- Multicore support: Working.
- Networking: Clients and servers using TCP, UDP and Unix domain sockets work.
- File-systems: Can create files and directories, load, save, parse, etc. Most other operations missing.
- Spawning sub-processes: Not implemented yet.
- Spawning sub-processes: Not implemented yet (see [#330](https://github.com/ocaml-multicore/eio/pull/330)).

See [Awesome Multicore OCaml][] for links to work migrating other projects to Eio.

Expand Down Expand Up @@ -366,13 +366,6 @@ Every switch also creates a new cancellation context.
You can use `Switch.fail` to mark the switch as failed and cancel all fibers within it.
The exception (or exceptions) passed to `fail` will be raised by `run` when the fibers have exited.

You can also use `Fiber.fork_sub` to create a child sub-switch.
Turning off the parent switch will also turn off the child switch, but turning off the child doesn't disable the parent.

For example, a web-server might use one switch for the whole server and then create one sub-switch for each incoming connection.
This allows you to end all fibers handling a single connection by turning off that connection's switch,
or to exit the whole application using the top-level switch.

## Design Note: Results vs Exceptions

The OCaml standard library uses exceptions to report errors in most cases.
Expand Down

0 comments on commit 4c743ba

Please sign in to comment.