IWebSocketInformation IWebSocketInformation IWebSocketInformation IWebSocketInformation Interface

Provides socket information on an IWebSocket object.

Syntax

Declaration

public interface IWebSocketInformationpublic interface IWebSocketInformationPublic Interface IWebSocketInformationpublic interface IWebSocketInformation

Properties summary

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

Gets the IP address associated with an IWebSocket object.

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

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 BandwidthStatisticspublic BandwidthStatistics BandwidthStatistics { get; }

    Property Value

  • 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 HostNamepublic HostName LocalAddress { get; }

    Property Value

  • Protocol
    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 stringpublic string Protocol { get; }

    Property Value

    • 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.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.GuidAttribute

Details

Assembly

Windows.Networking.Sockets.dll