StreamWebSocket StreamWebSocket StreamWebSocket StreamWebSocket Class

Creates a new StreamWebSocket object.

public : StreamWebSocket()public StreamWebSocket()Public Sub New()// You can use this method in JavaScript.

Gets socket control data on a StreamWebSocket object.

public : StreamWebSocketControl Control { get; }public StreamWebSocketControl Control { get; }Public ReadOnly Property Control As StreamWebSocketControl// You can use this property in JavaScript.

Remarks

The Control property gets the StreamWebSocketControl instance associated with a StreamWebSocket object.

A StreamWebSocketControl object is automatically created with the parent StreamWebSocket object. The StreamWebSocketControl instance can then be used to get or set control data used by the StreamWebSocket object. These properties on the MessageWebSocketControl instance include the following:

• NoDelay - A value that indicates whether the Nagle algorithm is used on a StreamWebSocket object.
• OutboundBufferSizeInBytes - The size, in bytes, of the send buffer to be used for sending data on a StreamWebSocket object.
• ProxyCredential - The credential to use to authenticate to the proxy server through HTTP header authentication using a StreamWebSocket object.
• ServerCredential - The credential to use to authenticate to the WebSocket server through HTTP header authentication using a StreamWebSocket object.
• SupportedProtocols - Gets a collection that can be used to add a list of supported sub-protocols that will be advertised to the server during the connect handshake.

Any changes to the StreamWebSocketControl property values must be set before the StreamWebSocket is connected. As a result if you need to make changes to the NoDelay, OutboundBufferSizeInBytes, ProxyCredential, ServerCredential, or SupportedProtocols properties, then these changes must occur before a successful call to the ConnectAsync method on the StreamWebSocket.

See Also

How to use advanced WebSocket controls

StreamWebSocketControlStreamWebSocketControlStreamWebSocketControlStreamWebSocketControl

Gets socket information on a StreamWebSocket object.

public : StreamWebSocketInformation Information { get; }public StreamWebSocketInformation Information { get; }Public ReadOnly Property Information As StreamWebSocketInformation// You can use this property in JavaScript.

Gets the input stream to read from the remote destination on a StreamWebSocket object.

public : IInputStream InputStream { get; }public IInputStream InputStream { get; }Public ReadOnly Property InputStream As IInputStream// You can use this property in JavaScript.

Remarks

This property is used with the DataReader object to read incoming data received from the remote network destination on a socket object.

See Also

IInputStreamIInputStreamIInputStreamIInputStream

Gets the output stream to write to the remote network destination on a StreamWebSocket object.

public : IOutputStream OutputStream { get; }public IOutputStream OutputStream { get; }Public ReadOnly Property OutputStream As IOutputStream// You can use this property in JavaScript.

Remarks

This property is used with the DataWriter object to write outgoing data to be sent to the remote network destination on a StreamWebSocket object.

The following specific errors can occur when you call IOutputStream.FlushAsync on the OutputStream of a StreamWebSocket if the websocket is in an invalid state at the time.

• If the websocket instance has been explicitly closed (via delete, Dispose, or Close) or implicitly closed (fallen out of scope), FlushAsync throws an RO_E_CLOSED exception.
• If the IOutputStream object associated with the websocket has been explicitly closed (via delete, Dispose, or Close) or implicitly closed (for example, by disposing of a DataWriter instance before calling DetachStream on it), FlushAsync throws an RO_E_CLOSED exception.
• If the websocket is not connected yet (ConnectAsync has not been called), then FlushAsync throws an E_ILLEGAL_METHOD_CALL exception.

See Also

IOutputStreamIOutputStreamIOutputStreamIOutputStream

Closes the StreamWebSocket and sends an empty close frame to the server.

public : void Close()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.

Remarks

The Close method is used by Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the Close method is exposed as the method on the StreamWebSocket. For apps written in C++, the Close method will be called when using the delete keyword on the object.

See Also

