ClientWebSocket Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Fornece um cliente para se conectar aos serviços do WebSocket.
public ref class ClientWebSocket sealed : System::Net::WebSockets::WebSocket
public sealed class ClientWebSocket : System.Net.WebSockets.WebSocket
type ClientWebSocket = class
inherit WebSocket
Public NotInheritable Class ClientWebSocket
Inherits WebSocket
- Herança
Comentários
Algumas das classes e elementos de classe no System.Net.WebSockets namespace têm suporte no Windows 7, Windows Vista SP2 e Windows Server 2008. No entanto, as únicas implementações públicas de WebSockets de cliente e servidor têm suporte em Windows 8 e Windows Server 2012. Os elementos de classe no System.Net.WebSockets namespace com suporte no Windows 7, Windows Vista SP2 e Windows Server 2008 são elementos de classe abstratos. Isso permite que um desenvolvedor de aplicativos herde e estenda essas classes abstratas e elementos de classe com uma implementação real de WebSockets cliente.
Há suporte para exatamente um envio e um recebimento em cada ClientWebSocket objeto em paralelo. Não há suporte para a emissão de vários envios ou vários recebimentos ao mesmo tempo (por exemplo, sem aguardar ou de vários threads sem sincronização) e resultará em um comportamento indefinido. Verifique se a operação anterior é aguardada (ou concluída) antes de emitir a próxima. Você deve serializar o acesso por meio de qualquer mecanismo que funcione melhor para você, por exemplo, usando um bloqueio ou um semáforo.
Construtores
| Nome | Description |
|---|---|
| ClientWebSocket() |
Cria uma instância de ClientWebSocket classe. |
Propriedades
| Nome | Description |
|---|---|
| CloseStatus |
Obtém o motivo pelo qual o handshake de fechamento foi iniciado na instância ClientWebSocket. |
| CloseStatusDescription |
Obtém uma descrição do motivo pelo qual a instância ClientWebSocket foi fechada. |
| HttpResponseHeaders |
Obtém (se CollectHttpResponseDetails estiver definido) ou define os cabeçalhos de resposta de atualização. |
| HttpStatusCode |
Obtém a resposta de atualização status código se CollectHttpResponseDetails estiver definido. |
| Options |
Obtém as opções do WebSocket para a instância ClientWebSocket. |
| State |
Obtém o estado do WebSocket da instância ClientWebSocket. |
| SubProtocol |
Obtém o subprotocolo WebSocket com suporte para a instância ClientWebSocket. |
Métodos
| Nome | Description |
|---|---|
| Abort() |
Anula a conexão e cancela as operações de E/S pendentes. |
| CloseAsync(WebSocketCloseStatus, String, CancellationToken) |
Fecha a instância ClientWebSocket como uma operação assíncrona. |
| CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) |
Fecha a saída da instância ClientWebSocket como uma operação assíncrona. |
| ConnectAsync(Uri, CancellationToken) |
Conecta-se a um servidor WebSocket como uma operação assíncrona. |
| ConnectAsync(Uri, HttpMessageInvoker, CancellationToken) |
Conecta-se a um servidor WebSocket como uma operação assíncrona. |
| Dispose() |
Libera os recursos não gerenciados usados pela instância ClientWebSocket. |
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| GetHashCode() |
Serve como a função de hash padrão. (Herdado de Object) |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| MemberwiseClone() |
Cria uma cópia superficial do Object atual. (Herdado de Object) |
| ReceiveAsync(ArraySegment<Byte>, CancellationToken) |
Recebe dados no ClientWebSocket como uma operação assíncrona. |
| ReceiveAsync(Memory<Byte>, CancellationToken) |
Recebe dados no ClientWebSocket como uma operação assíncrona. |
| ReceiveAsync(Memory<Byte>, CancellationToken) |
Recebe dados da conexão WebSocket de forma assíncrona. (Herdado de WebSocket) |
| SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Envia dados no ClientWebSocket como uma operação assíncrona. |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Envia dados no ClientWebSocket de um intervalo de memória de bytes somente leitura como uma operação assíncrona. |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) |
Envia dados pela conexão WebSocket de forma assíncrona. (Herdado de WebSocket) |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken) |
Envia dados no ClientWebSocket de um intervalo de memória de bytes somente leitura como uma operação assíncrona. |
| SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken) |
Envia dados pela conexão WebSocket de forma assíncrona. (Herdado de WebSocket) |
| ToString() |
Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object) |