ServerMessageWebSocketInformation Class

  • Reference

Definition

Namespace:
Windows.Networking.Sockets
Edit

Provides socket information on a ServerMessageWebSocket.

public ref class ServerMessageWebSocketInformation sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 393216)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ServerMessageWebSocketInformation final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 393216)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ServerMessageWebSocketInformation
Public NotInheritable Class ServerMessageWebSocketInformation
Inheritance
Object Platform::Object IInspectable ServerMessageWebSocketInformation
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v6.0)
App capabilities
internetClientServer privateNetworkClientServer

Properties

BandwidthStatistics

Gets bandwidth information for network data transfer on a ServerMessageWebSocket object.

Note that the returned statistics are based on extended TCP statistics, which are enabled by default on Client versions of Windows, but disabled by default for performance reasons on Server versions of Windows. If extended TCP statistics are not available, all returned numerical statistics are set to 0, and boolean statistics are set to false.
LocalAddress

Gets the IP address associated with a ServerMessageWebSocket object.
Protocol

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

Applies to

See also