WebSocketPeer

Inherits: PacketPeer < Reference < Object

Una clase que representa una conexión específica de WebSocket.

Descripción

This class represents a specific WebSocket connection, allowing you to do lower level operations with it.

You can choose to write to the socket in binary or text mode, and you can recognize the mode used for writing by the other peer.

Métodos

void

close ( int code=1000, String reason="" )

String

get_connected_host ( ) const

int

get_connected_port ( ) const

int

get_current_outbound_buffered_amount ( ) const

WriteMode

get_write_mode ( ) const

bool

is_connected_to_host ( ) const

void

set_no_delay ( bool enabled )

void

set_write_mode ( WriteMode mode )

bool

was_string_packet ( ) const

Enumeraciones

enum WriteMode:

  • WRITE_MODE_TEXT = 0 --- Especifica que los mensajes de WebSockets deben ser transferidos como carga de texto (sólo se permite el UTF-8 válido).

  • WRITE_MODE_BINARY = 1 --- Especifica que los mensajes de WebSockets deben ser transferidos como carga binaria (se permite cualquier combinación de bytes).

Descripciones de Métodos

  • void close ( int code=1000, String reason="" )

Cierra esta conexión WebSocket. code es el código de estado para el cierre (ver RFC 6455 sección 7.4 para una lista de códigos de estado válidos). reason es la razón legible por el ser humano para cerrar la conexión (puede ser cualquier cadena UTF-8 que sea menor de 123 bytes).

Nota: Para lograr un cierre limpio, deberá seguir sondeando hasta que reciba WebSocketClient.connection_closed o WebSocketServer.client_disconnected.

Nota: Es posible que la exportación a HTML5 no admita todos los códigos de estado. Consulte la documentación específica del navegador para obtener más detalles.

  • String get_connected_host ( ) const

Devuelve la dirección IP del par conectado.

Nota: No disponible en la exportación a HTML5.

  • int get_connected_port ( ) const

Devuelve el puerto remoto del par conectado.

Nota: No disponible en la exportación a HTML5.

  • int get_current_outbound_buffered_amount ( ) const

Returns the current amount of data in the outbound websocket buffer. Note: HTML5 exports use WebSocket.bufferedAmount, while other platforms use an internal buffer.

Obtiene el modo de escritura seleccionado actualmente. Véase WriteMode.

  • bool is_connected_to_host ( ) const

Devuelve true si este par está actualmente conectado.

  • void set_no_delay ( bool enabled )

Deshabilita el algoritmo de Nagle en el socket TCP subyacente (por defecto). Ver StreamPeerTCP.set_no_delay para más información.

Nota: No está disponible en la exportación a HTML5.

Establece el enchufe para usar el WriteMode dado.

  • bool was_string_packet ( ) const

Devuelve true si el último paquete recibido fue enviado como una carga de texto. Ver WriteMode.