Transportes
Um transporte é uma interface do lado do cliente que pode se conectar a uma URI de comms e trocar mensagens em tempo real com pares ou serviços.
Os clientes são livres para implementar transportes como acharem adequado (desde que sigam o protocolo esperado pelos outros clientes e serviços), mas o design recomendado descrito abaixo foi testado na prática e comprovado que se integra bem com diferentes projetos.`
Transportes padrão
Existem 5 tipos de transporte definidos pelo protocolo:
WebSocket (
ws-room) usa um stream padrão de WebSocket.LiveKit (
livekit) usa o framework open-source LiveKit, baseado em WebRTC.SignedLogin (
signed-login) faz uma requisição HTTPS assinada para obter um transporte atribuído dinamicamente de um servidor.Offline (
offline) é um transporte fictício que indica que não há comms no ambiente atual.Simulator (
simulator) é um transporte fictício com comportamento totalmente personalizado, principalmente para desenvolvedores depurarem suas implementações.
As mensagens enviadas e recebidas através de uma interface de transporte são sempre as mesmas (veja messages). Alguns transportes podem envolvê-las em estruturas de controle para transmissão, mas elas devem ser desempacotadas antes de atravessar a Transport interface.
Design recomendado
Esta é uma Transport interface mínima escrita em TypeScript:
interface Transport {
// Inicialize o Transport com uma URI:
constructor(private uriWithConnectionParams: string)
// Abra uma conexão usando a URI fornecida no construtor:
connect(): Promise<void>
// Feche a conexão:
disconnect(): Promise<void>
// Envie um payload arbitrário para o service e todos os peers:
send(packet: Packet): Promise<void>
// Inscreva-se para mensagens recebidas tanto do service quanto de todos os peers:
on(event: 'receive', callback: (packet: Packet) => void): void
}Implementações reais normalmente estendem isso, adicionando eventos de conexão/desconexão e de entrar/sair, envio sem broadcast, tipagem mais estrita ou adaptações específicas de linguagem.
URIs de transporte
Os valores de uriWithConnectionParams estão sempre na forma:
O <type> corresponde a um dos listados acima, e o formato para <type connection parameters> depende do transporte específico. Pode ser uma URL, um token opaco ou quaisquer dados arbitrários.
O LiveKit transporte, por exemplo, usa uma wss URL com um access_token parâmetro para estabelecer uma conexão autenticada:
Para comparação, o WebSocket transporte também usa uma wss URL, mas sem um token pré-gerado. Ele requer um fluxo de autenticação depois de conectado.
Criando transportes
Como cada Transport classe dará suporte a um tipo específico de URI, é uma boa ideia ter um método de fábrica que retorne um transporte válido Transport ou falhe imediatamente. Por exemplo:
Os clientes não são obrigados a implementar todos os transportes padrão. Se pretendem usar apenas um subconjunto dos tipos definidos sem a intenção de lidar com todas as URIs, são livres para rejeitar os tipos que não suportam.
Clientes com mais recursos, como um World Explorer, são aconselhados a implementar pelo menos o websocket e LiveKit transportes, que atualmente estão em uso por todos os realms principais.
Saiba mais
Acesse uma seção de um tipo específico de transporte leia sobre os diferentes tipos de mensagem ou confira o [[Comms Demo Station]].
Atualizado