IWebSocketInformation.Protocol Property

Definition

Namespace:

Windows.Networking.Sockets

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

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

winrt::hstring Protocol();

public string Protocol { get; }

var string = iWebSocketInformation.protocol;

Public ReadOnly Property Protocol As String

Property Value

String

Platform::String

winrt::hstring

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

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 IWebSocket is connected, this property is null.