From 4ad1214cf04eb9e5db18226a95e8f04aee7585ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrejs=20Mivre=C5=86iks?= Date: Sat, 8 Oct 2016 16:13:49 +0300 Subject: [PATCH] Add README.md --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..22c9053 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# STOMP over WebSocket implementation in Java + +This is a [STOMP](http://stomp.github.io/) protocol implementation. + +## Example backend using Spring Boot + +### Configuration + +```java +@Configuration +public class WebSocketMessageBrokerConfigurer extends AbstractWebSocketMessageBrokerConfigurer { + + @Override + public void configureMessageBroker(MessageBrokerRegistry config) { + config.enableSimpleBroker("/topic"); + config.setApplicationDestinationPrefixes("/app"); + } + + @Override + public void registerStompEndpoints(StompEndpointRegistry registry) { + registry.addEndpoint("/hello"); + } +} +``` + +### Controller + +```java +@Controller +public class GreetingController { + + @MessageMapping("/hello") + @SendTo("/topic/greetings") + public String greeting(String message) throws Exception { + return "Hello, " + message + "!"; + } +} +``` + +## Usage + +```java +StompClient stompClient; +try { + stompClient = new StompClient("ws://localhost:7777/hello"); + stompClient.connect(); +} catch (WebSocketException | IOException e) { + e.printStackTrace(); + return; +} + +// Subscribing to a topic +stompClient.subscribe("/topic/greetings", new StompMessageListener() { + + @Override + public void onMessage(String message) { + System.out.println("Server message: " + message); + } +}); + +// Sending JSON message to a server +String message = "Jack"; +stompClient.send("/app/hello", message); + +// ... +// Disconnect at some point +// stompClient.disconnect(); +```