Document server sent event customization

graemerocher · graemerocher · commit f58ef04f6ae3 · 2017-02-17T12:55:08.000+01:00
diff --git a/src/docs/asciidoc/serverSentEvents.adoc b/src/docs/asciidoc/serverSentEvents.adoc
@@ -74,4 +74,42 @@ function tickTock() {
         document.getElementById('message').innerHTML = event.data;
     }, false);
 }
+----
+
+In addition for more complex event types you can use the `rx.event` method:
+
+[source,groovy]
+----
+    rx.stream { Subscriber subscriber ->
+       for(i in (0..5)) {
+           if(i % 2 == 0) {
+               subscriber.onNext(
+                   rx.event("Tick", event:"Event $i", id:"$id", comment:"Tick Event") <1>
+               )
+           }
+           else {
+                ...
+           }
+       }
+       ...
+   }
+----
+
+<1> The `event` method can be used to customize the Server Sent event properties and rendering multi-line data.
+
+The `event` method also accepts `Writable` instances, which can be useful in combination with builders:
+
+[source,groovy]
+----
+Writable writable = new Writable() {
+   @Override
+    Writer writeTo(Writer writer) throws IOException {
+        new StreamingJsonBuilder(writer).call {
+            tick "Tock"
+        }
+        return writer
+    }
+}
+rx.event(writable, event:"Event $i", id:"$id", comment:"Tick Event")
+
 ----
