ch.rasc.sse.eventbus

Class SseEventBus

java.lang.Object

ch.rasc.sse.eventbus.SseEventBus

public class SseEventBus
extends Object

Constructor Summary

Constructors

Constructor and Description
SseEventBus(SseEventBusConfigurer configurer)

Method Summary

Modifier and Type	Method and Description
void	cleanUp()
org.springframework.web.servlet.mvc.method.annotation.SseEmitter	createSseEmitter(String clientId)
org.springframework.web.servlet.mvc.method.annotation.SseEmitter	createSseEmitter(String clientId, Long timeout, String... events) Creates a SseEmitter and registers the client in the internal database.
org.springframework.web.servlet.mvc.method.annotation.SseEmitter	createSseEmitter(String clientId, String... events)
List<DataObjectConverter>	getDataObjectConverters()
void	handleEvent(SseEvent event)
void	registerClient(String clientId, org.springframework.web.servlet.mvc.method.annotation.SseEmitter emitter)
void	setDataObjectConverters(List<DataObjectConverter> dataObjectConverters)
void	subscribe(String clientId) Subscribe to the default event (message)
void	subscribe(String clientId, String event)
void	unregisterClient(String clientId)
void	unsubscribe(String clientId, String event)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SseEventBus

public SseEventBus(SseEventBusConfigurer configurer)

Method Detail

cleanUp

@PreDestroy
public void cleanUp()

createSseEmitter

public org.springframework.web.servlet.mvc.method.annotation.SseEmitter createSseEmitter(String clientId)

createSseEmitter

public org.springframework.web.servlet.mvc.method.annotation.SseEmitter createSseEmitter(String clientId,
                                                                                         String... events)

createSseEmitter

public org.springframework.web.servlet.mvc.method.annotation.SseEmitter createSseEmitter(String clientId,
                                                                                         Long timeout,
                                                                                         String... events)

Creates a SseEmitter and registers the client in the internal database. Clients will be subscribed to the provided events if specified.

Parameters:

clientId - unique client identifier

timeout - timeout value in milliseconds

events - names of the events a client want to subscribes

Returns:

a new SseEmitter instance

registerClient

public void registerClient(String clientId,
                           org.springframework.web.servlet.mvc.method.annotation.SseEmitter emitter)

unregisterClient

public void unregisterClient(String clientId)

subscribe

public void subscribe(String clientId)

Subscribe to the default event (message)

subscribe

public void subscribe(String clientId,
                      String event)

unsubscribe

public void unsubscribe(String clientId,
                        String event)

handleEvent

@EventListener
public void handleEvent(SseEvent event)

getDataObjectConverters

public List<DataObjectConverter> getDataObjectConverters()

setDataObjectConverters

public void setDataObjectConverters(List<DataObjectConverter> dataObjectConverters)