WebSocket Classe

  • Referência

Definição

Namespace:
System.Net.WebSockets
Assembly:
System.Net.WebSockets.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Origem:
WebSocket.cs
Origem:
WebSocket.cs
Origem:
WebSocket.cs

A classe WebSocket permite que aplicativos enviem e recebam dados após a atualização do WebSocket ter sido concluída.

public ref class WebSocket abstract : IDisposable
public abstract class WebSocket : IDisposable
type WebSocket = class
    interface IDisposable
Public MustInherit Class WebSocket
Implements IDisposable
Herança
Object
WebSocket
Derivado
Implementações
IDisposable

Comentários

Algumas das classes 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. As classes e os elementos de classe no System.Net.WebSockets namespace com suporte no Windows 7, Windows Vista SP2 e Windows Server 2008 são classes abstratas. Isso permite que um desenvolvedor de aplicativos herde e estenda essas classes abstratas com uma implementação real de WebSockets cliente.

Há suporte para exatamente um envio e um recebimento em cada WebSocket 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. Serialize o acesso por meio de qualquer mecanismo que funcione melhor para você, por exemplo, usando um bloqueio ou um semáforo.

Construtores

WebSocket()

Cria uma instância de WebSocket classe.

Propriedades

CloseStatus

Indica o motivo por que o ponto de extremidade remoto iniciou handshake de fechamento.
CloseStatusDescription

Permite que o ponto de extremidade remoto descreva o motivo por que a conexão foi fechada.
DefaultKeepAliveInterval

Obtém o intervalo keep-alive padrão do protocolo WebSocket.
State

Retorna o estado atual da conexão WebSocket.
SubProtocol

Obtém o subprotocolo que foi negociado durante o handshake de abertura.

Métodos

Abort()

Anula a conexão WebSocket e cancela as operações de E/S pendentes.
CloseAsync(WebSocketCloseStatus, String, CancellationToken)

Fecha a conexão WebSocket como uma operação assíncrona usando o handshake de fechamento definido na seção 7 da especificação do protocolo WebSocket.
CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)

Inicia ou conclui o handshake de fechamento definido na seção 7 da especificação do protocolo WebSocket.
CreateClientBuffer(Int32, Int32)

Crie o cliente de buffers a ser usado com essa instância WebSocket.
CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>)

Esta API dá suporte à infraestrutura do produto e não deve ser usada diretamente do seu código.

Permite que os chamadores criem uma classe WebSocket do lado do cliente que usará o WSPC para fins de enquadramento.
CreateFromStream(Stream, Boolean, String, TimeSpan)

Cria um objeto WebSocket que opera no fluxo especificado, que representa uma conexão de soquete da Web.
CreateFromStream(Stream, WebSocketCreationOptions)

Cria um WebSocket que opera em um Stream que representa uma conexão de soquete da Web.
CreateServerBuffer(Int32)

Cria um buffer de servidor WebSocket.
Dispose()

Usado para limpar os recursos não gerenciados para as implementações auto-hospedadas e de ASP.NET.
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)
IsApplicationTargeting45()
Obsoleto.
Obsoleto.

Retorna um valor que indica se a instância do WebSocket está direcionando .NET Framework 4.5.
IsStateTerminal(WebSocketState)

Retorna um valor que indica se o estado da instância do WebSocket é fechado ou anulado.
MemberwiseClone()

Cria uma cópia superficial do Object atual.

(Herdado de Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken)

Recebe dados da conexão WebSocket de forma assíncrona.
ReceiveAsync(Memory<Byte>, CancellationToken)

Recebe dados da conexão WebSocket de forma assíncrona.
RegisterPrefixes()

Esta API dá suporte à infraestrutura do produto e não deve ser usada diretamente do seu código.

Obsoleto.

Permite que os chamadores registrem os prefixos para solicitações de WebSocket (ws e wss).
SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)

Envia dados pela conexão WebSocket de forma assíncrona.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)

Envia dados pela conexão WebSocket de forma assíncrona.
SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, WebSocketMessageFlags, CancellationToken)

Envia dados pela conexão WebSocket de forma assíncrona.
ThrowOnInvalidState(WebSocketState, WebSocketState[])

Verifica se a conexão está em um estado esperado.
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Aplica-se a