MessageWebSocket Classe

Definição

Namespace:

Windows.Networking.Sockets

Dá suporte à comunicação de rede que permite ler e gravar mensagens inteiras usando um WebSocket.

public ref class MessageWebSocket sealed : IClosable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class MessageWebSocket final : IClosable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class MessageWebSocket : System.IDisposable

function MessageWebSocket()

Public NotInheritable Class MessageWebSocket
Implements IDisposable

Herança

Object Platform::Object IInspectable MessageWebSocket

Atributos

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implementações

IClosable IDisposable IWebSocket

Requisitos do Windows

Requisitos	Description
Família de dispositivos	Windows 10 (introduzida na 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v1.0)
Funcionalidades do aplicativo	internetClient privateNetworkClientServer

Comentários

A classe MessageWebSocket fornece uma abstração baseada em mensagem do protocolo WebSocket. Ao usar MessageWebSocket, toda a mensagem WebSocket é lida ou escrita em uma única operação. Por outro lado, o StreamWebSocket permite que seções de uma mensagem sejam lidas com cada operação de leitura, em vez de exigir que toda a mensagem seja lida em uma única operação.

Para mensagens UTF-8, MessageWebSocket deve ser usado. StreamWebSocket só dá suporte a mensagens binárias.

Tratamento de exceções

Você deve escrever código para lidar com exceções ao chamar métodos assíncronos na classe MessageWebSocket. As exceções podem resultar de erros de validação de parâmetro, falhas de resolução de nomes e erros de rede. Exceções de erros de rede (perda de conectividade, falhas de conexão e falhas de servidor HTTP, por exemplo) podem ocorrer a qualquer momento. Esses erros resultam na geração de exceções. Se não for tratada pelo aplicativo, uma exceção poderá fazer com que todo o aplicativo seja encerrado pelo runtime.

O Windows. O namespace Networking.Sockets tem um método auxiliar conveniente e enumeração para lidar com erros ao usar WebSockets. Isso pode ser útil para lidar com exceções de rede específicas de forma diferente em seu aplicativo. Um aplicativo também pode usar o HRESULT da exceção em erros de validação de parâmetro para saber mais informações detalhadas sobre o erro que causou a exceção.

Para obter mais informações sobre possíveis exceções e como lidar com exceções, consulte Tratamento de exceções em aplicativos de rede.

Usando MessageWebSocket no Windows Server 2012

No Windows Server 2012 e Windows Server 2012 R2, o Windows.Networking.dll que implementa a maioria das classes no Windows. O namespace Networking.Sockets falhará ao carregar, a menos que o recurso do Media Foundation esteja habilitado. Como resultado, os aplicativos que usam o MessageWebSocket e as classes WebSocket relacionadas no Windows. O namespace Networking.Sockets falhará se o recurso do Media Foundation estiver desabilitado. instalações Windows Server 2012 ou Windows Server 2012 R2 com o recurso do Media Foundation desabilitado.

O recurso do Media Foundation pode ser habilitado em Windows Server 2012 ou Windows Server 2012 R2 usando Gerenciador do Servidor ou inserindo o seguinte texto em um prompt de comando ou em um script:

dism /online /enable-feature /featurename:ServerMediaFoundation Depois que o recurso do Media Foundation estiver habilitado, o usuário será solicitado a reiniciar. Depois que o computador é reiniciado, classes para soquetes e WebSockets no Windows. O namespace Networking.Sockets funcionará conforme o esperado.

Histórico de versões

Versão do Windows	Versão do SDK	Valor adicionado
1607	14393	ServerCustomValidationRequested
1803	17134	SendFinalFrameAsync
1803	17134	SendNonfinalFrameAsync

Construtores

Nome	Description
MessageWebSocket()	Cria um novo objeto MessageWebSocket .

Propriedades

Nome	Description
Control	Obtém dados de controle de soquete em um objeto MessageWebSocket .
Information	Obtém informações de soquete em um objeto MessageWebSocket .
OutputStream	Obtém o fluxo de saída a ser gravado no destino de rede remota em um objeto MessageWebSocket .

Métodos

Nome	Description
Close()	Fecha o objeto MessageWebSocket e envia um quadro de fechamento vazio para o servidor.
Close(UInt16, String)	Fecha o objeto MessageWebSocket e indica um motivo para o fechamento.
ConnectAsync(Uri)	Inicia uma operação assíncrona para se conectar a um destino de rede remota em um objeto MessageWebSocket .
Dispose()	Executa tarefas definidas pelo aplicativo associadas à liberação, liberação ou redefinição de recursos não gerenciados.
SendFinalFrameAsync(IBuffer)	De forma assíncrona (com progresso) grava um quadro de dados em um fluxo sequencial, com a semântica de que este é o último quadro em uma mensagem WebSocket (o bit FIN nesse quadro é definido como 1). Esse método e SendNonfinalFrameAsync permitem que você envie quadros WebSocket individuais.
SendNonfinalFrameAsync(IBuffer)	De forma assíncrona (com progresso) grava um quadro de dados em um fluxo sequencial, com a semântica que mais quadros seguirão para a mesma mensagem WebSocket (o bit FIN nesse quadro é definido como 0). Esse método e SendFinalFrameAsync permitem que você envie quadros WebSocket individuais.
SetRequestHeader(String, String)	Adiciona um cabeçalho de solicitação HTTP à mensagem de solicitação HTTP usada no handshake de protocolo WebSocket pelo objeto MessageWebSocket .

Eventos

Nome	Description
Closed	Ocorre quando um quadro próximo é recebido no objeto MessageWebSocket como parte do handshake de fechamento.
MessageReceived	Um evento que indica que uma mensagem foi recebida no objeto MessageWebSocket .
ServerCustomValidationRequested	Ocorre quando uma nova conexão MessageWebSocket com um URI de servidor seguro (wss: protocolo) está sendo validada. Manipule esse evento se você quiser implementar a validação do servidor personalizado para a conexão.

Confira também

• MessageWebSocketControl
• MessageWebSocketInformation
• StreamWebSocket
• WebSockets
• Tratamento de exceções em aplicativos de rede
• Exemplo de WebSocket