root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Add tip related to user destinations in STOMP 

See gh-26986
This commit is contained in:
Rossen Stoyanchev 2021-09-07 16:33:31 +01:00
parent 3f66ef7aee
commit a3655c4858
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/docs/asciidoc/web/websocket.adoc
View File

@ -1818,12 +1818,16 @@ its own implementation of `WebSocketMessageBrokerConfigurer` that is marked with
An application can send messages that target a specific user, and Spring's STOMP support
recognizes destinations prefixed with `/user/` for this purpose.
For example, a client might subscribe to the `/user/queue/position-updates` destination.
This destination is handled by the `UserDestinationMessageHandler` and
transformed into a destination unique to the user session
(such as `/queue/position-updates-user123`). This provides the convenience of subscribing
to a generically named destination while, at the same time, ensuring no collisions
with other users who subscribe to the same destination so that each user can receive
unique stock position updates.
`UserDestinationMessageHandler` handles this destination and transforms it into a
destination unique to the user session (such as `/queue/position-updates-user123`).
This provides the convenience of subscribing to a generically named destination while,
at the same time, ensuring no collisions with other users who subscribe to the same
destination so that each user can receive unique stock position updates.
TIP: When working with user destinations, it is important to configure broker and
application destination prefixes as shown in <<websocket-stomp-enable>>, or otherwise the
broker would handle "/user" prefixed messages that should only be handled by
`UserDestinationMessageHandler`.
On the sending side, messages can be sent to a destination such as
pass:q[`/user/{username}/queue/position-updates`], which in turn is translated