StreamWebSocketInformation class

Applies to Windows and Windows Phone

Provides socket information on a StreamWebSocket object.

Syntax


var streamWebSocketInformation = StreamWebSocket.Information;

Attributes

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

Members

The StreamWebSocketInformation class has these types of members:

Methods

The StreamWebSocketInformation class inherits methods from the Object class (C#/VB/C++).

Properties

The StreamWebSocketInformation class has these properties.

PropertyAccess typeDescription

BandwidthStatistics

Read-onlyGets bandwidth information for network data transfer on a StreamWebSocket object.

LocalAddress

Read-onlyGets the IP address associated with a StreamWebSocket object.

Protocol

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

 

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

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

DLL

Windows.Networking.dll

Capabilities

internetClient
privateNetworkClientServer

See also

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:
© 2014 Microsoft