[This documentation is preliminary and is subject to change.]
Applies to: Metro style apps | desktop apps
Supports network communication that allows reading and writing streams using a WebSocket.
Syntax
var streamWebSocket = new Windows.Networking.Sockets.StreamWebSocket();
Attributes
- ActivatableAttribute(NTDDI_WIN8)
- DualApiPartitionAttribute()
- MarshalingBehaviorAttribute(Agile)
- ThreadingAttribute(Both)
- VersionAttribute(NTDDI_WIN8)
Members
The StreamWebSocket class has these types of members:
Constructors
The StreamWebSocket class has these constructors.
| Constructor | Description |
|---|---|
| StreamWebSocket | Creates a new StreamWebSocket object. |
Events
The StreamWebSocket class has these events.
| Event | Description |
|---|---|
| Closed | Occurs when a close frame is received on the StreamWebSocket object as part of the close handshake. |
Methods
The StreamWebSocket class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.
| Method | Description |
|---|---|
| Close() | Closes the StreamWebSocket and sends an empty close frame to the server. |
| Close(UInt16, String) | Closes the StreamWebSocket and indicates a reason for the closure. |
| ConnectAsync | Starts an asynchronous operation to connect to a remote network destination on a StreamWebSocket object. |
| SetRequestHeader | Adds an HTTP request header to the HTTP request message used in the WebSocket protocol handshake by the StreamWebSocket object. |
Properties
The StreamWebSocket class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets socket control data on a StreamWebSocket object. | |
| Read-only | Gets socket information on a StreamWebSocket object. | |
| Read-only | Gets the input stream to read from the remote destination on a StreamWebSocket object. | |
| Read-only | Gets the output stream to write to the remote network destination on a StreamWebSocket object. |
Remarks
The StreamWebSocket class provides a stream-based abstraction of the message-based WebSocket protocol. This is useful for scenarios in which large files (such as photos or movies) need to be transferred. Using StreamWebSocket allows sections of a message to be read with each read operation, rather than requiring the entire message to be read in a single operation (as with MessageWebSocket).
StreamWebSocket only supports binary messages. For UTF-8 messages, MessageWebSocket must be used.
Requirements
|
Minimum supported client | Windows 8 Release Preview |
|---|---|
|
Minimum supported server | Windows Server 2012 |
|
Namespace |
|
|
Metadata |
|
|
DLL |
|
|
Capabilities |
|
See also
- Connecting to a WebSocket service
- Quickstart: Connecting using a StreamWebSocket
- Connecting with WebSockets sample
- ControlChannelTrigger StreamWebSocket sample
Build date: 5/22/2012
