Merge pull request #288303 from phanthaiduong22/dphan/ping-pong

[Web PubSub] Adding new Ping/Pong protocol

Author: prmerger-automator[bot]

articles/azure-web-pubsub/includes/reference-json-requests.md

@@ -272,4 +272,16 @@ binary
 
 The `Content-Type` for the CloudEvents HTTP request is `application/octet-stream` when `dataType` is `binary`.  The WebSocket frame can be `text` format for text message frames or UTF8 encoded binaries for `binary` message frames.
 
-The Web PubSub service declines the client if the message doesn't match the described format.
+The Web PubSub service declines the client if the message doesn't match the described format.
+
+### Ping
+
+Format:
+
+```json
+{
+    "type": "ping",
+}
+```
+
+The client can send a `ping` message to the service to enable the Web PubSub service to detect the client's liveness.

articles/azure-web-pubsub/includes/reference-protobuf-requests.md

@@ -244,3 +244,8 @@ ce-eventName: <event_name>
 For `dataType`=`binary`, the `Content-Type` for the CloudEvents HTTP request is `application/octet-stream`.  The WebSocket frame can be in `text` format for text message frames or UTF-8-encoded binaries for `binary` message frames.
 
 The service declines the client if the message doesn't match the prescribed format.
+
+### Ping
+
+The client can send a `PingMessage` to the service to enable the Web PubSub service to detect the client's liveness.
+

articles/azure-web-pubsub/reference-json-reliable-webpubsub-subprotocol.md

@@ -60,7 +60,7 @@ Reliable PubSub WebSocket client must send a sequence ack message once it receiv
 
 ## Responses
 
-Messages received by the client can be several types: `ack`, `message`, and `system`. Messages with type `message` have `sequenceId` property. Client must send a [Sequence Ack](#sequence-ack) to the service once it receives a message.
+Messages received by the client can be several types: `ack`, `message`, `system`, and `pong`. Messages with type `message` have `sequenceId` property. Client must send a [Sequence Ack](#sequence-ack) to the service once it receives a message.
 
 ### Ack response
 
@@ -162,7 +162,19 @@ If the REST API is sending a string `Hello World` using `application/json` conte
 
 ### System response
 
-The Web PubSub service can return system-related responses to the client. 
+The Web PubSub service can return system-related responses to the client.
+
+### Pong response
+
+The Web PubSub service sends a `pong` message to the client when it receives a `ping` message from the client.
+
+Format:
+
+```json
+{
+    "type": "pong",
+}
+```
 
 #### Connected
 

articles/azure-web-pubsub/reference-json-webpubsub-subprotocol.md

@@ -45,6 +45,7 @@ Message types received by the client can be:
 * ack - The response to a request containing an `ackId`.
 * message - Messages from the group or server.
 * system - Messages from the Web PubSub service.
+* pong - The response to a `ping` message.
 
 ### Ack response
 
@@ -142,7 +143,19 @@ If the REST API is sending a string `Hello World` using `application/json` conte
 
 ### System response
 
-The Web PubSub service sends system-related messages to clients. 
+The Web PubSub service sends system-related messages to clients.
+
+### Pong response
+
+The Web PubSub service sends a `pong` message to the client when it receives a `ping` message from the client.
+
+Format:
+
+```json
+{
+    "type": "pong",
+}
+```
 
 #### Connected
 

articles/azure-web-pubsub/reference-protobuf-reliable-webpubsub-subprotocol.md

@@ -47,6 +47,8 @@ message UpstreamMessage {
         EventMessage event_message = 5;
         JoinGroupMessage join_group_message = 6;
         LeaveGroupMessage leave_group_message = 7;
+        SequenceAckMessage sequence_ack_message = 8;
+        PingMessage ping_message = 9;
     }
 
     message SendToGroupMessage {
@@ -75,6 +77,9 @@ message UpstreamMessage {
     message SequenceAckMessage {
         uint64 sequence_id = 1;
     }
+
+    message PingMessage {
+    }
 }
 
 message MessageData {
@@ -104,6 +109,7 @@ message DownstreamMessage {
         AckMessage ack_message = 1;
         DataMessage data_message = 2;
         SystemMessage system_message = 3;
+        PongMessage pong_message = 4;
     }
     
     message AckMessage {
@@ -140,6 +146,9 @@ message DownstreamMessage {
             string reason = 2;
         }
     }
+
+    message PongMessage {
+    }
 }
 ```
 
@@ -170,7 +179,11 @@ The sender's `dataType` will cause one of the following messages to be sent:
 
 ### System response
 
-The Web PubSub service can also send system-related responses to the client. 
+The Web PubSub service can also send system-related responses to the client.
+
+### Pong response
+
+The Web PubSub service sends a `PongMessage` to the client when it receives a `PingMessage` from the client.
 
 #### Connected
 

articles/azure-web-pubsub/reference-protobuf-webpubsub-subprotocol.md

@@ -47,6 +47,8 @@ message UpstreamMessage {
         EventMessage event_message = 5;
         JoinGroupMessage join_group_message = 6;
         LeaveGroupMessage leave_group_message = 7;
+        SequenceAckMessage sequence_ack_message = 8;
+        PingMessage ping_message = 9;
     }
 
     message SendToGroupMessage {
@@ -70,6 +72,9 @@ message UpstreamMessage {
         string group = 1;
         optional uint64 ack_id = 2;
     }
+
+    message PingMessage {
+    }
 }
 
 message MessageData {
@@ -93,6 +98,7 @@ message DownstreamMessage {
         AckMessage ack_message = 1;
         DataMessage data_message = 2;
         SystemMessage system_message = 3;
+        PongMessage pong_message = 4;
     }
     
     message AckMessage {
@@ -127,10 +133,13 @@ message DownstreamMessage {
             string reason = 2;
         }
     }
+
+    message PongMessage {
+    }
 }
 ```
 
-Messages received by the client can be in any of three types: `ack`, `message`, or `system`. 
+Messages received by the client can be in any of three types: `ack`, `message`, `system` or `pong`. 
 
 ### Ack response
 
@@ -157,7 +166,7 @@ The sender's `dataType` will cause one of the following messages to be sent:
 
 ### System response
 
-The Web PubSub service can also send system-related responses to the client. 
+The Web PubSub service can also send system-related responses to the client.
 
 #### Connected
 
@@ -167,6 +176,10 @@ When the client connects to the service, you receive a `DownstreamMessage.System
 
 When the server closes the connection or the service declines the client, you receive a `DownstreamMessage.SystemMessage.DisconnectedMessage` message.
 
+### Pong response
+
+The Web PubSub service sends a `PongMessage` to the client when it receives a `PingMessage` from the client.
+
 ## Next steps
 
 [!INCLUDE [next step](includes/include-next-step.md)]