IWebSocketInformation IWebSocketInformation IWebSocketInformation IWebSocketInformation Interface

Definition

Provides socket information on an IWebSocket object.

public : interface IWebSocketInformation
public interface IWebSocketInformation
Public Interface IWebSocketInformation
// You can't instantiate an interface directly in JavaScript. You can use objects that implement the interface, however.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

BandwidthStatistics 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
var bandwidthStatistics = iWebSocketInformation.bandwidthStatistics;
Value
BandwidthStatistics BandwidthStatistics BandwidthStatistics BandwidthStatistics

Bandwidth information for network data transfer on an IWebSocket object.

See Also

LocalAddress 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
var hostName = iWebSocketInformation.localAddress;
Value
HostName HostName HostName HostName

The IP address associated with an IWebSocket object.

Protocol Protocol Protocol Protocol

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

public : Platform::String Protocol { get; }
public string Protocol { get; }
Public ReadOnly Property Protocol As string
var string = iWebSocketInformation.protocol;
Value
Platform::String string string string

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.