https://github.com/andrewvc/noir-async
Seamless, concise, async webservices for clojure.
https://github.com/andrewvc/noir-async
Last synced: about 1 year ago
JSON representation
Seamless, concise, async webservices for clojure.
- Host: GitHub
- URL: https://github.com/andrewvc/noir-async
- Owner: andrewvc
- Created: 2011-12-26T04:18:48.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2012-09-09T18:53:21.000Z (over 13 years ago)
- Last Synced: 2025-03-15T23:51:14.362Z (about 1 year ago)
- Language: Clojure
- Homepage: http://andrewvc.github.com/noir-async/
- Size: 240 KB
- Stars: 98
- Watchers: 10
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
- awesome - andrewvc/noir-async - Seamless, concise, async webservices for clojure. (<a name="Clojure"></a>Clojure)
README
# noir-async [](http://travis-ci.org/andrewvc/noir-async)
## Seamless, concise, async webservices for clojure.
noir-async integrates the [noir](https://github.com/ibdknox/noir) web framework with the [aleph](https://github.com/ztellman/aleph) async library with minimal syntax. With noir-async you can create well organized webapps, with both synchronous and asynchronous logic, and multiple asynchronous endpoints.
## Getting Started
1. Add `[noir-async 1.1.0-beta7]` to your project.clj
1. Use the custom [server.clj](#server-setup)
1. Follow the examples below
1. Read the [full API docs](http://andrewvc.github.com/noir-async/autodoc/) for more examples.
Here's an example route that responds in one shot:
```clojure
; Note, same syntax as noir's defpage, but with "conn" parameter
(defpage-async "/route" [] conn
(async-push conn {:status 404 :body "Couldn't find it!"}))
```
This is an example route that handles a websocket:
```clojure
(defpage-async "/echo" [] conn
(on-receive conn (fn [m] (async-push conn m))))
```
Here's an example of responding in a chunked fashion:
```clojure
(defpage-async "/always-chunky" [] conn
;; Sending the header explicitly indicates a chunked response
(async-push conn {:status 200 :chunked true})
(async-push conn "chunk one")
(async-push conn "chunk two")
(close-connection conn))
```
Reading request bodies with aleph can be a little odd, so that interface is sugared:
```clojure
(defpage-async "/some-route" {} conn
;; You can also retrieve the body as a ByteBuffer. See full docs for details
(async-push (str "Received body:" (request-body-str conn))))
```
Since it uses an identical interface for both websockets
and regular HTTP, if you want to handle them differently be
sure to use the websocket? and regular? functions to discern them.
## Server Setup
In your server.clj, you'll want to use aleph as a server explicitly.
Be sure to replace noir-async-chat with the appropriate namespace.
```clojure
(ns noir-async-chat.server
(:use aleph.http
noir.core
lamina.core)
(:require
[noir.server :as nr-server] ))
(nr-server/load-views "src/noir_async_chat/views/")
(defn -main [& m]
(let [mode (keyword (or (first m) :dev))
port (Integer. (get (System/getenv) "PORT" "3000"))
noir-handler (nr-server/gen-handler {:mode mode})]
(start-http-server
(wrap-ring-handler noir-handler)
{:port port :websocket true})))
```
## Full Docs
[Full API Docs](http://andrewvc.github.com/noir-async/autodoc/) for more examples.
## Apps Using noir-async
[engulf](https://github.com/andrewvc/engulf)
[noir-async-chat](https://github.com/andrewvc/noir-async-chat)
## License
Copyright (C) 2011 Andrew Cholakian
Distributed under the Eclipse Public License, the same as Clojure.