Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cgmartin/clj-wamp
WebSocket Application Messaging Protocol (WAMP) for Clojure and HTTP Kit
https://github.com/cgmartin/clj-wamp
Last synced: 2 days ago
JSON representation
WebSocket Application Messaging Protocol (WAMP) for Clojure and HTTP Kit
- Host: GitHub
- URL: https://github.com/cgmartin/clj-wamp
- Owner: cgmartin
- License: epl-1.0
- Created: 2013-06-09T06:32:12.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-10-16T17:05:10.000Z (over 9 years ago)
- Last Synced: 2025-01-17T03:51:59.261Z (5 days ago)
- Language: Clojure
- Homepage: http://cljwamp.us
- Size: 386 KB
- Stars: 54
- Watchers: 11
- Forks: 12
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# clj-wamp
A Clojure implementation of the WebSocket Application Messaging Protocol (v1),
for HTTP Kit servers.
Provides hooks for common WebSocket messaging patterns and error handling (RPC, PubSub, and Authentication).
[](https://travis-ci.org/cgmartin/clj-wamp)
Visit [cljwamp.us](http://cljwamp.us) for live demos and additional information.
See [clj-wamp-example](https://github.com/cgmartin/clj-wamp-example) for an example project and source code.
For information on **HTTP Kit**, a Ring-compatible HTTP server for Clojure, visit [http-kit.org](http://http-kit.org/).
For information on the **WAMP v1 specification**, visit [wamp.ws](http://wamp.ws).
## Usage
Create a new starter project with clj-wamp and HTTP Kit:
```bash
lein new clj-wamp my-project
```
...or add the following dependency to your existing `project.clj` file:
```clojure
[clj-wamp "1.0.2"]
```
Run clj-wamp's http-kit-handler within http-kit's with-channel context:
```clojure
(ns clj-wamp-example
(:require [org.httpkit.server :as http-kit]
[clj-wamp.server :as wamp]))
; Topic URIs
(defn rpc-url [path] (str "http://clj-wamp-example/api#" path))
(defn evt-url [path] (str "http://clj-wamp-example/event#" path))
(def origin-re #"https?://myhost")
(defn my-wamp-handler
"Returns a http-kit websocket handler with wamp subprotocol"
[request]
(wamp/with-channel-validation request channel origin-re
(wamp/http-kit-handler channel
; Here be dragons... all are optional
{:on-open on-open-fn
:on-close on-close-fn
:on-call {(rpc-url "add") + ; map topics to RPC fn calls
(rpc-url "echo") identity
:on-before on-before-call-fn ; broker incoming params or
; return false to deny access :on-after-error on-after-call-error-fn
:on-after-success on-after-call-success-fn }
:on-subscribe {(evt-url "chat") chat-subscribe? ; allowed to subscribe?
(evt-url "prefix*") true ; match topics by prefix
(evt-url "sub-only") true ; implicitly allowed
(evt-url "pub-only") false ; subscription is denied
:on-after on-subscribe-fn }
:on-publish {(evt-url "chat") chat-broker-fn ; custom event broker
(evt-url "prefix*") true ; pass events through as-is
(evt-url "sub-only") false ; publishing is denied
(evt-url "pub-only") true
:on-after on-publish-fn }
:on-unsubscribe on-unsubscribe-fn
:on-auth {:allow-anon? true ; allow anonymous authentication?
:secret auth-secret-fn ; retrieve the auth key's secret
:permissions auth-permissions-fn ; return the permissions for a key
:timeout 20000}}))) ; close the connection if not auth'd
(http-kit/run-server my-wamp-handler {:port 8080})
```
See [the docs](http://cljwamp.us/doc/index.html) for more information on the API and callback signatures.
## Change Log
[CHANGES.md](https://github.com/cgmartin/clj-wamp/blob/master/CHANGES.md)
## Contributions
Pull requests are most welcome!
## License
Copyright © 2013 Christopher Martin
Distributed under the Eclipse Public License, the same as Clojure.