romanchechyotkin / nats.ocaml Goto Github PK

View Code? Open in Web Editor NEW

6.0 1.0 1.0 44 KB

OCaml client for NATS, the cloud native messaging system.

License: Apache License 2.0

OCaml 100.00%

client library nats ocaml ocaml-library open-source

nats.ocaml's Introduction

NATS - OCaml Client

OCaml client for the NATS messaging system.

USAGE

Warning

In active development!

References

Contributing

nats_ocaml is an open-source project and contributions are very welcome! Let's make a greate ecosystem together! Please make sure to read contributing guide

nats.ocaml's People

Contributors

Stargazers

Watchers

Forkers

dx3mod

nats.ocaml's Issues

GITHUB ACTIONS

Release tag/build

Design Subscriptions

A subscription system needs to be designed. How it should look like and how it should work.

Ideas that come to mind

Callbacks. But how to make it work in the background? And that requires a mutable state
```
 client#sub ~subject"FOO.*" (fun event -> ...)
```
Blocking listener (bad idea) something like
```
 client#listen (fun any_event -> ...)
```

A real-world example would be nice. And a list of tasks that need to be covered.

Improve library API

Some suggestions for improving library's API.

Labeled functions

(* now *)
Client.connect host port
(* with labeled arguments *)
Client.connect ~host ~port ()

You can also set defaults for them

(* now *)
let connect host port = ...
(* with defaults *)
let connect ?(host = default_host) ?(port = default_port) () = ...

or use modules

let conn = Client.connect (module struct 
  let host = ..
  let port = ...
 end)

with_connect

Automatically close a resource

(* now *) 
let conn = Client.connect ()
...
Client.close conn

(* with with_connect *)
Client.with_connect ... @@ fun conn -> 
  ...

first-class modules or objects for connection

(* object *)
Client.with_connect ~host ~port (fun conn -> 
  conn#pub "FOO")

(* first-class module *)
Client.with_connect ~host ~port (fun (module Conn) -> 
  Conn.pub "FOO")

signature for abstraction

(* now *)
type 'a t = { sockaddr : sockaddr; socket : Lwt_unix.file_descr }
(* should be *)
type 'a t

Module signatures hide internal implementation.

unsafe

In some cases you can use unsafe functions (read this)

(* now *)
let msg : bytes = Bytes.of_string message 
(* better performance *)  
let msg  = Bytes.unsafe_of_string message

print_endline

🌵

monadic syntax

Prefer monadic syntax let*, let+, or ppx_lwt.

Implement MSG protocol message

https://docs.nats.io/reference/reference-protocols/nats-protocol#msg