Application

Topics

Structures

• struct LifecycleError
  Asking an application to do something its lifecycle does not allow.
• struct ServiceConfiguration

Initializers

• init(Environment?, configuration: ServerConfiguration, configReader: ConfigReader, services: ServiceConfiguration) async throws

Instance Properties

• let cache: any Cache
  The Cache configured in the application
• let client: any Client
  The Client configured in the application
• let configReader: ConfigReader
  Configuration reader used to read configuration values.
• var didShutdown: Bool
• let directoryConfiguration: DirectoryConfiguration
  The directory information the app is running in
• let environment: Environment
  The environment the application is running in
• var fileio: FileIO
• var middleware: Middlewares
• var routes: Routes
  The routes registered on this application.
• let server: any Server
  The application’s HTTP server.
• var serverConfiguration: ServerConfiguration
• let sessionDriver: any SessionDriver
  The SessionDriver configured in the application
• var sessionsMiddleware: SessionsMiddleware
• var state: State
  Where the application is in its lifecycle.
• let viewRenderer: any ViewRenderer
  The ViewRenderer configured in the application

Instance Methods

• func addLifecycleHandler(any LifecycleHandler)
  Register a LifecycleHandler with the application. Vapor will call the different lifecycle events when they are reached
• func addService(any Service)
  Register an additional Service to run alongside the HTTP server.
• func boot() async throws
  Called when the applications starts up, will trigger the lifecycle handlers. The asynchronous version of boot()
• func routesASCIITable() -> String
  Returns all routes registered to the Application’s Router in an ASCII-formatted table String.
• func run() async throws
  Runs the application as a Service (no signal handling).
• func shutdown() async throws
• func start() async throws
  Starts the application as a standalone process with signal handling.

Enumerations

• enum AddressConfigurationError
  Errors that may be thrown when serving a server
• enum ServiceOptionType
• enum State
  Where the application is in its lifecycle.

Default Implementations

• RoutesBuilder Implementations