IWebSocketInformation.Protocol property

Applies to Windows and Windows Phone

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

Syntax


string Protocol { get; }

Property value

Type: System.String [.NET] | Platform::String [C++]

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.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.Networking.Sockets
Windows::Networking::Sockets [C++]

Metadata

Windows.winmd

See also

IWebSocketInformation

 

 

Show:
© 2014 Microsoft