MessageWebSocketControl class

Provides socket control data on a MessageWebSocket.

Syntax

var messageWebSocketControl = MessageWebSocket.Control;

Attributes

DualApiPartitionAttribute()

MarshalingBehaviorAttribute(Agile)

VersionAttribute(NTDDI_WIN8)

Members

The MessageWebSocketControl class has these types of members:

• Methods
• Properties

Methods

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

Properties

The MessageWebSocketControl class has these properties.

Remarks

A MessageWebSocketControl object is automatically created with the parent MessageWebSocket object. The MessageWebSocket.Control property provides access to the associated MessageWebSocketControl object.

The following example creates a MessageWebSocket, and then demonstrates how to set the MessageWebSocketControl.MessageType property to binary. (Other properties may be set in a similar manner.) After this is done, the app can connect the MessageWebSocket.

var clientWebSocket = new Windows.Networking.Sockets.MessageWebSocket();

// Get the current setting for this option
// This isn't required, but it shows how to get the current setting
var currentSetting = clientWebSocket.control.messageType;

// Set messageType to binary 
clientWebSocket.control.messageType = Windows.Networking.Sockets.SocketMessageType.binary;
   
// Now you can call the ConnectAsync method to connect the MessageWebSocket.

For more information about using MessageWebSocketControl, see How to use advanced WebSocket controls.

Requirements

See also

MessageWebSocket

How to use advanced WebSocket controls

Build date: 2/25/2013