PlatformInAppLocalhostServer class abstract

This class allows you to create a simple server on http://localhost:[port]/ in order to be able to load your assets file on a local server. The default port value is 8080.

Inheritance
Annotations
  • @SupportedPlatforms.new(platforms: [AndroidPlatform(), IOSPlatform(), MacOSPlatform(), WindowsPlatform(), LinuxPlatform()])

Constructors

PlatformInAppLocalhostServer(PlatformInAppLocalhostServerCreationParams params)
Creates a new PlatformInAppLocalhostServer
factory
PlatformInAppLocalhostServer.implementation(PlatformInAppLocalhostServerCreationParams params)
Used by the platform implementation to create a new PlatformInAppLocalhostServer.
PlatformInAppLocalhostServer.static()
Creates a new empty PlatformInAppLocalhostServer to access static methods.
factory

Properties

directoryIndex → String
represents the index file to use. The default value is index.html.
no setter
documentRoot → String
Represents the document root path to serve. The default value is ./.
no setter
hashCode → int
The hash code for this object.
no setterinherited
onData → Future<bool> Function(HttpRequest request)?
A custom callback that is called when a new request is received by the server that can be used to send or modify the response, for example adding custom headers. If this callback returns true, it means that the request has been handled by this callback. Otherwise, if this callback returns false, the server will continue to process the request using the default implementation.
no setter
params → PlatformInAppLocalhostServerCreationParams
The parameters used to initialize the PlatformInAppLocalhostServer.
final
port → int
Represents the port of the server. The default value is 8080.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shared → bool
Specifies whether additional HttpServer objects can bind to the same combination of address, port and v6Only. If shared is true and more HttpServers from this isolate or other isolates are bound to the port, then the incoming connections will be distributed among all the bound HttpServers. Connections can be distributed over multiple isolates this way.
no setter

Methods

close() → Future<void>
Closes the server.
isClassSupported({TargetPlatform? platform}) → bool
Check if the current class is supported by the defaultTargetPlatform or a specific platform.
isMethodSupported(PlatformInAppLocalhostServerMethod method, {TargetPlatform? platform}) → bool
Check if the given method is supported by the defaultTargetPlatform or a specific platform.
isRunning() → bool
Indicates if the server is running or not.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
start() → Future<void>
Starts the server on http://localhost:[port]/.
toString() → String
A string representation of this object.
inherited

Operators

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