I​Web​Socket​Information I​Web​Socket​Information I​Web​Socket​Information Interface

Definition

Provides socket information on an IWebSocket object.

public interface IWebSocketInformationpublic interface IWebSocketInformationPublic Interface IWebSocketInformation
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

BandwidthStatistics BandwidthStatistics BandwidthStatistics

Gets bandwidth information for network data transfer on an IWebSocket object.

public BandwidthStatistics BandwidthStatistics { get; }public BandwidthStatistics BandwidthStatistics { get; }Public ReadOnly Property BandwidthStatistics As BandwidthStatistics
Value
BandwidthStatistics BandwidthStatistics BandwidthStatistics

Bandwidth information for network data transfer on an IWebSocket object.

Attributes

LocalAddress LocalAddress LocalAddress

Gets the IP address associated with an IWebSocket object.

public HostName LocalAddress { get; }public HostName LocalAddress { get; }Public ReadOnly Property LocalAddress As HostName
Value
HostName HostName HostName

The IP address associated with an IWebSocket object.

Attributes

Protocol Protocol Protocol

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

public string Protocol { get; }public string Protocol { get; }Public ReadOnly Property Protocol As string
Value
string string string

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

Attributes

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.