From c97f92ca79d583df91c78bfc13a3de0e0e8206ee Mon Sep 17 00:00:00 2001 From: Marc Vila Date: Tue, 26 Feb 2019 14:32:18 +0100 Subject: [PATCH 1/4] Improve README --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 072a33c..8135f5b 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,14 @@ An Android EventSource (SSE - Server Sent Events) Library +## Installation jCenter Gradle import - compile 'com.tylerjroach:eventsource:1.2.11' + implementation 'com.tylerjroach:eventsource:1.2.11' -## What's new (1.2.11) +## What's new + +1.2.11 * Removed need to create event source in background thread, now done automatically * First official jcenter release * Executor fix @@ -24,20 +27,26 @@ jCenter Gradle import * Ability to choose thread for callbacks to return -##Example implementation: +## Example private SSEHandler sseHandler = new SSEHandler(); + private EventSource eventSource; private void startEventSource() { + String eventUrl = YOUR_URL; + + Map header = new HashMap<>(); + header.put("Authorization", "Token XXX"); + eventSource = new EventSource.Builder(eventUrl) .eventHandler(sseHandler) - .headers(extraHeaderParameters) + .headers(headerParameters) .build(); eventSource.connect(); } private void stopEventSource() { - if (eventsource != null) + if (eventSource != null) eventSource.close(); sseHandler = null; } @@ -78,8 +87,9 @@ jCenter Gradle import public void onClosed(boolean willReconnect) { Log.v("SSE Closed", "reconnect? " + willReconnect); } + } -To stop event source, make sure to run eventSource.close() +To stop event source, make sure to run `eventSource.close()` If you have a pull request, please follow square-android style guides found here: https://github.com/square/java-code-styles From af3bb6a3b14b4dbad7c13a9e070ff1f399a0ec6c Mon Sep 17 00:00:00 2001 From: Marc Vila Date: Tue, 26 Feb 2019 14:33:56 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 123 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 63 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 8135f5b..8e8d4f9 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,10 @@ An Android EventSource (SSE - Server Sent Events) Library ## Installation jCenter Gradle import +```groovy +implementation 'com.tylerjroach:eventsource:1.2.11' +``` - implementation 'com.tylerjroach:eventsource:1.2.11' - ## What's new 1.2.11 @@ -28,67 +29,69 @@ jCenter Gradle import ## Example - - private SSEHandler sseHandler = new SSEHandler(); - private EventSource eventSource; - - private void startEventSource() { - String eventUrl = YOUR_URL; - - Map header = new HashMap<>(); - header.put("Authorization", "Token XXX"); - - eventSource = new EventSource.Builder(eventUrl) - .eventHandler(sseHandler) - .headers(headerParameters) - .build(); - eventSource.connect(); + +```java +private SSEHandler sseHandler = new SSEHandler(); +private EventSource eventSource; + +private void startEventSource() { + String eventUrl = YOUR_URL; + + Map header = new HashMap<>(); + header.put("Authorization", "Token XXX"); + + eventSource = new EventSource.Builder(eventUrl) + .eventHandler(sseHandler) + .headers(headerParameters) + .build(); + eventSource.connect(); +} + +private void stopEventSource() { + if (eventSource != null) + eventSource.close(); + sseHandler = null; +} + +/** +* All callbacks are currently returned on executor thread. +* If you want to update the ui from a callback, make sure to post to main thread +*/ + +private class SSEHandler implements EventSourceHandler { + + public SSEHandler() {} + + @Override + public void onConnect() { + Log.v("SSE Connected", "True"); } - - private void stopEventSource() { - if (eventSource != null) - eventSource.close(); - sseHandler = null; + + @Override + public void onMessage(String event, MessageEvent message) { + Log.v("SSE Message", event); + Log.v("SSE Message: ", message.lastEventId); + Log.v("SSE Message: ", message.data); + } + + @Override + public void onComment(String comment) { + //comments only received if exposeComments turned on + Log.v("SSE Comment", comment); } - - /** - * All callbacks are currently returned on executor thread. - * If you want to update the ui from a callback, make sure to post to main thread - */ - - private class SSEHandler implements EventSourceHandler { - - public SSEHandler() {} - - @Override - public void onConnect() { - Log.v("SSE Connected", "True"); - } - - @Override - public void onMessage(String event, MessageEvent message) { - Log.v("SSE Message", event); - Log.v("SSE Message: ", message.lastEventId); - Log.v("SSE Message: ", message.data); - } - - @Override - public void onComment(String comment) { - //comments only received if exposeComments turned on - Log.v("SSE Comment", comment); - } - - @Override - public void onError(Throwable t) { - //ignore ssl NPE on eventSource.close() - } - - @Override - public void onClosed(boolean willReconnect) { - Log.v("SSE Closed", "reconnect? " + willReconnect); - } + + @Override + public void onError(Throwable t) { + //ignore ssl NPE on eventSource.close() } - + + @Override + public void onClosed(boolean willReconnect) { + Log.v("SSE Closed", "reconnect? " + willReconnect); + } +} +``` + To stop event source, make sure to run `eventSource.close()` If you have a pull request, please follow square-android style guides found here: https://github.com/square/java-code-styles From 09f71504b61581ebebe72bef10c20b99f98e3acb Mon Sep 17 00:00:00 2001 From: Marc Vila Date: Tue, 26 Feb 2019 14:37:20 +0100 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e8d4f9..19338f3 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ private EventSource eventSource; private void startEventSource() { String eventUrl = YOUR_URL; - Map header = new HashMap<>(); + Map headerParameters = new HashMap<>(); header.put("Authorization", "Token XXX"); eventSource = new EventSource.Builder(eventUrl) From 19a2b3ade58803791215422aaf94ba6a76c745f0 Mon Sep 17 00:00:00 2001 From: Marc Vila Date: Tue, 26 Feb 2019 14:47:51 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 19338f3..c0f592c 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,8 @@ private void startEventSource() { String eventUrl = YOUR_URL; Map headerParameters = new HashMap<>(); - header.put("Authorization", "Token XXX"); + headerParameters.put("Content-Type", "text/event-stream"); + headerParameters.put("Authorization", "Bearer YOUR_TOKEN"); eventSource = new EventSource.Builder(eventUrl) .eventHandler(sseHandler)