Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

StreamWebSocketInformation class

Provides socket information on a StreamWebSocket object.

Syntax


public sealed class StreamWebSocketInformation : IWebSocketInformation

Members

The StreamWebSocketInformation class has these types of members:

Properties

The StreamWebSocketInformation class has these properties.

PropertyAccess typeDescription

BandwidthStatistics

Read-only

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

LocalAddress

Read-only

Gets the IP address associated with a StreamWebSocket object.

Protocol

Read-only

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

ServerCertificate

Read-only

Gets the certificate provided by the server when a secure WebSocket connection has been established.

ServerCertificateErrors

Read-only

Gets a list of the errors that occurred while establishing a secure StreamWebSocket connection.

ServerCertificateErrorSeverity

Read-only

Gets the category of an error that occurred making an SSL connection with a StreamWebSocket server.

ServerIntermediateCertificates

Read-only

Gets the intermediate certificates sent by the server during SSL negotiation when making an SSL connection with a StreamWebSocket server.

 

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.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Networking.Sockets
Windows::Networking::Sockets [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Capabilities

internetClient
privateNetworkClientServer

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.Networking.Sockets
Windows::Networking::Sockets [C++]

Metadata

Windows.winmd

Capabilities

internetClient
privateNetworkClientServer

Attributes

[DualApiPartition()]
[MarshalingBehavior(Agile)]
[Version(0x06020000)]

See also

Object
IWebSocketInformation
Other
Connecting with WebSockets (HTML)
Connecting with WebSockets (XAML)
How to use advanced WebSocket controls (HTML)
How to use advanced WebSocket controls (XAML)
Reference
StreamWebSocket.Information
StreamWebSocket
StreamWebSocketControl
Samples
Connecting with WebSockets sample
ControlChannelTrigger StreamWebSocket sample

 

 

Show: