Compartilhar via


enumeração WEB_SOCKET_PROPERTY_TYPE (websocket.h)

A enumeração WEB_SOCKET_PROPERTY_TYPE especifica um tipo de propriedade WebSocket.

Syntax

typedef enum _WEB_SOCKET_PROPERTY_TYPE {
  WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE = 0,
  WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE = 1,
  WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE = 2,
  WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE = 3,
  WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE = 4,
  WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE = 5,
  WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE = 6
} WEB_SOCKET_PROPERTY_TYPE;

Constantes

 
WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE
Valor: 0
Tipo de propriedade: ULONG

A propriedade WebSocket é o tamanho do buffer de recebimento interno. O buffer não pode ser menor que 256 bytes.

O padrão é 4096.

Usado com WebSocketCreateClientHandle e WebSocketCreateServerHandle.
WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE
Valor: 1
Tipo de propriedade: ULONG

A propriedade WebSocket é o tamanho interno do buffer de envio. O buffer não pode ser menor que 256 bytes.

O padrão é 4096 em um identificador criado com WebSocketCreateClientHandle e 16 em um identificador criado com WebSocketCreateServerHandle.

Usado com WebSocketCreateClientHandle e WebSocketCreateServerHandle.
WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE
Valor: 2
Tipo de propriedade: BOOL

A propriedade WebSocket é a desabilitação do bit de máscara em quadros de cliente. No cliente, essa propriedade define a chave de máscara como 0. No servidor, essa propriedade permite que o servidor aceite quadros de cliente com o bit de máscara definido como 0. Essa propriedade pode ter sérias implicações de segurança.
Por padrão, essa propriedade não é usada e a máscara está habilitada.

Usado com WebSocketCreateClientHandle e WebSocketCreateServerHandle.
WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE
Valor: 3
Tipo de propriedade: PVOID

A propriedade WebSocket é o buffer usado como um buffer interno. Se o buffer passado não for usado, a biblioteca WebSocket cuidará do gerenciamento de buffer.
O buffer passado deve ser alinhado a um limite de 8 bytes e ter um tamanho maior do que o tamanho do buffer de recebimento + tamanho do buffer de envio + 256 bytes.

Usado com WebSocketCreateClientHandle e WebSocketCreateServerHandle.
WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE
Valor: 4
Tipo de propriedade: BOOL

A propriedade WebSocket desabilita a verificação UTF-8.

Usado com WebSocketCreateClientHandle e WebSocketCreateServerHandle.
WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE
Valor: 5
Tipo de propriedade: ULONG

A propriedade WebSocket é o intervalo, em milissegundos, para enviar um pacote keep alive pela conexão. O intervalo padrão é 30000 (30 segundos). O intervalo mínimo é de 15000 (15 segundos).
Nota O valor padrão para o intervalo keep alive é lido de HKLM:\SOFTWARE\Microsoft\WebSocket\KeepaliveInterval. Se um valor não for definido, o valor padrão de 30000 será usado. Não é possível ter um intervalo keepalive inferior a 15000 milissegundos. Se um valor mais baixo for definido, 15.000 milissegundos serão usados.

 



Usado com WebSocketGetGlobalProperty.
WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE
Valor: 6
Tipo de propriedade: matriz ULONG

A propriedade WebSocket são as versões do protocolo WebSocket com suporte.


Usado com WebSocketGetGlobalProperty.

Requisitos

   
Cliente mínimo com suporte Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2012 [somente aplicativos da área de trabalho]
Cabeçalho websocket.h

Confira também

WEB_SOCKET_PROPERTY

WebSocketReceive

WebSocketSend