projects
/
arvados.git
/ blobdiff
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
11789: Added tests.
[arvados.git]
/
services
/
ws
/
doc.go
diff --git
a/services/ws/doc.go
b/services/ws/doc.go
index d2805689210fef467ace420785c7bba31a3c6a75..7ccb588d856b28e03cd03db8cacd9db2352a9cbd 100644
(file)
--- a/
services/ws/doc.go
+++ b/
services/ws/doc.go
@@
-1,6
+1,14
@@
-// Arvados-ws is an Arvados event feed for Websocket clients.
+// Arvados-ws exposes Arvados APIs (currently just one, the
+// cache-invalidation event feed at "ws://.../websocket") to
+// websocket clients.
//
//
-// See https://doc.arvados.org/install/install-arvados-ws.html.
+// Installation
+//
+// See https://doc.arvados.org/install/install-ws.html.
+//
+// Developer info
+//
+// See https://dev.arvados.org/projects/arvados/wiki/Hacking_websocket_server.
//
// Usage
//
//
// Usage
//
@@
-34,6
+42,10
@@
//
// A log is printed each time a client connects or disconnects.
//
//
// A log is printed each time a client connects or disconnects.
//
+// Enable additional logs by configuring:
+//
+// LogLevel: debug
+//
// Runtime status
//
// GET /debug.json responds with debug stats.
// Runtime status
//
// GET /debug.json responds with debug stats.