summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLi Haoyi <haoyi.sg@gmail.com>2018-08-13 15:00:14 +0800
committerLi Haoyi <haoyi.sg@gmail.com>2018-08-13 15:25:11 +0800
commita873d77fbeb4590dceeb893ab067beb9058db241 (patch)
tree3132f93c3f78206ad3ca7af8dd7f04a116c216ed /docs
parent3ff5a5079080de524375cd43425c1515bf128274 (diff)
downloadcask-a873d77fbeb4590dceeb893ab067beb9058db241.tar.gz
cask-a873d77fbeb4590dceeb893ab067beb9058db241.tar.bz2
cask-a873d77fbeb4590dceeb893ab067beb9058db241.zip
Tweak websocket tests, example and docs
Diffstat (limited to 'docs')
-rw-r--r--docs/pages/1 - Cask: a Scala HTTP micro-framework .md11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/pages/1 - Cask: a Scala HTTP micro-framework .md b/docs/pages/1 - Cask: a Scala HTTP micro-framework .md
index 131d06b..df79f09 100644
--- a/docs/pages/1 - Cask: a Scala HTTP micro-framework .md
+++ b/docs/pages/1 - Cask: a Scala HTTP micro-framework .md
@@ -319,6 +319,13 @@ Returning a `cask.Response` immediately closes the websocket connection, and is
useful if you want to e.g. return a 404 or 403 due to the initial request being
invalid.
+Cask intentionally provides a relatively low-level websocket interface. It
+leaves it up to you to manage open channels, react to incoming messages, or
+pro-actively send them out, mostly using the underlying Undertow webserver
+interface. While Cask does not model streams, backpressure, iteratees, or
+provide any higher level API, it should not be difficult to take the Cask API
+and build whatever higher-level abstractions you prefer to use.
+
### TodoMVC Api Server
@@ -396,9 +403,7 @@ need some low-level functionality not exposed by the Cask API, you can override
`defaultHandler` to make use of Undertow's own
[handler API](http://undertow.io/undertow-docs/undertow-docs-2.0.0/index.html#built-in-handlers)
for customizing your webserver. This allows for things that Cask itself doesn't
-internally support: asynchronous requests & response,
-[Websockets](http://undertow.io/undertow-docs/undertow-docs-2.0.0/index.html#websockets),
-etc.
+internally support.
### def port: Int = 8080, def host: String = "localhost"