你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

适用于 .NET 的 Azure Web PubSub 事件处理程序事件数据模型客户端库 - 版本 1.2.0

项目
04/18/2023

此库定义与 Azure Web PubSub 服务上游请求一起处理的类。

入门

安装包

从 NuGet 安装客户端库：

dotnet add package Microsoft.Azure.WebPubSub.Common

先决条件

一个 Azure 订阅。
现有 Azure Web PubSub 服务实例。

验证客户端

不适用于库。应使用客户端库以友好的方式反序列化服务请求。

关键概念

事件

“连接”、“已连接”、“已断开连接”是指示连接阶段的系统事件。 Connect 是一个阻止事件，服务将等待响应确定下一个操作。返回的任何错误都将断开连接。

用户事件是消息事件。这也是服务正在等待响应的阻塞事件。服务器可以在响应中返回将直接发送给调用方的信息。

WebPubSubEventRequest

WebPubSubEventRequest 表示来自服务端的抽象请求。具体来说，它应该是 ValidationRequest 或 4 个事件之一，即 ConnectEventRequest、ConnectedEventRequest、UserEventRequest 和 DisconnectedEventRequest。 ValidationRequest 表示对滥用保护的请求。

WebPubSubEventResponse

WebPubSubEventResponse 表示应返回到服务的抽象响应。具体来说，它应该是 EventErrorResponse 或 2 个阻塞事件之一，即 ConnectEventResponse 和 UserEventResponse。

示例

使用示例查看适用于 E2E 的 Microsoft.Azure.WebPubSub.AspNetCore。

故障排除

如果想要更深入地了解针对服务发出的请求，还可以轻松启用控制台记录。

后续步骤

有关如何使用此库的详细示例，请查看示例目录。

贡献

本项目欢迎贡献和建议。大多数贡献要求你同意贡献者许可协议 (CLA)，并声明你有权（并且确实有权）授予我们使用你的贡献的权利。有关详细信息，请访问 https://cla.microsoft.com 。

提交拉取请求时，CLA 机器人将自动确定你是否需要提供 CLA，并相应地修饰 PR（例如标签、注释）。直接按机器人提供的说明操作。只需使用 CLA 对所有存储库执行一次这样的操作。

此项目已采用 [Microsoft 开源行为准则][code_of_conduct]。有关详细信息，请参阅 [行为准则常见问题解答][code_of_conduct_faq] 或联系 opencode@microsoft.com 任何其他问题或意见。

曝光数

通过