Introdução

tip

If you are new to Socket.IO, we recommend checking out our tutorial.

O que o Socket.IO é

Socket.IO é uma biblioteca que permite baixa-latência, bidirecional e baseado em eventos de comunicação entre cliente e um servidor.

The Socket.IO connection can be established with different low-level transports:

• HTTP long-polling
• WebSocket
• WebTransport

Socket.IO will automatically pick the best available option, depending on:

• the capabilities of the browser (see here and here)
• the network (some networks block WebSocket and/or WebTransport connections)

You can find more detail about that in the "How it works" section.

Server implementations

Language	Website
JavaScript (Node.js)	- Installation steps - API - Source code
JavaScript (Deno)	https://github.com/socketio/socket.io-deno
Java	https://github.com/mrniko/netty-socketio
Java	https://github.com/trinopoty/socket.io-server-java
Python	https://github.com/miguelgrinberg/python-socketio
Golang	https://github.com/googollee/go-socket.io
Rust	https://github.com/Totodore/socketioxide

Client implementations

Language	Website
JavaScript (browser, Node.js or React Native)	- Installation steps - API - Source code
JavaScript (for WeChat Mini-Programs)	https://github.com/weapp-socketio/weapp.socket.io
Java	https://github.com/socketio/socket.io-client-java
C++	https://github.com/socketio/socket.io-client-cpp
Swift	https://github.com/socketio/socket.io-client-swift
Dart	https://github.com/rikulo/socket.io-client-dart
Python	https://github.com/miguelgrinberg/python-socketio
.Net	https://github.com/doghappy/socket.io-client-csharp
Rust	https://github.com/1c3t3a/rust-socketio
Kotlin	https://github.com/icerockdev/moko-socket-io

O que o Socket.IO não é

:::atenção

Socket.IO NÃO é uma implementação WebSocket.

:::

Embora o Socket.IO realmente use o WebSocket para transporte quando possível, ele adiciona metadados adicionais a cada pacote. É por isso que um cliente WebSocket não poderá se conectar com êxito a um servidor Socket.IO, e um cliente Socket.IO também não poderá se conectar a um servidor WebSocket simples.

// ATENÇÃO: o cliente NÃO poderá se conectar!
const socket = io("ws://echo.websocket.org");

Se você estiver procurando por um servidor WebSocket simples, dê uma olhada em ws ou µWebSockets.js.

Há também discussões para incluir um servidor WebSocket no núcleo do Node.js.

No lado do cliente, você pode estar interessado no pacote robust-websocket.

:::atenção

Socket.IO is not meant to be used in a background service for mobile applications.

:::

The Socket.IO library keeps an open TCP connection to the server, which may result in a high battery drain for your users. Please use a dedicated messaging platform like FCM for this use case.

Recursos

Aqui estão os recursos fornecidos pelo Socket.IO sobre WebSockets simples:

HTTP long-polling fallback

A conexão retornará à sondagem longa HTTP caso a conexão WebSocket não possa ser estabelecida.

Esse recurso foi o motivo número 1 pelo qual as pessoas usaram o Socket.IO quando o projeto foi criado há mais de dez anos (!), pois o suporte do navegador para WebSockets ainda estava em seu inicio.

Mesmo que a maioria dos navegadores agora suporte WebSockets (mais que 97%), ainda é um ótimo recurso, pois ainda recebemos relatórios de usuários que não conseguem estabelecer uma conexão WebSocket porque estão atrás de algum proxy mal configurado.

Reconexão Automatica

Sob algumas condições particulares, a conexão WebSocket entre o servidor e o cliente pode ser interrompida com ambos os lados desconhecendo o estado quebrado do link.

É por isso que o Socket.IO inclui um mecanismo de pulsação, que verifica periodicamente o status da conexão.

E quando o cliente eventualmente é desconectado, ele se reconecta automaticamente com um atraso exponencial de back-off, para não sobrecarregar o servidor.

Buffer de pacote

Os pacotes são automaticamente armazenados em buffer quando o cliente é desconectado e serão enviados na reconexão.

Mais informações aqui.

Acknowledgements

O Socket.IO oferece uma maneira conveniente de enviar um evento e receber uma resposta:

Remetente

socket.emit("hello", "world", (response) => {
  console.log(response); // "conseguiu"
});

Receptor

socket.on("hello", (arg, callback) => {
  console.log(arg); // "world"
  callback("got it");
});

Você também pode adionar um timeout:

socket.timeout(5000).emit("hello", "world", (err, response) => {
  if (err) {
// o outro lado não reconheceu o evento no atraso determinado
  } else {
    console.log(response); // "conseguiu"
  }
});

Transmissão

No lado do servidor, você pode enviar um evento para todos os clientes conectados ou para um subconjunto de clientes:

// para todos os clientes
io.emit("hello");

// para todos os clientes conectados no room "news"
io.to("news").emit("hello");

Isso também funciona ao escalar para vários nós.

Multiplexing

Os namespaces permitem que você divida a lógica do seu aplicativo em uma única conexão compartilhada. Isso pode ser útil, por exemplo, se você quiser criar um canal "admin" no qual somente usuários autorizados possam participar.

io.on("connection", (socket) => {
  // classic users
});

io.of("/admin").on("connection", (socket) => {
  // admin users
});

Mais sobre isso aqui.

Questões comuns

O Socket.IO ainda é necessário hoje?

Essa é uma pergunta justa, já que os WebSockets são suportados quase em todos os lugares nesse momento.

Dito isto, acreditamos que, se você usar WebSockets simples para seu aplicativo, eventualmente precisará implementar a maioria dos recursos que já estão incluídos (e battle-tested) no Socket.IO, como reconexão, acknowledgements ou transmissão.

qual é a sobrecarga do protocolo Socket.IO?

socket.emit("hello", "world") será enviado como um único WebSocket frame contendo 42["hello","world"] com:

• 4 ser Engine.IO "message" tipo de pacote
• 2 ser Socket.IO "message" tipo de pacote
• ["hello","world"] sendo o JSON.stringify() versão do array de argumentos.

Assim, alguns bytes adicionais para cada mensagem, que podem ser ainda mais reduzidos pelo uso de um parser customizado.

info

O tamanho do pacote de navegador em si é 10.4 kB (minificado e gzipado)

Algumas coisas não estão funcionando devidamente, por favor me ajude?

Por favor, cheque o Guia de solução de problemas.

Proximos passos

• Exemplo de introdução
• Instalação do servidor
• Installação do cliente