Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/suprematic/otplike

Erlang/OTP like processes and behaviours for Clojure on top of core.async
https://github.com/suprematic/otplike

Last synced: 3 months ago
JSON representation

Erlang/OTP like processes and behaviours for Clojure on top of core.async

Host: GitHub
URL: https://github.com/suprematic/otplike
Owner: suprematic
Created: 2016-08-09T16:21:38.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-02-19T19:50:57.000Z (9 months ago)
Last Synced: 2024-07-25T00:37:01.469Z (4 months ago)
Language: Clojure
Homepage:
Size: 662 KB
Stars: 212
Watchers: 12
Forks: 5
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: License_EPL_1.0.html

Awesome Lists containing this project

README

        # otplike

[![Build Status][1]][2]

_otplike_ is a framework built on top of [_core.async_][3]. It emulates basic

[_Erlang/OTP_][4] concepts, such as processes, process linking, monitoring,

standard behaviours.

## Rationale

Although _core.async_ provides a solid foundation for asynchronous

applications, our experience shows that there is a need in higher level

system building blocks.

It appears that certain ideas can be taken from Erlang/OTP and implemented

on top of _core.async_.

The `gen_server` equivalent is used to serialize sync/async access to state

and ensure that possibly inconsistent state data will be discarded in case

of a crash.

Process linking/monitoring improves crash/error propagation and supervision

covers recovery. In addition process tracing facility helps a lot with

application debugging and profiling.

It is obvious that due to JVM limitations otplike cannot replace Erlang/OTP

and otplike will `NEVER` be seen as Erlang/OTP alternative.

## Example

### Echo Server

```clojure

(require '[otplike.process :as process :refer [!]])

(process/proc-defn server []

  (println "server: waiting for messages...")

  ; wait for messages

  (process/receive!

    [from msg]

    (do

      (println "server: got" msg)

      ; send response

      (! from [(process/self) msg])

      (recur))

    :stop

    ; exit receive loop

    (println "server: stopped")))

(process/proc-defn client []

  ; spawn process

  (let [pid (process/spawn server)]

    ; send message to it

    (! pid [(process/self) :hello])

    ;wait for response

    (process/receive!

      [pid msg]

      (println "client: got" msg))

    ; ask spawned process to stop

    (! pid :stop)))

(process/spawn client)

```

More examples are available under the /examples directory.

## Releases and Dependency Information

[![Clojars Project][5]][6]

[All Released Versions][7]

_Leiningen_ dependency information:

    [otplike "0.6.0-alpha"]

## Documentation

* [API docs][8]

* [Examples][9]

## Other materials

* [EuroClojure 2017 presentation][12]

## Known issues

* A chain of N processes, when each next process is created by the previous

  one, holds amount of memory proportional to N until the **last** process' exit

## Plans

* ClojureScript compatibility

* `application` behaviour and related features as configuration

* "Simple" supervisor (analogous to `simple_one_for_one` in Erlang) as

  a separate module

* Tracing and introspection

* More advanced examples/tutorial

## Contributing

Please use the project's GitHub issues page for all questions, ideas,

etc. Pull requests are welcome. See the project's GitHub contributors

page for a list of contributors.

## License

Copyright © 2017 [SUPREMATIC][10] and contributors.

Distributed under the Eclipse Public License v1.0,

the same as Clojure. License file is available under the project root.

## Changelog

* Release 0.6.0-alpha on 20.07.2019 [NOTES][17]

* Release 0.5.0-alpha on 07.12.2018 [NOTES][16]

* Release 0.4.0-alpha on 15.04.2018 [NOTES][15]

* Release 0.3.0-alpha on 28.11.2017 [NOTES][14]

* Release 0.2.1-alpha on 11.08.2017 [NOTES][13]

* Release 0.2.0-alpha on 17.05.2017 [NOTES][11]

* Release 0.1.0-SNAPSHOT on 15.08.2016

[1]: https://travis-ci.org/suprematic/otplike.svg?branch=master

[2]: https://travis-ci.org/suprematic/otplike

[3]: https://github.com/clojure/core.async

[4]: http://www.erlang.org/

[5]: https://img.shields.io/clojars/v/otplike.svg

[6]: https://clojars.org/otplike

[7]: https://clojars.org/otplike

[8]: https://suprematic.github.io/otplike/api/0.6.0-alpha/index.html

[9]: https://github.com/suprematic/otplike/tree/master/examples/otplike/example

[10]: http://suprematic.net/

[11]: https://github.com/suprematic/otplike/releases/tag/0.2.0

[12]: https://suprematic.github.io/otplike/euroclojure2017/

[13]: https://github.com/suprematic/otplike/releases/tag/0.2.1

[14]: https://github.com/suprematic/otplike/releases/tag/0.3.0

[15]: https://github.com/suprematic/otplike/releases/tag/0.4.0-alpha

[16]: https://github.com/suprematic/otplike/releases/tag/0.5.0-alpha

[17]: https://github.com/suprematic/otplike/releases/tag/0.6.0-alpha