action_cable

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

ActionCable é uma implementação cliente em Dart do ActionCable do Rails, permitindo comunicação bidirecional em tempo real por meio de WebSocket em aplicações Flutter e Dart. Ele suporta web, DartVM e plataformas móveis, incluindo Android, iOS, macOS, Windows e Linux. O pacote permite integração fluida com servidores ActionCable para funcionalidades como atualizações em tempo real, sistemas de chat e notificações. Oferece uma API limpa para se inscrever em canais, receber mensagens e gerenciar conexões com lógica de reconexão embutida. Ideal para aplicativos que exigem sincronização de dados em tempo real.

Casos de uso

Aplicações de bate-papo em tempo real
Atualizações ao vivo do painel
Sistemas de notificação
Ferramentas de edição colaborativa
Alimentação de dados em streaming

Principais recursos

Comunicação em tempo real baseada em WebSocket
Suporte multiplataforma (web, móvel, desktop)
Gerenciamento de assinatura do canal
Reconexão automática
API simples baseada em eventos

Indicado para

Aplicativos Flutter que precisam de recursos em tempo real
Projetos Dart usando backend Rails
Desenvolvedores construindo interfaces interativas ao vivo
Aplicativos que exigem atualizações de baixa latência
Equipes usando o ActionCable no lado do servidor

Considerações

Requer um servidor ActionCable compatível
A confiabilidade da rede afeta o desempenho
Documentação limitada em comparação com alternativas maduras
Necessário manipulação manual da análise de mensagens
Não adequado para cenários de alta frequência e baixa latência sem ajuste

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

Pub

ActionCable in Dart

ActionCable is the default realtime websocket framework and protocol in Rails.

This is a dart port of the client and protocol implementation which is available in web, dartVM and flutter.

Usage

Connecting to a channel 🙌

cable = ActionCable.connect(
  "ws://10.0.2.2:3000/cable",
  headers: {
    "Authorization": "Some Token",
  },
  onConnected: (){
    print("connected");
  },
  onConnectionLost: () {
    print("connection lost");
  },
  onCannotConnect: () {
    print("cannot connect");
});

Subscribing to channel 🎉

cable.subscribe(
  "Chat", // either "Chat" and "ChatChannel" is fine
  channelParams: { "room": "private" },
  onSubscribed: (){}, // `confirm_subscription` received
  onDisconnected: (){}, // `disconnect` received
  onMessage: (Map message) {} // any other message received
);

Unsubscribing from a channel 🎃

cable.unsubscribe(
  "Chat", // either "Chat" and "ChatChannel" is fine
  {"room": "private"}
);

Perform an action on your ActionCable server 🎇

Requires that you have a method defined in your Rails Action Cable channel whose name matches the action property passed in.

cable.performAction(
  "Chat",
  action: "send_message",
  channelParams: { "room": "private" },
  actionParams: { "message": "Hello private peeps! 😜" }
);