WebSocket WebSocket WebSocket WebSocket Class

Definición

La clase WebSocket permite a las aplicaciones enviar y recibir datos después de que se haya completado la actualización de WebSocket.The WebSocket class allows applications to send and receive data after the WebSocket upgrade has completed.

public ref class WebSocket abstract : IDisposable
public abstract class WebSocket : IDisposable
type WebSocket = class
    interface IDisposable
Public MustInherit Class WebSocket
Implements IDisposable
Herencia
WebSocketWebSocketWebSocketWebSocket
Derivado
Implementaciones

Comentarios

Algunas de las clases del System.Net.WebSockets espacio de nombres se admiten en Windows 7, Windows Vista SP2 y Windows Server 2008.Some of the classes in the System.Net.WebSockets namespace are supported on Windows 7, Windows Vista SP2, and Windows Server 2008. Sin embargo, las únicas implementaciones públicas de WebSockets de cliente y servidor se admiten en Windows 8 y Windows Server 2012.However, the only public implementations of client and server WebSockets are supported on Windows 8 and Windows Server 2012. Las clases y los elementos de clase System.Net.WebSockets del espacio de nombres que se admiten en Windows 7, Windows Vista SP2 y Windows Server 2008 son clases abstractas.The classes and class elements in the System.Net.WebSockets namespace that are supported on Windows 7, Windows Vista SP2, and Windows Server 2008 are abstract classes. Esto permite que un desarrollador de aplicaciones herede y extienda estas clases abstractas con una implementación real de WebSockets de cliente.This allows an application developer to inherit and extend these abstract classes with an actual implementation of client WebSockets.

Constructores

WebSocket() WebSocket() WebSocket() WebSocket()

Crea una instancia de la clase WebSocket.Creates an instance of the WebSocket class.

Propiedades

CloseStatus CloseStatus CloseStatus CloseStatus

Indica la razón por la que el extremo remoto inició el protocolo de enlace de clausura.Indicates the reason why the remote endpoint initiated the close handshake.

CloseStatusDescription CloseStatusDescription CloseStatusDescription CloseStatusDescription

Permite que el extremo remoto describa la razón por la que la conexión se cerró.Allows the remote endpoint to describe the reason why the connection was closed.

DefaultKeepAliveInterval DefaultKeepAliveInterval DefaultKeepAliveInterval DefaultKeepAliveInterval

Obtiene el intervalo de mantenimiento del protocolo WebSocket predeterminado.Gets the default WebSocket protocol keep-alive interval.

State State State State

Devuelve el estado actual de la conexión WebSocket.Returns the current state of the WebSocket connection.

SubProtocol SubProtocol SubProtocol SubProtocol

Obtiene el subprotocolo negociado durante el protocolo de enlace de apertura.Gets the subprotocol that was negotiated during the opening handshake.

Métodos

Abort() Abort() Abort() Abort()

Anula la conexión de WebSocket y cualquier operación pendiente de E/S.Aborts the WebSocket connection and cancels any pending IO operations.

CloseAsync(WebSocketCloseStatus, String, CancellationToken) CloseAsync(WebSocketCloseStatus, String, CancellationToken) CloseAsync(WebSocketCloseStatus, String, CancellationToken) CloseAsync(WebSocketCloseStatus, String, CancellationToken)

Cierra la conexión de WebSocket como una operación asincrónica mediante el protocolo de enlace de cierre definido en la sección 7 de la especificación del protocolo WebSocket.Closes the WebSocket connection as an asynchronous operation using the close handshake defined in the WebSocket protocol specification section 7.

CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken) CloseOutputAsync(WebSocketCloseStatus, String, CancellationToken)

Inicia o completa el protocolo de enlace de cierre definido en la sección 7 de la especificación del protocolo WebSocket.Initiates or completes the close handshake defined in the WebSocket protocol specification section 7.

CreateClientBuffer(Int32, Int32) CreateClientBuffer(Int32, Int32) CreateClientBuffer(Int32, Int32) CreateClientBuffer(Int32, Int32)

Crear los búferes del cliente para utilizar con esta instancia WebSocket .Create client buffers to use with this WebSocket instance.

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

Permite que los llamadores creen una clase WebSocket del lado cliente que utilice el WSPC para los marcos.Allows callers to create a client side WebSocket class which will use the WSPC for framing purposes.

CreateFromStream(Stream, Boolean, String, TimeSpan) CreateFromStream(Stream, Boolean, String, TimeSpan) CreateFromStream(Stream, Boolean, String, TimeSpan) CreateFromStream(Stream, Boolean, String, TimeSpan)

Crea un objeto WebSocket que opera en la secuencia especificada, la cual representa una conexión de socket web.Creates a new WebSocket object that operates on the specified stream, which represents a web socket connection.

CreateServerBuffer(Int32) CreateServerBuffer(Int32) CreateServerBuffer(Int32) CreateServerBuffer(Int32)

Crea un búfer del servidor de WebSocket.Creates a WebSocket server buffer.

Dispose() Dispose() Dispose() Dispose()

Se usa para limpiar recursos no administrados para ASP.NET e implementaciones que se hospedan a sí mismas.Used to clean up unmanaged resources for ASP.NET and self-hosted implementations.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
IsApplicationTargeting45() IsApplicationTargeting45() IsApplicationTargeting45() IsApplicationTargeting45()

Devuelve un valor que indica si la instancia WebSocket tiene como destino .NET Framework 4.5.NET Framework 4.5.Returns a value that indicates if the WebSocket instance is targeting .NET Framework 4.5.NET Framework 4.5.

IsStateTerminal(WebSocketState) IsStateTerminal(WebSocketState) IsStateTerminal(WebSocketState) IsStateTerminal(WebSocketState)

Devuelve un valor que indica si el estado de la instancia de WebSocket es cerrada o anulada.Returns a value that indicates if the state of the WebSocket instance is closed or aborted.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ReceiveAsync(ArraySegment<Byte>, CancellationToken) ReceiveAsync(ArraySegment<Byte>, CancellationToken) ReceiveAsync(ArraySegment<Byte>, CancellationToken) ReceiveAsync(ArraySegment<Byte>, CancellationToken)

Recibe datos de la conexión de WebSocket de forma asincrónica.Receives data from the WebSocket connection asynchronously.

ReceiveAsync(Memory<Byte>, CancellationToken) ReceiveAsync(Memory<Byte>, CancellationToken) ReceiveAsync(Memory<Byte>, CancellationToken) ReceiveAsync(Memory<Byte>, CancellationToken)
RegisterPrefixes() RegisterPrefixes() RegisterPrefixes() RegisterPrefixes()

Permite que los llamadores registren los prefijos para solicitudes de WebSocket (WS y WSS).Allows callers to register prefixes for WebSocket requests (ws and wss).

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

Envía datos a través de la conexión WebSocket de forma asincrónica.Sends data over the WebSocket connection asynchronously.

SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken) SendAsync(ReadOnlyMemory<Byte>, WebSocketMessageType, Boolean, CancellationToken)
ThrowOnInvalidState(WebSocketState, WebSocketState[]) ThrowOnInvalidState(WebSocketState, WebSocketState[]) ThrowOnInvalidState(WebSocketState, WebSocketState[]) ThrowOnInvalidState(WebSocketState, WebSocketState[])

Comprueba que la conexión está en un estado esperado.Verifies that the connection is in an expected state.

ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Se aplica a