Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README example to use dune #162

Merged
merged 1 commit into from
Sep 17, 2019
Merged

Update README example to use dune #162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 12 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ See [LICENSE.md](LICENSE.md) for details.
## Contents

<!-- vim-markdown-toc GFM -->

* [Overview](#overview)
* [Status](#status)
* [Installing](#installing)
Expand Down Expand Up @@ -232,29 +233,26 @@ let () =
<img src="./diagrams/ping.svg"/>
</p>

If you're building with jbuilder, here's a suitable `jbuild` file:
Here's a suitable `dune` file to compile the schema file and then the generated OCaml files
(which you can now delete from your source directory):

```
(jbuild_version 1)
(executable (
(name main)
(libraries (capnp-rpc-lwt capnp-rpc-unix logs.fmt))
(flags (:standard -w -53-55))
))
(executable
(name main)
(libraries capnp-rpc-lwt capnp-rpc-unix logs.fmt)
(flags (:standard -w -53-55)))
(rule
((targets (echo_api.ml echo_api.mli))
(deps (echo_api.capnp))
(action (run capnpc -o ocaml ${<}))))
(targets echo_api.ml echo_api.mli)
(deps echo_api.capnp)
(action (run capnpc -o ocaml %{deps})))
```

The service is now usable:

```bash
$ opam install capnp-rpc-unix conf-capnproto
$ jbuilder build --dev main.exe
$ ./_build/default/main.exe
$ opam depext -i capnp-rpc-unix conf-capnproto
$ dune exec ./main.exe
Got reply "echo:foo"
```

Expand All @@ -278,9 +276,6 @@ interface Echo {
This version of the protocol adds a `heartbeat` method.
Instead of returning the text directly, it will send it to a callback at regular intervals.

Run `capnp compile` again to update the generated files
(if you're using the jbuild file then this will happen automatically and you should delete the generated `echo_api.ml` and `echo_api.mli` files from the source directory instead).

The new `heartbeat_impl` method looks like this:

```ocaml
Expand Down