MessageWebSocket.Control 属性
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
获取 MessageWebSocket 对象上的套接字控件数据。
public:
property MessageWebSocketControl ^ Control { MessageWebSocketControl ^ get(); };
MessageWebSocketControl Control();
public MessageWebSocketControl Control { get; }
var messageWebSocketControl = messageWebSocket.control;
Public ReadOnly Property Control As MessageWebSocketControl
属性值
MessageWebSocket 对象上的套接字控制数据。
注解
Control 属性获取与 MessageWebSocket 对象关联的 MessageWebSocketControl 实例。
使用父 MessageWebSocket 对象自动创建 MessageWebSocketControl 对象。 然后, 可以使用 MessageWebSocketControl 实例获取或设置 MessageWebSocket 对象使用的控件数据。 MessageWebSocketControl 实例上的这些属性包括:
- MaxMessageSize - 在 MessageWebSocket 对象上配置的 WebSocket 消息的最大消息大小(以字节为单位)。
- MessageType - 要针对写入操作在 MessageWebSocket 对象上配置的 WebSocket 消息类型。
- OutboundBufferSizeInBytes - 要用于在 MessageWebSocket 对象上发送数据的发送缓冲区的大小(以字节为单位)。
- ProxyCredential - 用于使用 MessageWebSocket 对象通过 HTTP 标头身份验证向代理服务器进行身份验证的凭据。
- ServerCredential - 用于使用 MessageWebSocket 对象通过 HTTP 标头身份验证向 WebSocket 服务器进行身份验证的凭据。
- SupportedProtocols - 获取一个集合,该集合可用于添加支持子协议的列表,这些子协议将在连接握手期间播发到服务器。
SupportedProtocols 属性获取此属性的值,可以随时调用。
可以在 MessageWebSocket 连接之前或之后随时更改 MessageType 属性。 这允许应用在需要时在二进制消息和 UTF-8 消息之间切换。
必须在 MessageWebSocket 连接之前设置 OutboundBufferSizeInBytes 属性。 连接 MessageWebSocket 后设置此属性不起作用。
在 MessageWebSocket 连接之前,必须设置对 MessageWebSocketControl 上任何其他属性值的更改。 因此,如果需要对 MaxMessageSize、OutboundBufferSizeInBytes、ProxyCredential 或 ServerCredential 属性进行更改,则必须在成功调用 MessageWebSocket 上的 ConnectAsync 方法之前进行这些更改。