Skip to content

Commit 515d3fe

Browse files
authored
update
1 parent 83d87c9 commit 515d3fe

File tree

1 file changed

+3
-13
lines changed

1 file changed

+3
-13
lines changed

articles/azure-web-pubsub/concept-client-protocols.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -61,32 +61,22 @@ var client2 = new WebSocket('wss://test.webpubsub.azure.com/client/hubs/hub1', '
6161

6262
Simple WebSocket client has two modes: `sendEvent` and `sendToGroup`. The mode is determined once the connection is established and cannot be changed later.
6363

64-
`sendEvent` is the default mode for the simple WebSocket client. In `sendEvent` mode, every WebSocket frame the client sent is considered as a `message` event by default. Users can configure [event handlers](./concept-service-internals.md#event-handler) or [event listeners](./concept-service-internals.md#event-listener) to handle these `message` events.
64+
`sendEvent` is the default mode for the simple WebSocket client. In `sendEvent` mode, every WebSocket frame the client sent is considered as a `message` event. Users can configure [event handlers](./concept-service-internals.md#event-handler) or [event listeners](./concept-service-internals.md#event-listener) to handle these `message` events.
6565

6666
You can also customize the event name by using `event` query parameter.
6767
```javascript
6868
// When every data frame is considered as a `message` event
6969
var client3 = new WebSocket('wss://test.webpubsub.azure.com/client/hubs/hub1');
7070

71-
// When every data frame is considered as a `chat` event
72-
var client4 = new WebSocket('wss://test.webpubsub.azure.com/client/hubs/hub1?event=chat');
73-
7471
// Or explicitly set the mode
75-
var client5 = new WebSocket('wss://test.webpubsub.azure.com/client/hubs/hub1?webpubsub_mode=sendEvent&event=chat');
72+
var client4 = new WebSocket('wss://test.webpubsub.azure.com/client/hubs/hub1?webpubsub_mode=sendEvent');
7673
```
7774

7875
In `sendToGroup` mode, every WebSocket frame the client sent is considered as a message to be published to a specific group. `group` is a required query parameter in this mode, and only a single value is allowed. The connection should also have corresponding [permissions](#permissions) to send messages to the target group. Both `webpubsub.sendToGroup.<group>` and `webpubsub.sendToGroup` roles work for it.
7976

8077
For example, in JavaScript, you can create a simple WebSocket client in `sendToGroup` mode with `group=group1` by using the following code:
8178
```javascript
82-
// simple WebSocket client4 in sendToGroup mode. Messages sent from client3 will be fixedly forwarded to group1
83-
var client6 = new WebSocket('wss://test.webpubsub.azure.com/client/hubs/hub1?webpubsub_mode=sendToGroup&group=group1');
84-
```
85-
86-
The default mode of a simple WebSocket client is `sendEvent` with parameter `event=message`. For example, in JavaScript, the following code creates two clients in the same mode with the same corresponding parameter.
87-
```javascript
88-
var client7 = new WebSocket('wss://test.webpubsub.azure.com/client/hubs/hub1');
89-
var client8 = new WebSocket('wss://test.webpubsub.azure.com/client/hubs/hub1?webpubsub_mode=sendEvent&event=message');
79+
var client5 = new WebSocket('wss://test.webpubsub.azure.com/client/hubs/hub1?webpubsub_mode=sendToGroup&group=group1');
9080
```
9181

9282
## The PubSub WebSocket client

0 commit comments

Comments
 (0)