https://github.com/taoensso/sente

Realtime web comms library for Clojure/Script
https://github.com/taoensso/sente

ajax async clojure clojurescript edn epl http-kit taoensso transit websockets

Last synced: about 2 hours ago
JSON representation

Realtime web comms library for Clojure/Script

• Host: GitHub
• URL: https://github.com/taoensso/sente
• Owner: taoensso
• License: epl-1.0
• Created: 2014-02-21T11:30:04.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T13:28:20.000Z (3 months ago)
• Last Synced: 2024-10-29T15:37:55.777Z (3 months ago)
• Topics: ajax, async, clojure, clojurescript, edn, epl, http-kit, taoensso, transit, websockets
• Language: Clojure
• Homepage: https://www.taoensso.com/sente
• Size: 1.58 MB
• Stars: 1,740
• Watchers: 48
• Forks: 196
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: FUNDING.yml
  • License: LICENSE.txt
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
  

[**API**][cljdoc docs] | [**Wiki**][GitHub wiki] | [Latest releases](#latest-releases) | [Slack channel][]

# Sente

### Realtime web comms library for Clojure/Script

**Sente** is a small client+server library that makes it easy to build **realtime web applications** with Clojure + ClojureScript.

Loosely inspired by [Socket.IO](https://socket.io/), it uses **core.async**, **WebSockets**, and **Ajax** under the hood to provide a simple high-level API that enables **reliable, high-performance, bidirectional communications**.



> **Sen-te** (先手) is a Japanese [Go](https://en.wikipedia.org/wiki/Go_(game)) term used to describe a play with such an overwhelming follow-up that it demands an immediate response, leaving its player with the initiative.

## Latest release/s

- `2024-12-31` `v1.20.0` (dev): [release info](../../releases/tag/v1.20.0)

[![Main tests][Main tests SVG]][Main tests URL]

[![Graal tests][Graal tests SVG]][Graal tests URL]

See [here][GitHub releases] for earlier releases.

## Why Sente?

- **Bidirectional a/sync comms** over **WebSockets** with **auto Ajax fallback**

- **It just works**: auto keep-alive, buffering, protocol selection, reconnects

- **Efficient design** with auto event batching for low-bandwidth use, even over Ajax

- Send **arbitrary Clojure vals** over [edn](https://github.com/edn-format/edn) or [Transit](https://github.com/cognitect/transit-clj) (JSON, MessagePack, etc.)

- Tiny, easy-to-use [API](../../wiki/1-Getting-started#usage)

- Support for users simultaneously connected with **multiple clients** and/or devices

- Realtime info on **which users are connected**, and over which protocols

- Standard **Ring security model**: auth as you like, HTTPS when available, CSRF support, etc.

- Support for [several popular web servers](../../tree/master/src/taoensso/sente/server_adapters), [easily extended](../../blob/master/src/taoensso/sente/interfaces.cljc) to other servers.

### Capabilities

Protocol   | client>server  | client>server + ack/reply | server>user push

---------- | -------------- | ------------------------- | ----------------

WebSockets | ✓ (native)    | ✓ (emulated)              | ✓ (native)

Ajax       | ✓ (emulated)  | ✓ (native)                | ✓ (emulated)

So you can ignore the underlying protocol and deal directly with Sente's unified API that exposes the best of both WebSockets (bidirectionality + performance) and Ajax (optional ack/reply).

## Documentation

- [Wiki][GitHub wiki] (getting started, usage, etc.)

- API reference: [cljdoc][cljdoc docs], [Codox][Codox docs]

## Funding

You can [help support][sponsor] continued work on this project, thank you!! 🙏

## License

Copyright © 2012-2024 [Peter Taoussanis][].  

Licensed under [EPL 1.0](LICENSE.txt) (same as Clojure).

[GitHub releases]: ../../releases

[GitHub issues]:   ../../issues

[GitHub wiki]:     ../../wiki

[Slack channel]: https://www.taoensso.com/sente/slack

[Peter Taoussanis]: https://www.taoensso.com

[sponsor]:          https://www.taoensso.com/sponsor

[Codox docs]:  https://taoensso.github.io/sente/

[cljdoc docs]: https://cljdoc.org/d/com.taoensso/sente/CURRENT/api/taoensso.sente

[Clojars SVG]: https://img.shields.io/clojars/v/com.taoensso/sente.svg

[Clojars URL]: https://clojars.org/com.taoensso/sente

[Main tests SVG]:  https://github.com/taoensso/sente/actions/workflows/main-tests.yml/badge.svg

[Main tests URL]:  https://github.com/taoensso/sente/actions/workflows/main-tests.yml

[Graal tests SVG]: https://github.com/taoensso/sente/actions/workflows/graal-tests.yml/badge.svg

[Graal tests URL]: https://github.com/taoensso/sente/actions/workflows/graal-tests.yml