Improve Reference Documentation about Spring WebSocket [SPR-12579]

[spring-projects-issues]

Manuel Jordan opened SPR-12579 and commented

I am doing a research about Spring Web Socket. I already have read the current spring reference documentation.

I want ask for an improvement about the following:

1. Images about better explanation/complement about how work the Destinations and interceptors , it to understand clearly or much better about @MessageMapping and @SubscribeMapping.

The slides available by Rossen about Spring Websocket are nice, they should be included with a detailed explanation on Spring Reference Documentation.

2. Best suggestion/practice about configure:

registry.enableStompBrokerRelay("/topic", "/queue");
registry.setApplicationDestinationPrefixes("/theapp", "/topic");

For example in the current documentation always appears

registry.setApplicationDestinationPrefixes("/app");

Always one, there is no reason or note about when use other value, how

registry.setApplicationDestinationPrefixes("/app", "/abc");

A sample snippet code with an image would be valuable for a better understanding for a specific scenario

3. Is not clear if for

registry.enableStompBrokerRelay("/topic", "/queue");

or

registry.enableSimpleBroker("/queue","/topic");

the values of /queue or /topic are mandatory.

If yes, why not consider make available them how constants such the MediaType Class? or like an Enum such as HttpMethod enum?

If not, a sample snippet code with an image would be valuable for a better understanding for a specific scenario.

In the current documentation, I always see /queue or /topic, not other possible values

Thank You

---

Affects: 4.1.3

Referenced from: commits 6679120

[spring-projects-issues]

Rossen Stoyanchev commented

See 667912.