Skip to main content
StreamWebSocketInformation.Protocol | protocol property

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

Syntax


var protocol = streamWebSocketInformation.protocol;

public string Protocol { get; }

Public ReadOnly Property Protocol As String

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

Property value

Type: String [JavaScript] | 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 StreamWebSocket is connected, this property is null.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

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

Other
How to use advanced WebSocket controls (HTML)
How to use advanced WebSocket controls (XAML)
Reference
StreamWebSocket
StreamWebSocketControl.SupportedProtocols
StreamWebSocketInformation