action_cable

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

ActionCable ist eine Dart-Client-Implementierung von Rails' ActionCable, die Echtzeit-Zweifachkommunikation über WebSocket in Flutter- und Dart-Anwendungen ermöglicht. Es unterstützt Web, DartVM sowie mobile Plattformen wie Android, iOS, macOS, Windows und Linux. Das Paket ermöglicht nahtlose Integration mit ActionCable-Servern für Funktionen wie Live-Updates, Chat-Systeme und Benachrichtigungen. Es bietet eine saubere API zum Abonnieren von Kanälen, Empfangen von Nachrichten und Verwaltung von Verbindungen mit eingebauter Wiederherstellungslogik. Ideal für Anwendungen, die Echtzeit-Daten-Synchronisation erfordern.

Anwendungsfälle

Echtzeit-Chats-Anwendungen
Live-Dashboard-Updates
Benachrichtigungssysteme
Kooperationseditoren
Streaming-Datenfeeds

Hauptmerkmale

Echtzeitkommunikation basierend auf WebSocket
Plattformübergreifende Unterstützung (Web, Mobil, Desktop)
Kanal-Abonnementsverwaltung
Automatische Wiederherstellung der Verbindung
Einfache ereignisgesteuerte API

Geeignet für

Flutter-Apps, die Echtzeitfunktionen benötigen
Dart-Projekte mit Rails-Backend
Entwickler, die Live-Interaktive Benutzeroberflächen erstellen
Apps, die niedrige Latenzaktualisierungen erfordern
Teams, die ActionCable auf der Serverseite verwenden

Hinweise

Benötigt einen kompatiblen ActionCable-Server
Netzwerkzuverlässigkeit beeinflusst die Leistung
Eingeschränkte Dokumentation im Vergleich zu etablierten Alternativen
Manuelle Behandlung der Nachrichtenanalyse erforderlich
Nicht geeignet für hochfrequente, niedriglatenzige Szenarien ohne Abstimmung

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

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! 😜" }
);