Application

Topics

Classes

• class Locks

Structures

• struct Caches
• struct Clients
• struct Core
• struct HTTP
• struct Lifecycle
• struct Password
• struct Passwords
• struct Responder
• struct Running
• struct Servers
• struct Service
• struct Services
• struct Sessions
• struct Views

Initializers

• convenience init(Environment, Application.EventLoopGroupProvider)

Instance Properties

• var allocator: ByteBufferAllocator
• var asyncCommands: AsyncCommands
• var cache: any Cache
  Current application cache. See Request.cache for caching in request handlers.
• var caches: Application.Caches
  Controls application’s configured caches.
• var client: any Client
• var clients: Application.Clients
• var commands: Commands
• var console: any Console
• var didShutdown: Bool
• var directory: DirectoryConfiguration
• var environment: Environment
• let eventLoopGroup: any EventLoopGroup
• let eventLoopGroupProvider: Application.EventLoopGroupProvider
• var fileio: NonBlockingFileIO
• var http: Application.HTTP
• var lifecycle: Application.Lifecycle
• var locks: Application.Locks
• var logger: Logger
• var middleware: Middlewares
• var password: Application.Password
• var passwords: Application.Passwords
• var responder: Application.Responder
• var routes: Routes
• var running: Application.Running?
• var server: any Server
• var servers: Application.Servers
• var services: Application.Services
• var sessions: Application.Sessions
• var storage: Storage
• var sync: NIOLock
• var threadPool: NIOThreadPool
  The application thread pool. Vapor uses NIOSingletons.posixBlockingThreadPool by default for this, which defaults to a thread pool of size equal to the number of available cores.
• var traceAutoPropagation: Bool
  If enabled, tracing propagation is automatically handled by restoring & setting request.serviceContext automatically across Vapor-internal EventLoopFuture boundaries. If disabled, traces will not automatically nest, and the user should restore & set request.serviceContext manually where needed. There are performance implications to enabling this feature.
• var view: any ViewRenderer
• var views: Application.Views

Instance Methods

• func asyncBoot() async throws
  Called when the applications starts up, will trigger the lifecycle handlers. The asynchronous version of boot()
• func asyncShutdown() async throws
• func boot() throws
• func execute() async throws
  Starts the Application asynchronous using the startup() method, then waits for any running tasks to complete. If your application is started without arguments, the default argument is used.
• func run() throws
  Starts the Application using the start() method, then waits for any running tasks to complete. If your application is started without arguments, the default argument is used.
• func shutdown()
• func start() throws
  When called, this will execute the startup command provided through an argument. If no startup command is provided, the default is used. Under normal circumstances, this will start running Vapor’s webserver.
• func startup() async throws
  When called, this will asynchronously execute the startup command provided through an argument. If no startup command is provided, the default is used. Under normal circumstances, this will start running Vapor’s webserver.

Type Methods

• static func make(Environment, Application.EventLoopGroupProvider) async throws -> Application
• static func make(Environment, Application.EventLoopGroupProvider, logger: Logger) async throws -> Application

Enumerations

• enum EventLoopGroupProvider

Default Implementations

• RoutesBuilder Implementations