ConnectionContext interface

包:

@azure/web-pubsub-express

表示客户端 WebSocket 连接的连接上下文。

属性

clientProtocol	客户端协议的类型。
connectionId	连接的 ID。
eventName	此 CloudEvents 请求的事件名称。
hub	连接所属的中心。
mqtt	客户端 WebSocket 连接在连接时具有的 MQTT 属性（仅适用于 MQTT 连接）。
origin	此 CloudEvents 请求的来源。
signature	网络连接服务生成的唯一标识符。
states	获取连接的其他状态，此类状态在连接生存期内保留。
subprotocol	此连接的子协议。
userId	连接的用户 ID。

属性详细信息

clientProtocol

客户端协议的类型。

clientProtocol: WebPubSubClientProtocol

属性值

WebPubSubClientProtocol

connectionId

连接的 ID。

connectionId: string

属性值

string

eventName

此 CloudEvents 请求的事件名称。

eventName: string

属性值

string

hub

连接所属的中心。

hub: string

属性值

string

mqtt

客户端 WebSocket 连接在连接时具有的 MQTT 属性（仅适用于 MQTT 连接）。

mqtt?: MqttConnectionContextProperties

属性值

MqttConnectionContextProperties

origin

此 CloudEvents 请求的来源。

origin: string

属性值

string

signature

网络连接服务生成的唯一标识符。

signature: string

属性值

string

states

获取连接的其他状态，此类状态在连接生存期内保留。

states: Record<string, any>

属性值

Record<string, any>

subprotocol

此连接的子协议。

subprotocol?: string

属性值

string

userId

连接的用户 ID。

userId?: string

属性值

string