https://github.com/lambdaisland/funnel-client
Websocket client for Funnel + examples
https://github.com/lambdaisland/funnel-client
Last synced: 3 months ago
JSON representation
Websocket client for Funnel + examples
- Host: GitHub
- URL: https://github.com/lambdaisland/funnel-client
- Owner: lambdaisland
- License: mpl-2.0
- Created: 2020-06-24T10:47:08.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-28T02:42:22.000Z (over 2 years ago)
- Last Synced: 2025-08-23T12:22:14.681Z (4 months ago)
- Language: Clojure
- Size: 49.8 KB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# funnel-client
[](https://cljdoc.org/d/com.lambdaisland/funnel-client) [](https://clojars.org/com.lambdaisland/funnel-client)
Clojure and ClojureScript client libraries for [Funnel](https://github.com/lambdaisland/funnel)
## Lambda Island Open Source
funnel-client is part of a growing collection of quality Clojure libraries created and maintained
by the fine folks at [Gaiwan](https://gaiwan.co).
Pay it forward by [becoming a backer on our Open Collective](http://opencollective.com/lambda-island),
so that we may continue to enjoy a thriving Clojure ecosystem.
You can find an overview of our projects at [lambdaisland/open-source](https://github.com/lambdaisland/open-source).
## Installation
To use the latest release, add the following to your `deps.edn` ([Clojure CLI](https://clojure.org/guides/deps_and_cli))
```
com.lambdaisland/funnel-client {:mvn/version "0.0.28"}
```
or add the following to your `project.clj` ([Leiningen](https://leiningen.org/))
```
[com.lambdaisland/funnel-client "0.0.28"]
```
## Rationale
To use Funnel all you need is a websocket connection and a way to read and write
Transit. As such we originally envisaged people would use their websocket
connection of choice to connect to Funnel directly.
To reduce the boilerplate that people have to write, and to encode some best
practice patterns, we decided to make these clients available. There's a Clojure
and a ClojureScript client, which both implement the same high level API, to the
extent possible, providing that they sit upon very different websocket
implementations and platforms.
## Usage
At it simplest all you need is:
``` clojure
(require '[lambdaisland.funnel-client :as funnel-client])
(def conn (funnel-client/connect {:on-message prn}))
;; query funnel to get the whoami map of every connected client
(funnel-client/send conn {:funnel/query true})
```
See the [Funnel README](https://github.com/lambdaisland/funnel) to understand
how to use the Funnel protocol.
`connect` takes the following options
- `:uri` defaults to `ws://localhost:44220`, or if using the ClojureScript client and the current origin is https, then it will use `wss` (SSL)
- `:on-open` / `:on-error` / `:on-close` / `:on-message` callbacks, these all take two arguments, the connection itself, and a handshake/error/message
- `:whoami` map or atom containing the Funnel whoami map. If omitted will use the `funnel-client/whoami` global atom.
If using an atom as a `:whoami` then changing the contents of the atom will
automatically re-announce the identifying information to Funnel.
### Exclusions
If you only use one of the two clients, you may want to exclude the dependencies needed for the other client.
For ClojureScript we pull in
- `com.cognitect/transit-cljs`
- `lambdaisland/glogi`
On Clojure we make use of
- `io.pedestal/pedestal.log`
- `org.java-websocket/Java-WebSocket`
- `com.cognitect/transit-clj`
## Contributing
Everyone has a right to submit patches to funnel-client, and thus become a contributor.
Contributors MUST
- adhere to the [LambdaIsland Clojure Style Guide](https://nextjournal.com/lambdaisland/clojure-style-guide)
- write patches that solve a problem. Start by stating the problem, then supply a minimal solution. `*`
- agree to license their contributions as MPL 2.0.
- not break the contract with downstream consumers. `**`
- not break the tests.
Contributors SHOULD
- update the CHANGELOG and README.
- add tests for new functionality.
If you submit a pull request that adheres to these rules, then it will almost
certainly be merged immediately. However some things may require more
consideration. If you add new dependencies, or significantly increase the API
surface, then we need to decide if these changes are in line with the project's
goals. In this case you can start by [writing a pitch](https://nextjournal.com/lambdaisland/pitch-template),
and collecting feedback on it.
`*` This goes for features too, a feature needs to solve a problem. State the problem it solves, then supply a minimal solution.
`**` As long as this project has not seen a public release (i.e. is not on Clojars)
we may still consider making breaking changes, if there is consensus that the
changes are justified.
## License
Copyright © 2020-2021 Arne Brasseur and Contributors
Licensed under the term of the Mozilla Public License 2.0, see LICENSE.