/
Conectar-se a Websocket (Servidor) / Connect to Websocket (Servidor)

Conectar-se a Websocket (Servidor) / Connect to Websocket (Servidor)

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

Figura 1 - Bloco Conectar-se a Websocket

Compatibilidade

  • Bloco servidor: cronapi.net.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 conecta-se ao servidor PieSocket e gera um objeto com a referência da conexão na variável "ws", o conteúdo dessa variável será usado nos blocos Enviar Mensagem por Websocket e Fechar Websocket. Essa função deve ser associada ao evento Ao Clicar de um componente botão inserido em uma view.

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, o bloco Enviar Mensagem por Websocket é chamado para enviar para o servidor o texto contido na variável "msg".

  • Ao Receber Mensagem: toda mensagem recebida do servidor executará essa entrada de comando. Neste exemplo, estamos imprimindo no console todas as mensagens recebidas até que o conteúdo da mensagem seja "Fechar", aí o bloco Fechar Websocket será chamado e fechará a conexão com o servidor.

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

 

Execute a aplicação e acione o botão contendo a função da figura 2.3.

Figura 2.4 - Acionando a função

 

Após o acionamento do botão, a mensagem contida na variável "msg" é disparada e exibida na ferramenta do PieSocket. Em seguida, digitamos 3 mensagens através do chat do PieSocket: "Mensagem do Servidor para o Cliente", "Fechar" e "Olá".

Figura 2.5 - Enviando mensagem do servidor para o bloco

 

No console do depurador, temos 3 mensagens (Figura 2.6). A primeira corresponde ao retorno da mensagem enviada na entrada de comando Ao Conectar. No PieSocket, toda mensagem enviada é automaticamente retornada. As duas mensagens seguintes foram digitadas manualmente utilizando a ferramenta do PieSocket. Observe que, ao receber a mensagem "Fechar", o bloco Fechar Websocket foi acionado, encerrando a conexão, por isso a mensagem "Olá" não foi enviada.

Figura 2.6 - Mensagens recebidas do servidor PieSocket

Nesta página