StreamWebSocketInformation Class

Definition

Namespace:

Windows.Networking.Sockets

Provides socket information on a StreamWebSocket object.

public ref class StreamWebSocketInformation sealed : IWebSocketInformation2

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class StreamWebSocketInformation final : IWebSocketInformation2

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class StreamWebSocketInformation : IWebSocketInformation2

Public NotInheritable Class StreamWebSocketInformation
Implements IWebSocketInformation2

Inheritance

Object Platform::Object IInspectable StreamWebSocketInformation

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IWebSocketInformation IWebSocketInformation2

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)
App capabilities	internetClient privateNetworkClientServer

Remarks

StreamWebSocketInformation can be called any time after the StreamWebSocket has been created.

A StreamWebSocketInformation object is automatically created with the parent StreamWebSocket object. The StreamWebSocket.Information property provides access to the associated StreamWebSocketInformation object.

Version history

Windows version	SDK version	Value added
1607	14393	ServerCertificate
1607	14393	ServerCertificateErrors
1607	14393	ServerCertificateErrorSeverity
1607	14393	ServerIntermediateCertificates

Properties

BandwidthStatistics	Gets bandwidth information for network data transfer on a StreamWebSocket 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 StreamWebSocket object.
Protocol	Gets the WebSocket sub-protocol negotiated with the server during WebSocket handshake on a StreamWebSocketobject.
ServerCertificate	Gets the certificate provided by the server when a secure WebSocket connection has been established.
ServerCertificateErrors	Gets a list of the errors that occurred while establishing a secure StreamWebSocket connection.
ServerCertificateErrorSeverity	Gets the category of an error that occurred making an SSL connection with a StreamWebSocket server.
ServerIntermediateCertificates	Gets the intermediate certificates sent by the server during SSL negotiation when making an SSL connection with a StreamWebSocket server.

See also

• StreamWebSocket
• Information
• StreamWebSocketControl
• How to use advanced WebSocket controls
• ControlChannelTrigger StreamWebSocket sample
• WebSockets