You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[WebPubSub] Use consistent service description and introduction across all languages (Azure#25144)
* Updating service description and minor fixes
* Update README.md
* Avoid using client as client is a preserved term
* Update README.md
* Update README.md
Copy file name to clipboardExpand all lines: sdk/webpubsub/azure-messaging-webpubsub/README.md
+25-24Lines changed: 25 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,21 @@
1
1
# Azure Web PubSub service client library for Java
2
2
3
-
Azure Web PubSub service client library for Java allows sending messages to Web PubSub. Azure Web PubSub service
4
-
enables you to build real-time messaging web applications using WebSockets and the publish-subscribe pattern. Any
5
-
platform supporting WebSocket APIs can connect to the service easily, e.g. web pages, mobile applications, edge devices,
6
-
etc. The service manages the WebSocket connections for you and allows up to 100K concurrent connections. It provides
7
-
powerful APIs for you to manage these clients and deliver real-time messages.
3
+
[Azure Web PubSub service](https://aka.ms/awps/doc) is an Azure-managed service that helps developers easily build web applications with real-time features and publish-subscribe pattern. Any scenario that requires real-time publish-subscribe messaging between server and clients or among clients can use Azure Web PubSub service. Traditional real-time features that often require polling from server or submitting HTTP requests can also use Azure Web PubSub service.
8
4
9
-
Any scenario that requires real-time publish-subscribe messaging between server and clients or among clients, can use
10
-
Azure Web PubSub service. Traditional real-time features that often require polling from server or submitting HTTP
11
-
requests, can also use Azure Web PubSub service.
5
+
You can use this library in your app server side to manage the WebSocket client connections, as shown in below diagram:
@@ -56,30 +61,25 @@ WebPubSubServiceClient webPubSubServiceClient = new WebPubSubServiceClientBuilde
56
61
57
62
## Key concepts
58
63
64
+
### Connection
65
+
66
+
A connection, also known as a client or a client connection, represents an individual WebSocket connection connected to the Web PubSub service. When successfully connected, a unique connection ID is assigned to this connection by the Web PubSub service.
67
+
59
68
### Hub
60
69
61
-
Hub is a logic set of connections. All connections to Web PubSub connect to a specific hub. Messages that are broadcast
62
-
to the hub are dispatched to all connections to that hub. For example, hub can be used for different applications,
63
-
different applications can share one Azure Web PubSub service by using different hub names.
70
+
A hub is a logical concept for a set of client connections. Usually you use one hub for one purpose, for example, a chat hub, or a notification hub. When a client connection is created, it connects to a hub, and during its lifetime, it belongs to that hub. Different applications can share one Azure Web PubSub service by using different hub names.
64
71
65
72
### Group
66
73
67
-
Group allow broadcast messages to a subset of connections to the hub. You can add and remove users and connections as
68
-
needed. A client can join multiple groups, and a group can contain multiple clients.
74
+
A group is a subset of connections to the hub. You can add a client connection to a group, or remove the client connection from the group, anytime you want. For example, when a client joins a chat room, or when a client leaves the chat room, this chat room can be considered to be a group. A client can join multiple groups, and a group can contain multiple clients.
69
75
70
76
### User
71
77
72
-
Connections to Web PubSub can belong to one user. A user might have multiple connections, for example when a single user
73
-
is connected across multiple devices or multiple browser tabs.
74
-
75
-
### Connection
76
-
77
-
Connections, represented by a connection id, represent an individual websocket connection to the Web PubSub service.
78
-
Connection id is always unique.
78
+
Connections to Web PubSub can belong to one user. A user might have multiple connections, for example when a single user is connected across multiple devices or multiple browser tabs.
79
79
80
80
### Message
81
81
82
-
A message is either an UTF-8 encoded string or raw binary data.
82
+
When the client is connected, it can send messages to the upstream application, or receive messages from the upstream application, through the WebSocket connection.
0 commit comments