WebSocket Classe

Definição

A classe WebSocket permite que aplicações enviem e recebam dados após a conclusão da atualização WebSocket.

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

Observações

Algumas das classes no espaço de nomes System.Net.WebSockets são suportadas em Windows 7, Windows Vista SP2 e Windows Server 2008. No entanto, as únicas implementações públicas de WebSockets cliente e servidor são suportadas no Windows 8 e Windows Server 2012. As classes e elementos de classe no espaço de nomes System.Net.WebSockets suportados em Windows 7, Windows Vista SP2 e Windows Server 2008 são classes abstratas. Isto permite que um programador de aplicações herde e estenda estas classes abstratas com uma implementação real dos WebSockets do cliente.

Exatamente um envio e um receção são suportados em paralelo em cada WebSocket objeto. Emitir múltiplos envios ou múltiplas receções ao mesmo tempo (por exemplo, sem aguardar, ou de múltiplas threads sem sincronização) não é suportado e resultará num comportamento indefinido. Certifique-se de que a operação anterior está aguardada (ou concluída) antes de emitir a próxima. Serializa o acesso através do mecanismo que funcionar melhor para ti, por exemplo, usando um cadeado ou um semáforo.

Construtores

Name Description
WebSocket()

Cria uma instância da WebSocket classe.

Propriedades

Name Description
CloseStatus

Indica a razão pela qual o endpoint remoto iniciou o aperto de mão fechado.

CloseStatusDescription

Permite ao endpoint remoto descrever a razão pela qual a ligação foi encerrada.

DefaultKeepAliveInterval

Recebe o intervalo padrão de manutenção do protocolo WebSocket.

State

Devolve o estado atual da ligação WebSocket.

SubProtocol

Recebe o subprotocolo que foi negociado durante o aperto de mão inicial.

Métodos

Name Description
Abort()

Aborta a ligação WebSocket e cancela quaisquer operações de IO pendentes.

CloseAsync(WebSocketCloseStatus, String, CancellationToken)

Fecha a ligação WebSocket como uma operação assíncrona usando o handshake próximo definido na especificação do protocolo WebSocket, secção 7.

CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)

Inicia ou completa o aperto de mão próximo definido na especificação do protocolo WebSocket, secção 7.

CreateClientBuffer(Int32, Int32)

Crie buffers de cliente para usar com esta WebSocket instância.

CreateClientWebSocket(Stream, String, Int32, Int32, TimeSpan, Boolean, ArraySegment<Byte>)

Esta API suporta a infraestrutura de produtos e não é pressuposta para ser utilizada diretamente a partir do seu código.

Permite aos chamadores criar uma classe WebSocket do lado do cliente que utilizará o WSPC para fins de enquadramento.

CreateFromStream(Stream, Boolean, String, TimeSpan)

Cria um novo WebSocket objeto que opera no fluxo especificado, que representa uma ligação a socket web.

CreateServerBuffer(Int32)

Cria um buffer de servidor WebSocket.

Dispose()

Usado para limpar recursos não geridos para ASP.NET e implementações auto-hospedadas.

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetHashCode()

Serve como função de hash predefinida.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
IsApplicationTargeting45()
Obsoleto.
Obsoleto.

Devolve um valor que indica se a instância WebSocket está a direcionar o .NET Framework 4.5.

IsStateTerminal(WebSocketState)

Devolve um valor que indica se o estado da instância WebSocket está fechado ou abortado.

MemberwiseClone()

Cria uma cópia superficial do atual Object.

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

Recebe dados da WebSocket ligação de forma assíncrona.

ReceiveAsync(Memory<Byte>, CancellationToken)

Recebe dados da WebSocket ligação de forma assíncrona.

RegisterPrefixes()

Esta API suporta a infraestrutura de produtos e não é pressuposta para ser utilizada diretamente a partir do seu código.

Permite aos chamadores registar prefixos para pedidos WebSocket (ws e wss).

SendAsync(ArraySegment<Byte>, WebSocketMessageType, Boolean, CancellationToken)

Envia dados pela WebSocket ligação de forma assíncrona.

SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)

Envia dados pela WebSocket ligação de forma assíncrona.

ThrowOnInvalidState(WebSocketState, WebSocketState[])

Verifica que a ligação está num estado esperado.

ToString()

Devolve uma cadeia que representa o objeto atual.

(Herdado de Object)

Aplica-se a