/
Conectar-se a Websocket (Cliente) / Connect to Websocket (Client)

Conectar-se a Websocket (Cliente) / Connect to Websocket (Client)

Conecta a um servidor WebSocket e retorna a referência da conexão.

Figura 1 - Bloco Conectar-se a Websocket

Compatibilidade

  • Bloco cliente: cronapi.websocket.connect()

Retorno

Retorna um objeto com a referência da conexão.

Parâmetros

Servidor

Endereço do servidor WebSocket. A URL deve iniciar sempre com "wss://".

  • Posição: 1

  • Inglês: Server

  • Tipo: Texto / Text

  • Exemplo: "wss://s14301.nyc1.piesocket.com/v3/1?api_key=S9GVmJj46GGrK3PzPvCYm2D5mRBrR9AZMcSSw8Mq&notify_self=1"

Ao Conectar

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.

  • Posição: 2

  • Inglês: On Connect

  • Tipo: Comando com retorno ("item") / Command with return ("item")

Ao Receber Mensagem

Executa ações após receber as mensagens do servidor. A variável "item" dessa entrada de comando exibe as mensagens enviadas pelo servidor.

  • Posição: 3

  • Inglês: On Receiving Message

  • Tipo: Comando com retorno ("item") / Command with return ("item")

Ao Apresentar Erro

Executa ações quando ocorrer um erro. A variável "item" dessa entrada de comando exibe a mensagem de erro enviado pelo servidor.

  • Posição: 4

  • Inglês: On Error

  • Tipo: Comando com retorno ("item") / Command with return ("item")

Exemplo

No exemplo abaixo estamos utilizando o serviço do PieHost 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. Acesse o site e crie uma conta para obter a chave de API que será utilizada para configurar o bloco.

Após criar a conta, acesse a aba "PieSocket" (destaque 1 da figura 2) e, em seguida, dê um nome ao cluster que será utilizado (2). Role até o final da página e clique em "create cluster". 

Figura 2 - Criando o cluster

 

Após criar o cluster, clique em "API Keys" (destaque 1 da figura 2.1).

Figura 2.1 - Obtendo a chave da API

 

Role a página até o final e clique no botão Teste Online, isso fará com que a ferramenta de testes do PieSocket seja exibida já com a chave da API colada na caixa de texto. Em seguida, clique em  "Connect". Como mostra a figura 2.2, copie a chave exibida no campo de texto e cole no parâmetro "Servidor" do bloco da função da figura 2.3.

Figura 2.2 - Ferramenta de envio de mensagem do PieSocket.

 

A função da figura 2.3 é executada sempre que a página da figura 2.5 for iniciada. E a cada nova mensagem enviada pelo servidor (figura 2.4), a função Conectar-se a Websocket recebe a mensagem e alimenta o componente Área de texto.

Figura 2.3 - Função que inicia a conexão e se comunica com o 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 Websocket.

  • 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.

  • Ao Apresentar Erro: se um erro ocorrer, o usuário será notificado.

 

Escreva a mensagem no campo de texto e clique em "Send".

Figura 2.4 - Enviando mensagem do servidor para o bloco

 

Após enviar a mensagem, os blocos da entrada de comando Ao Receber Mensagem serão executados e o componente Área de texto exibirá a mensagem.

Figura 2.5 - Mensagem recebida do servidor PieSocket

Nesta página