FlutterSingBoxPlatform class abstract

The interface that implementations of flutter_sing_box must implement.

Platform implementations should extend this class rather than implementing it as an interface. Methods in this class that are not overridden by platform implementations will throw an UnimplementedError by default.

Inheritance
  • Object
  • PlatformInterface
  • FlutterSingBoxPlatform
Implementers

Constructors

FlutterSingBoxPlatform()
Constructs a FlutterSingBoxPlatform.

Properties

clashModeStream Stream<ClientClashMode>
A stream of client Clash mode updates.
no setter
connectedStatusStream Stream<ClientStatus>
A stream of client connection status updates.
no setter
groupStream Stream<List<ClientGroup>>
A stream of client group updates.
no setter
hashCode int
The hash code for this object.
no setterinherited
logStream Stream<List<String>>
A stream of log messages from the sing-box core.
no setter
proxyStateStream Stream<ProxyState>
A stream of proxy state updates.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

getSingBoxVersion() Future<String>
Gets the version of the underlying sing-box core.
init() Future<void>
Initializes the platform interface.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
selectOutbound({required String groupTag, required String outboundTag}) Future<void>
Selects an outbound for a specific group.
serviceReload() Future<void>
Reloads the service configuration.
setClashMode(String mode) Future<void>
Sets the Clash mode.
setGroupExpand({required String groupTag, required bool isExpand}) Future<void>
Sets the expansion state of a group.
startVpn() Future<void>
Starts the VPN service.
stopVpn() Future<void>
Stops the VPN service.
toString() String
A string representation of this object.
inherited
urlTest({required String groupTag}) Future<void>
Performs a URL test for a specific group.

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

instance FlutterSingBoxPlatform
The default instance of FlutterSingBoxPlatform to use.
getter/setter pair