{"id":18294818,"url":"https://github.com/joshgontijo/stream-client","last_synced_at":"2025-04-09T08:25:47.554Z","repository":{"id":21758015,"uuid":"93961906","full_name":"joshgontijo/stream-client","owner":"joshgontijo","description":"Resilient client for Server sent events and WebSockets","archived":false,"fork":false,"pushed_at":"2022-08-18T19:02:38.000Z","size":57,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-15T02:41:24.885Z","etag":null,"topics":["server-sent-events","sse","streaming-client","undertow","websockets"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joshgontijo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-10T19:48:12.000Z","updated_at":"2017-06-14T19:15:03.000Z","dependencies_parsed_at":"2022-09-07T07:02:01.978Z","dependency_job_id":null,"html_url":"https://github.com/joshgontijo/stream-client","commit_stats":null,"previous_names":["josueeduardo/stream-client"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshgontijo%2Fstream-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshgontijo%2Fstream-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshgontijo%2Fstream-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshgontijo%2Fstream-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joshgontijo","download_url":"https://codeload.github.com/joshgontijo/stream-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248001685,"owners_count":21031448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["server-sent-events","sse","streaming-client","undertow","websockets"],"created_at":"2024-11-05T14:30:42.458Z","updated_at":"2025-04-09T08:25:47.524Z","avatar_url":"https://github.com/joshgontijo.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Stream client\nResilient client for Server sent events (SSE) and WebSockets based on Undertow\n\n\n### Maven\n\n```xml\n    \u003cdependency\u003e\n        \u003cgroupId\u003eio.joshworks.stream\u003c/groupId\u003e\n        \u003cartifactId\u003estream-client\u003c/artifactId\u003e\n        \u003cversion\u003e0.3\u003c/version\u003e\n    \u003c/dependency\u003e\n```\n\n\n## Server sent events ##\n\n### Using fluent interface to connect to a SSE endpoint\n```java\npublic class App {\n\n    public static void main(final String[] args) {\n      \n        SSEConnection connection = StreamClient.sse(\"http://my-service/sse\")\n                        .onEvent((data) -\u003e System.out.println(\"New event: \" + data))\n                        .connect();\n                        \n                        //onClose\n                        //onOpen\n                        //OnError\n                        \n        \n        \n        //then...\n        String lastEventId = connection.close();\n        \n    }\n}\n```\n\n### Using dedicated handler to connect to a SSE endpoint\n```java\n\npublic class StreamHandler extends SseClientCallback {\n\n        @Override\n        public void onEvent(EventData event) {\n            System.out.println(\"New event: \" + event);\n        }\n    \n        @Override\n        public void onOpen() {\n            System.out.println(\"Connected\");\n        }\n    \n        @Override\n        public void onClose(String lastEventId) {\n            System.out.println(\"Closed, last event id: \" + lastEventId);\n        }\n    \n        @Override\n        public void onError(Exception e) {\n            System.err.println(e.getMessage());\n        }\n}\n\npublic class App {\n\n    public static void main(final String[] args) {\n      \n        SSEConnection connection = StreamClient.connect(\"http://my-service/sse\", new StreamHandler());\n                             \n        //then...\n        String lastEventId = connection.close();\n        \n    }\n}\n```\n\n## Websockets ##\n\n### Using fluent interface to connect to a WebSocket endpoint\n```java\npublic class App {\n\n    public static void main(final String[] args) {\n        \n     WsConnection ws = StreamClient.ws(\"http://my-service/ws\")\n                    .onText((channel, message) -\u003e System.out.println(\"Message received: \" + message))\n                    .connect();\n    \n            //...\n            ws.close(new CloseMessage(CloseMessage.NORMAL_CLOSURE, \"Bye\"));\n    \n        }\n}\n```\n\n### Using dedicated handler to connect to a WebSocket endpoint\n```java\n\npublic class MyEndpoint extends WebSocketClientEndpoint {\n\n    //..method signatures for brevity\n    protected void onConnect(WebSocketChannel channel, WebSocketHttpExchange exchange);\n    protected void onClose(WebSocketChannel channel, CloseMessage message) ;\n    protected void onPing(WebSocketChannel channel, BufferedBinaryMessage message);\n    protected void onPong(WebSocketChannel channel, BufferedBinaryMessage message);\n    protected void onText(WebSocketChannel channel, BufferedTextMessage message);\n    protected void onBinary(WebSocketChannel channel, BufferedBinaryMessage message);\n    protected void onError(WebSocketChannel channel, Exception error);\n\n}\n\npublic class App {\n\n    public static void main(final String[] args) {\n    \n           StreamClient.connect(\"http://my-service/ws\", new MyEndpoint());\n    \n    }\n}\n```\n\n### Sending message to a server\n```java\n\npublic class App {\n\n    public static void main(final String[] args) {\n    \n           WsConnection ws = StreamClient.connect(...);\n           \n           //undertow API\n           WebSockets.sendText(\"Hello\", ws.channel(), null);\n           WebSockets.sendBinary(new byte[]{1}, ws.channel(), null);\n           //...etc\n    \n    }\n}\n```\n\n### Connection retry\nDisabled by default, to enable use `maxRetries(int retries)`, optionally use `.retryInterval(long intervalMillis)` (default is 2000) \n```java\n\npublic class App {\n\n    public static void main(final String[] args) {\n    \n           StreamClient.ws(\"http://my-service/ws\")\n                    .maxRetries(100)\n                    .retryInterval(5000)\n                    .connect();\n    \n    }\n}\n```\n\n\n## XnioWorker configuration ##\nThe XnioWorker is shared across all clients (SSE and WS), in case of many connections, the thread pool can be tuned\n\n```java\npublic class App {\n\n    public static void main(final String[] args) {\n      \n         OptionMap options = OptionMap.builder()\n                    .set(Options.WORKER_IO_THREADS, 10)\n                    .set(Options.TCP_NODELAY, true)\n                    .set(Options.WORKER_NAME, \"client-threads\")\n                    .set(Options.KEEP_ALIVE, true)\n                    .getMap();\n        \n        StreamClient.configure(options);\n        \n        StreamClient.sse(...);\n        StreamClient.ws(...);\n        \n        //...\n    }\n}\n```\n\n### Closing all connections ###\n\n```java\npublic class App {\n\n    public static void main(final String[] args) {\n     \n        //...\n        StreamClient.shutdown();\n    }\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshgontijo%2Fstream-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoshgontijo%2Fstream-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshgontijo%2Fstream-client/lists"}