EcholotSocket.IO
Einem Socket.IO-Namespace mit Auth-Payload beitreten, Ereignisse mit Argumenten und Bestätigungen senden und das Ereignislog lesen.
Eine Socket.IO-Anfrage verbindet sich mit einem Socket.IO-Server, tritt einem Namespace bei und bleibt verbunden: Du sendest Ereignisse und siehst die Ereignisse des Servers, sobald sie eintreffen. Echolot spricht Socket.IO 2, 3 und 4 über WebSocket.
Mit Alpenglow ausprobieren
Realtime › Support chat verbindet sich mit einem lokalen Socket.IO-Server auf localhost:3001, aus dem Ordner
examples/servers des Docs-Repositorys (bun run realtime).
Verbinden
- Wähle Datei › Neue Socket.IO-Anfrage oder Neue Socket.IO-Anfrage im Menü + neben Anfragen in der Seitenleiste.
- Tippe die Adresse des Servers, etwa
http://localhost:3001(in Alpenglow{{realtimeURL}}).http://,https://,ws://undwss://funktionieren alle. - Wähle die Version des Servers im Menü des Badges SIO vor der Adresse: Socket.IO 4, Socket.IO 3 oder Socket.IO 2.
- Wähle Verbinden (⌘R). Solange die Verbindung steht, heißt es Trennen.
Der Editor hat diese Tabs: Doku, Ereignisse, Header, Parameter, Auth, Variablen, Tests, Skripte und Einstellungen. Header, Query-Parameter und Auth gehören zum WebSocket-Handshake.
Namespace, Pfad und Auth
Der obere Teil des Tabs Ereignisse legt fest, wie der Client beitritt:
| Feld | Was es ist |
|---|---|
| Namespace | Der Namespace, dem beigetreten wird, etwa /support. Leer tritt dem Pfad der Adresse bei, oder / |
| Pfad | Wo der Server lauscht. Leer heißt der Standard, /socket.io/ |
| Auth | Die Auth-Payload, ein JSON-Objekt wie {"token": "{{token}}"}. Socket.IO 3 und 4 senden sie beim Beitritt zum Namespace. Leer für keine |
Halte ein Token in einer geheimen Variablen und schreibe {{token}} in die Payload, damit der
Wert nie in der Anfragedatei landet. Ein Server, der die Verbindung ablehnt, antwortet mit einem Fehler, den das Log in
Rot zeigt.
Ereignisse senden
Unten im Tab Ereignisse:
- Tippe den Namen des Ereignisses, etwa
message. - Tippe seine Argumente als JSON, mit
{{variables}}. Ein Array sind mehrere Argumente; jeder andere Wert ist das einzige. Lass es leer für keines. - Setze das Häkchen bei Ack, um den Server um eine Bestätigung des Ereignisses zu bitten.
- Wähle Senden (⇧⌘↩).
Zum Beispiel sendet das Ereignis message mit den Argumenten {"text": "Grüezi!"} ein Objekt, und
["order", {"id": "ord_7Hk2Lw"}] sendet zwei Argumente.
Wähle +, um das Ereignis mit der Anfrage zu sichern. Jedes gesicherte Ereignis hat einen Namen, das Ereignis, seine Argumente, Ack und einen eigenen Knopf Senden. In Durchläufen senden, das Kästchen an seinem Anfang, entscheidet, ob es gesendet wird, wenn die Anfrage ohne dich läuft: Die Ausführung, die Befehlszeile und Agenten senden die aktivierten Ereignisse nach dem Beitritt der Reihe nach, hören 10 Sekunden zu und schließen dann. Support chat hat ein gesichertes Ereignis, Say hello.
Das Ereignislog
Der Tab Nachrichten des Antwortbereichs zeigt die Sitzung: jedes Ereignis in beide Richtungen, das neueste zuletzt, mit Zeit und Größe.
- Jede Zeile zeigt den Namen und Namespace des Ereignisses und seine Bestätigungs-ID, wenn es eine verlangt hat. Eine Bestätigung zeigt die ID, auf die sie antwortet.
- Alle, Gesendet und Empfangen filtern nach Richtung; Ereignisse filtern findet Ereignisse nach Name oder Text.
- Mehr formatiert JSON-Argumente übersichtlich.
- Sendet der Server ein Ereignis, das eine Bestätigung verlangt, antwortet Bestätigen darauf, ohne Argumente.
- Binäre Anhänge, die mit einem Ereignis eintreffen, erscheinen darunter, jeweils als Attachment 1, Base64: ….
Ein Socket.IO-Paket nimmt höchstens 1000 Anhänge auf, zusammen bis zu 64 MB.
Schließt die Verbindung, wird die Sitzung im Verlauf behalten, mit dem Log als Body der Antwort.
In der Befehlszeile
echolot send --socketio verbindet sich vom Terminal aus: Jede Zeile, die du tippst, ist ein Ereignis mit seinen
JSON-Argumenten. Es führt auch gesicherte .sio.toml-Anfragen aus. Siehe echolot send.