Checker class abstract
Base class for a single connection diagnostic, a Dart port of the
Checker class from client-sdk-js' ConnectionCheck utility.
Subclasses implement perform and report progress through appendMessage, appendWarning and appendError. Any log entry with CheckLogLevel.error (including uncaught exceptions thrown from perform) marks the check as CheckStatus.failed.
A Checker is single-use: run may only be called once, and the checker
should be disposed with dispose afterwards.
- Mixed-in types
Constructors
- Checker(String url, String token, {CheckerOptions? options, Room? room})
Properties
- connectOptions ↔ ConnectOptions?
-
getter/setter pair
- data → Object?
-
Check specific data included in getInfo, null by default.
no setter
- description → String
-
Human readable description of what this check verifies.
no setter
- disposeFuncCount → int
-
no setterinherited
- engine → Engine
-
no setter
-
events
→ EventsEmitter<
CheckerEvent> -
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isDisposed → bool
-
no setterinherited
-
logs
→ List<
CheckLog> -
final
- name → String
-
Name of this check, defaults to the class name.
no setter
- networkOptions → NetworkOptions
-
no setter
- options → CheckerOptions
-
final
- room → Room
-
The room instance used by this check.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status ↔ CheckStatus
-
getter/setter pair
- token → String
-
Access token used for the check.
final
- url ↔ String
-
URL of the LiveKit server to run the check against.
getter/setter pair
- wsConnector ↔ WebSocketConnector?
-
WebSocket connector used by signalJoin, exposed for testing.
getter/setter pair
Methods
-
appendError(
String message) → void -
appendMessage(
String message) → void -
appendWarning(
String message) → void -
connect(
[String? url]) → Future< Room> -
Connects room to
url(or the checker's default URL) unless it is already connected. -
createListener(
{bool synchronized = false}) → EventsListener< CheckerEvent> -
inherited
-
disconnect(
) → Future< void> -
dispose(
) → Future< bool> -
inherited
-
getInfo(
) → CheckInfo - The current snapshot of this check.
-
isSuccess(
) → bool -
messageFor(
Object error) → String -
Extracts a human readable message from
error. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onDispose(
OnDisposeFunc func) → void -
inherited
-
perform(
) → Future< void> - The actual check logic, implemented by subclasses.
-
run(
) → Future< CheckInfo> - Runs the check once and returns the final CheckInfo.
-
setStatus(
CheckStatus newStatus) → void -
signalJoin(
String url) → Future< JoinResponse> - Performs a signal-level join (WebSocket only, no peer connections) and returns the server's join response.
-
skip(
) → void - Marks this check as skipped (e.g. not applicable to the server).
-
switchProtocol(
CheckProtocol protocol) → Future< void> -
Asks the server to restrict ICE candidates to
protocoland forces a full reconnect so the switch takes effect. MirrorssimulateScenario('force-tcp')from client-sdk-js. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited