Opções do Servidor

Socket.IO Opções de servidor​

path​

Valor padrão: /socket.io/

Esse é o nome do caminho e é aquele que é capturada do lado do servidor.

:::Cuidado

Os valores do Servidor do Cliente devem corresponder (a menos que você esteja usando um proxy de reescrita de caminho entre).

:::

Servidor

import{ createServer }from"http";
import{Server}from"socket.io";

const httpServer =createServer();
const io =newServer(httpServer,{
path:"/my-custom-path/"
});

Cliente

import{ io }from"socket.io-client";

const socket =io("https://example.com",{
path:"/my-custom-path/"
});

serveClient​

Valor padrão: true

Seja para servidor e arquivos de cliente. Se true, diferentes pacotes irão ser servidos para a seguinte localização:

• <url>/socket.io/socket.io.js
• <url>/socket.io/socket.io.min.js
• <url>/socket.io/socket.io.msgpack.min.js

(incluindo seus mapas de origem assossiados)

Veja tambem aqui.

adapter​

Valor padrão: require("socket.io-adapter") (in-memory adapter, cujo código fonte pode ser encontrado aqui)

O "Adapter" utiliza.

Exemplo com o Redis adapter:

const{Server}=require("socket.io");
const{ createAdapter }=require("@socket.io/redis-adapter");
const{ createClient }=require("redis");

const pubClient =createClient({host:"localhost",port:6379});
const subClient = pubClient.duplicate();

const io =newServer({
adapter:createAdapter(pubClient, subClient)
});

io.listen(3000);

import{Server}from"socket.io";
import{ createAdapter }from"@socket.io/redis-adapter";
import{ createClient }from"redis";

const pubClient =createClient({host:"localhost",port:6379});
const subClient = pubClient.duplicate();

const io =newServer({
adapter:createAdapter(pubClient, subClient)
});

io.listen(3000);

import{ Server }from"socket.io";
import{ createAdapter }from"@socket.io/redis-adapter";
import{ createClient }from"redis";

const pubClient =createClient({ host:"localhost", port:6379});
const subClient = pubClient.duplicate();

const io =newServer({
 adapter:createAdapter(pubClient, subClient)
});

io.listen(3000);

parser​

Valor padrão: socket.io-parser

O parser a ser utilizado. Por favor veja a documentação aqui.

connectTimeout​

Valor padrão: 45000

O numero de milissegundos antes de desconectar um cliente que não ingressou com sucesso em um namespace.

Opções de motor de baixo nível​

pingTimeout​

Valor padrão: 20000

Esse valor é usado em um mecanimos heartbeat, que periodicamente checa se a conexão continua viva entre o servidor e o cliente,

O servidor envia um ping, e se o cliente não responder com um pong dentro de pingTimeout milissegundos, o sividor considera que a conexão foi encerrada.

De forma similar, se o cliente nãp receber um ping do servidor dentro de pingInterval + pingTimeout milissegundos, o clinete tambem considera que a conexão está encerrada

Em ambos os casos, é desconectador por causa do ping timeout

socket.on("disconnect",(reason)=>{
console.log(reason);// "ping timeout"
});

Nota: o valor padrão pode ser um pouco baixo se você precisar enviar arquivos grandes em seu aplicativo. Aumente-o se for esse o caso:

const io =newServer(httpServer,{
pingTimeout:30000
});

pingInterval​

Valor padrão: 25000

Veja acima.

upgradeTimeout​

Valor padrão: 10000

É um delay em milissegundos antes que uma atualização de transporte imcompleta seja cancelada.

maxHttpBufferSize​

Valor padrão: 1e6 (1 MB)

Isso define quantos bytes uma mensagem unica pode ir, antes do fechamente do socket. Você pode incrementar ou decrementar esta valor dependendo da sua necessidade.

const io =newServer(httpServer,{
maxHttpBufferSize:1e8
});

Ele corresponde a opção maxPayload do pacote ws.

allowRequest​

Padrão: -

Uma função que recebe um dado handshake ou se solicitação de atualização como seu primeiro parâmetro, e pode decidir se continua ou não

Example:

const io =newServer(httpServer,{
allowRequest:(req, callback)=>{
const isOriginValid =check(req);
callback(null, isOriginValid);
}
});

Isso pode tambem ser usado em conjunto com o evento initial_headers, enviando um cookie para o cliente

import{ serialize }from"cookie";

const io =newServer(httpServer,{
allowRequest:async(req, callback)=>{
const session =awaitfetchSession(req);
 req.session= session;
callback(null,true);
}
});

io.engine.on("initial_headers",(headers, req)=>{
if(req.session){
 headers["set-cookie"]=serialize("sid", req.session.id,{sameSite:"strict"});
}
});

Veja tambem:

• Como utilizar com express-session
• Como lidar com cookies

transports​

Valor padrão: ["polling", "websocket"]

O transporte de baixo-nível que são permitido do lado do cliente

Veja tambem: Lado do cliente transports

allowUpgrades​

Valor padrão: true

Se permiti atualizações de transporte.

perMessageDeflate​

Valor padrão: false

Quer habilitar o permessage-deflate extension para o transporte do Websocket. Este consumo de memoria, nós sugerimos que apenas permita se isso for realmente necessario

Observe que se perMessageDeflate é definido false (que é o padrão), o compress flag usado ao emitir (socket.compress(true).emit(...)) será ignorado quando a conexão está esbilizada com WebSockets, pois a extensão permessage-deflate não pode ser habilitada por mensagem.

Todas as opção para o ws module são suportadas:

const io =newServer(httpServer,{
perMessageDeflate:{
threshold:2048,// Padrão é 1024

zlibDeflateOptions:{
chunkSize:8*1024,// Padrão é 16 * 1024
},

zlibInflateOptions:{
windowBits:14,// Padrão é 15
memLevel:7,// Padrão é 8
},

clientNoContextTakeover:true,// Padrão é valor negociado.
serverNoContextTakeover:true,// Padrão é valor negociado.
serverMaxWindowBits:10,// Padrão é valor negociado..

concurrencyLimit:20,// Padrão é 20.
}
});

httpCompression​

Adiconada na v1.4.0

Valor padrão: true

Se deve habilitar a compactação para o transporte de HTTP long-polling.

Observe que se httpCompression é definido como false, a flag de compactação usando quando emitimos (socket.compress(true).emit(...)) irá ser ignorada quando a coenxão é estabilizada com requisições HTTP long-polling.

Todas as opções para o Node.js modulo zlib são suportadas.

Exemplo:

const io =newServer(httpServer,{
httpCompression:{
// Engine.IO options
threshold:2048,// Padrão é 1024
// Node.js zlib options
chunkSize:8*1024,// Padrão é 16 * 1024
windowBits:14,// Padrão é 15
memLevel:7,// Padrão é 8
}
});

wsEngine​

Valor padrão: require("ws").Server (codígo fontr pode ser encontrado aqui)

A implamentação do WebSocket server para uso. Por favor veja a documentação aqui.

Exemplo:

const io =newServer(httpServer,{
wsEngine:require("eiows").Server
});

cors​

Valor padrão: -

A lista de opções The list of options que será encaminhado ao modulocors. Mais ifformações você pode encontrar aqui.

Exemplo:

const io =newServer(httpServer,{
cors:{
origin:["https://example.com","https://dev.example.com"],
allowedHeaders:["my-custom-header"],
credentials:true
}
});

Opções disponiveis:

Possiveis valores para a opção origin:

• Boolean - Define origin para true para refletir no request origin, e é definido por req.header('Origin'), ou define isso false para desabilitar CORS.
• String - Define origin para uma origem especifica. Por exemplo se você define isso para "http://example.com" apenas requisições para "http://example.com" serão permitidas.
• RegExp - Define origin para uma expressão regular padrão que irá ser usada para testar a requisição de origem. Se isso é uma correspondência, a origem da solicitação será refletida. Por exemplo, o padrão /example\.com$/ refletirá qualquer solicitação proveniente de uma origem que termine com "example.com"
• Array - Define origin para um array para origens validas. Cada origem pode ser uma String ou um RegExp. Por exemplo ["http://example1.com", /\.example2\.com$/] será aceito qualquer requisição para "http://example1.com" ou padra um subdominio do "example2.com".
• Function - Define origin para uma função implementando alguma logiva customizada. A Função pega a origim da requisição como o primeiro parâmetro e o callback (que espera uma assinatura err [object], allow [bool]) como o segundo.

cookie​

Valor padrão: -

A lista de opções que será encaminhado para o modulo do cookie. Opções disponíveis:

• domain
• encode
• expires
• httpOnly
• maxAge
• path
• sameSite
• secure

Exemplo:

import{Server}from"socket.io";

const io =newServer(httpServer,{
cookie:{
name:"my-cookie",
httpOnly:true,
sameSite:"strict",
maxAge:86400
}
});

allowEIO3​

Valor padrão: false

Se a compatibilidade for permitido com Socket.IO v2 client

Veja sobre: Migrating from 2.x to 3.0

Exemplo:

const io =newServer(httpServer,{
allowEIO3:true// false é o padrão
});