Ausnahmebehandlung | Web SDK

Eine bewährte Praxis bei der Programmierung ist es, Code zu schreiben, der davon ausgeht, dass etwas schief gehen kann. Zum Beispiel kann ein Client nicht mit dem Internet verbunden sein, wenn er versucht, eine Verbindung zu einer Sitzung herzustellen.

Die Web-SDK umfasst Abschlusshandler und Ausnahmeereignisse, die Ausnahmen zur Laufzeit aufzeigen.

Fertigstellungshandler

Bei vielen Methoden, die asynchron abgeschlossen werden, ist der letzte Parameter, den Sie übergeben, eine Abschlusshandlerfunktion. Diese Funktion wird aufgerufen, wenn die Methode abgeschlossen ist oder fehlschlägt. Wenn sie fehlschlägt, wird der Funktion ein Fehlerobjekt als Parameter übergeben.

Zum Beispiel ruft der folgende Code die Session.connect() Methode und übergibt einen Abschluss-Handler:

var session = OT.initSession(apiKey, session);
session.connect(token, function (error) {
    if (error) {
    console.log("Failed to connect: ", error.message);
    if (error.name === "OT_NOT_CONNECTED") {
        alert("You are not connected to the internet. Check your network connection.");
    }
    } else {
    console.log("Connected");
    }
});

Es ist wichtig, Beendigungshandler zu implementieren, um zu sehen, wann eine Methode erfolgreich ist oder fehlschlägt. In einigen Fällen können Sie den Benutzer fragen, ob es eine Client-Bedingung gibt, die den Fehler verursacht hat. Zum Beispiel, wenn die error.name Eigenschaft auf "OT_NOT_CONNECTED" gesetzt ist, wenn der Aufruf der Session.connect() Methode fehlschlägt, bedeutet dies, dass der Client nicht mit dem Netz verbunden ist.

Bei anderen Fehlerzuständen, die nicht auf den Client zurückzuführen sind, können Sie den Fehlercode und die Meldung untersuchen, um die Art des Fehlers zu ermitteln. Zum Beispiel, wenn Sie die Funktion Session.connect() Methode fehlschlägt, zeigt ein Fehlercode von 1004 an, dass Sie versucht haben, eine Verbindung mit einem ungültigen Token herzustellen. Dabei kann es sich um ein abgelaufenes Token handeln oder um ein Token, das nicht mit der Sitzung übereinstimmt, zu der Sie eine Verbindung herstellen. Prüfen Sie die Nachrichteneigenschaft des Fehlerobjekts auf Einzelheiten.

Methoden mit Abschlusshandlern

Die folgenden Methoden im Web SDK enthalten eine completionHandler Parameter. Für diesen optionalen Parameter können Sie eine Funktion übergeben, die aufgerufen wird, wenn die Methode erfolgreich ist oder fehlschlägt:

• Session.forceDisconnect()
• Session.forceUnpublish()
• Session.connect()
• Session.publish()
• Session.signal()
• Session.subscribe()
• OT.initPublisher()

Prüfen Sie die message Eigenschaft für weitere Details über den Fehler.

Im Falle eines Fehlers wird die code Wert des error kann einen der folgenden Werte annehmen:

Abhören von Ausnahmeereignissen

Um alle Ausnahmeereignisse zu erkennen, fügen Sie einen Ereignislistener für die exception Ereignis, das durch das OT-Objekt ausgelöst wird. Es ist jedoch einfacher, auf Fehler in Abschlusshandlern für bestimmte Methoden zu reagieren.