MessageWebSocketInformation.Protocol Property

Reference

Definition

Namespace:: Windows.Networking.Sockets

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Gets the WebSocket sub-protocol negotiated with the server during WebSocket handshake on a MessageWebSocket object.

public:
 property Platform::String ^ Protocol { Platform::String ^ get(); };

winrt::hstring Protocol();

public string Protocol { get; }

var string = messageWebSocketInformation.protocol;

Public ReadOnly Property Protocol As String

Property Value

String

Platform::String

winrt::hstring

The sub-protocol negotiated with the server during the WebSocket handshake.

Implements

Protocol

Remarks

Both a WebSocket client and a WebSocket server may support multiple sub-protocols. During the WebSocket handshake, the server will select one of the sub-protocols from the mutually supported sub-protocols and reply in the "Sec-WebSocket-Protocol" header. The Protocol property will contain the selected sub-protocol string.

Before the MessageWebSocket is connected, this property is null.

Applies to