A container for web server applications.

Applications are responsible for managing starting and stopping of HTTP server instances across multiple isolates. Behavior specific to an application is implemented by setting the Application's configuration and providing a RequestSinkType.

Instances of this class are created by the command like aqueduct serve tool and rarely used by an Aqueduct developer directly.

Static Methods

document(Type sinkType, ApplicationConfiguration config, PackagePathResolver resolver) → Future<APIDocument>

Constructors

Application()

Properties

configuration ApplicationConfiguration

The configuration for the HTTP server this application is running.

read / write
hasFinishedLaunching → bool

Whether or not this application has finished start successfully.

read-only
isolateStartupTimeout → Duration

Duration to wait for each isolate during startup before considered failure.

read / write
logger Logger

A reference to a logger.

read / write
mainIsolateSink → RequestSinkType

The RequestSink receiving requests on the main isolate.

read-only
server ApplicationServer

The ApplicationServer managing delivering HTTP requests into this application.

read / write
supervisors → List<ApplicationIsolateSupervisor>

Used internally.

read / write
hashCode → int

The hash code for this object.

read-only, inherited
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

start({int numberOfInstances: 1, bool runOnMainIsolate: false, bool consoleLogging: false }) → Future

Starts the application by spawning Isolates that listen for HTTP requests.

stop() → Future

Stops the application from running.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() → String

Returns a string representation of this object.

inherited