Conectar-se a Websocket
Conecta em um servidor WebSocket.
Retorno
Retorna um objeto com a referência da conexão.
Parâmetros de Entrada
| Nome | Tipo | Doc |
|---|---|---|
| Parâmetro 1 | Texto | Endereço do servidor WebSocket. A URL deve iniciar sempre com "wss://". |
| Parâmetro 2 | Entrada de comando | Executa ações após estabelecer uma conexão com o servidor. A variável "item" dessa entrada de comando retorna algum dado enviado pelo servidor após o sucesso da conexão. |
| Parâmetro 3 | Entrada de comando | Executa ações após receber as mensagens do servidor. A variável "item" dessa entrada de comando exibe as mensagens enviadas pelo servidor. |
| Parâmetro 4 | Entrada de comando | Executa ações quando ocorrer um erro. A variável "item" dessa entrada de comando exibe a mensagem de erro enviado pelo servidor. |
Compatibilidade
Cliente
Exemplo
No exemplo abaixo estamos utilizando o serviço do PieSocket que possui um servidor WebSocket de testes e uma ferramenta de envio de mensagem que dispara a mensagem enviada para todos os clientes conectados ao servidor.
A função da figura 1 é executada sempre que a página da figura 1.3 for iniciada, e a cada nova mensagem enviada pelo servidor (figura 1.2), a função Conectar-se a Websocket recebe a mensagem e alimenta o componente Área de texto.
Figura 1 - Bloco que inicia a conexão e aguarda as mensagens do servidor
Feita a conexão, o bloco Conectar-se a WebSocket fica aguardando a resposta do servidor para executar as ações definidas nas entradas de comando do bloco:
- Servidor: endereço do servidor, neste exemplo estamos utilizando o PieSocket.
- Ao Conectar: após o sucesso da conexão, uma variável de escopo é criada para guardar o objeto de referência da conexão que será usado pelos blocos Enviar Mensagem por Websocket e Fechar Websocket.
- Ao Receber Mensagem: toda mensagem enviada pelo servidor executará essa entrada de comando, neste exemplo estamos incluindo a mensagem em uma nova linha do componente Área de Texto da tela.
- Ao Apresentar Erro: se um erro ocorrer, o usuário será notificado do erro.
A ferramenta do PieSocket dispara a mensagem enviada para todos os clientes conectados ao servidor.
Figura 1.1 - Ferramenta de envio de mensagem do PieSocket.
Após enviar a mensagem com a ferramenta do PieSocket (Figura 1.1), os blocos da entrada de comando Ao Receber Mensagem (figura 1) serão executados e o componente Área de texto Chat exibirá a mensagem (Figura 1.2)
Figura 1.2 - Mensagem recebido do servidor piesocket.
Saiba mais
O Web Socket é um protocolo de conexão que cria uma conexão contínua entre um servidor Web Socket e um cliente, dessa forma, a comunicação se torna mais rápida, visto que não é necessário iniciar e fechar uma conexão sempre que uma mensagem for enviada para o servidor. A tecnologia WebSocket é muito utilizado em aplicativos de conversas (chat) e jogos online.