CloudflaredTunnelPlatform class abstract

Inheritance
  • Object
  • PlatformInterface
  • CloudflaredTunnelPlatform
Implementers

Constructors

CloudflaredTunnelPlatform()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
serverEventStream Stream<ServerEvent>
Stream of server events
no setter
tunnelEventStream Stream<TunnelEvent>
Stream of tunnel events
no setter

Methods

clearRequestLogs() Future<void>
Clear request logs
getRequestLogs() Future<List<RequestLog>>
Get request logs
getServerState() Future<ServerState>
Get the current server state
getServerUrl() Future<String>
Get the server URL
getState() Future<TunnelState>
Get the current tunnel state
getVersion() Future<String>
Get the version of the native cloudflared library
hasNotificationPermission() Future<bool>
Check if notification permission is granted
isRunning() Future<bool>
Check if a tunnel is running
isServerRunning() Future<bool>
Check if the server is running
isServiceRunning() Future<bool>
Check if the background service is running
listDirectory(String path) Future<List<FileInfo>>
List directory contents
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
requestNotificationPermission() Future<bool>
Request notification permission (Android 13+)
start({required String token, String originUrl = '', int haConnections = 4, bool enablePostQuantum = false}) Future<void>
Start the tunnel with the given token and origin URL
startServer({required String rootDir, int port = 8080}) Future<void>
Start the local HTTP file server
stop() Future<void>
Stop the tunnel
stopServer() Future<void>
Stop the local HTTP file server
stopService() Future<void>
Stop the background service completely
toString() String
A string representation of this object.
inherited
validateToken(String token) Future<String>
Validate a tunnel token

Operators

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

Static Properties

instance CloudflaredTunnelPlatform
getter/setter pair