Close(UInt16, String)Close(UInt16, String)Close(UInt16, String)Close(UInt16, String)

Closes the StreamWebSocket and indicates a reason for the closure.

public : void Close(unsigned short code, PlatForm::String reason)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.

See Also

Close()Close()Close()Close()

Starts an asynchronous operation to connect to a remote network destination on a StreamWebSocket object.

public : IAsyncAction ConnectAsync(Uri uri)public IAsyncAction ConnectAsync(Uri uri)Public Function ConnectAsync(uri As Uri) As IAsyncAction// You can use this method in JavaScript.

Remarks

The ConnectAsync method initiates the WebSocket handshake with a remote network destination, and then negotiates the subprotocol.

For WebSocket connections over TCP, use the ws:// scheme in the uri. For secure WebSocket connections over TLS/SSL, use the wss:// scheme.

See Also

UriUriUriUri

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This member is not implemented in C++void Dispose()Sub Disposevoid Dispose()

Adds an HTTP request header to the HTTP request message used in the WebSocket protocol handshake by the StreamWebSocket object.

public : void SetRequestHeader(PlatForm::String headerName, PlatForm::String headerValue)public void SetRequestHeader(String headerName, String headerValue)Public Function SetRequestHeader(headerName As String, headerValue As String) As void// You can use this method in JavaScript.

Remarks

The SetRequestHeader method must be called prior to calling the ConnectAsync method. Calling the SetRequestHeader method after calling the ConnectAsync method will result in an error.

Using the SetRequestHeader method to add a Sec-WebSocket-Extensions header is not supported.

See Also

ConnectAsync(Uri)ConnectAsync(Uri)ConnectAsync(Uri)ConnectAsync(Uri)

Occurs when a close frame is received on the StreamWebSocket object as part of the close handshake.

public : event TypedEventHandler Closed<IWebSocket,  WebSocketClosedEventArgs>public event TypedEventHandler Closed<IWebSocket,  WebSocketClosedEventArgs>Public Event Closed<IWebSocket,  WebSocketClosedEventArgs>// You can use this event in JavaScript.

Occurs when a new StreamWebSocket connection to a secured server URI (wss: protocol) is being validated. Handle this event if you want to implement custom server validation for the connection.

public : event TypedEventHandler ServerCustomValidationRequested<StreamWebSocket,  WebSocketServerCustomValidationRequestedEventArgs>public event TypedEventHandler ServerCustomValidationRequested<StreamWebSocket,  WebSocketServerCustomValidationRequestedEventArgs>Public Event ServerCustomValidationRequested<StreamWebSocket,  WebSocketServerCustomValidationRequestedEventArgs>// You can use this event in JavaScript.

Device family	Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v3)
Capabilities	privateNetworkClientServer internetClient

Remarks

Note that this event is raised after the default OS validation has been performed successfully, and that the default OS validation includes taking the IgnorableServerCertificateErrors control option into account.

Use the WebSocketServerCustomValidationRequestedEventArgs properties to access the server certificate and intermediate certificates being offered for validation.

In order to ensure proper completion, if your custom validation process involves any async operations, be sure to use the WebSocketServerCustomValidationRequestedEventArgs.GetDeferral method to get a deferral object that your event handler holds for the duration of the validation operation. When your validation is complete, you must call Deferral.Complete whether you accept or reject validation.

As an example of the kind of validation you can do in this event handler: you could compare the server certificate to a locally stored trusted certificate that matches the expected server certificate. In your event handler, you would compare the SHA-256 hash of the local certificate to the hash of the server certificate. If the hash values match, then the certificates are assumed to match, and server validation should succeed. If the hash values don't match, then the certificates don't match and validation should fail.

To indicate validation failure, call the WebSocketServerCustomValidationRequestedEventArgs.Reject method. To indicate validation success, simply return from the event handler.

Note that whether validation succeeds or fails, you must call Deferral.Complete on the deferral object you acquired when you started the validation process.