Module: Perfect-HTTPServer
protocol HeaderListener
This protocol is used to receive headers during HPACK decoding.
func addHeader(name _: [UInt8], value: [UInt8], sensitive: Bool)
A new header field and value has been decoded.
extension HTTPFilter
static func func contentCompression(data: [String:Any]) throws -> HTTPResponseFilter
Response filter which provides content compression.
Mime types which will be encoded or ignored can be specified with the "compressTypes" and
"ignoreTypes" keys, respectively. The values for these keys should be an array of String
containing either the full mime type or the the main type with a * wildcard. e.g. text/*
The default values for the compressTypes key are: "*/*"
The default values for the ignoreTypes key are: "image/*", "video/*", "audio/*"
class HTTPServer
Stand-alone HTTP server.
var documentRoot = "./webroot" { // Given a "safe" default
The directory in which web documents are sought.
Setting the document root will add a default URL route which permits
static files to be served from within.
var serverPort: UInt16 = 0
The port on which the server is listening.
var serverAddress = "0.0.0.0"
The local address on which the server is listening. The default of 0.0.0.0 indicates any address.
var runAsUser: String?
Switch to user after binding port
var serverName = ""
The canonical server name.
This is important if utilizing the `HTTPRequest.serverName` property.
var ssl: (sslCert: String, sslKey: String)?
var caCert: String?
var certVerifyMode: OpenSSLVerifyMode?
var cipherList = [
func init()
Initialize the server object.
func addRoutes(_ routes: Routes)
Add the Routes to this server.
func setRequestFilters(_ request: [(HTTPRequestFilter, HTTPFilterPriority)]) -> HTTPServer
Set the request filters. Each is provided along with its priority.
The filters can be provided in any order. High priority filters will be sorted above lower priorities.
Filters of equal priority will maintain the order given here.
func setResponseFilters(_ response: [(HTTPResponseFilter, HTTPFilterPriority)]) -> HTTPServer
Set the response filters. Each is provided along with its priority.
The filters can be provided in any order. High priority filters will be sorted above lower priorities.
Filters of equal priority will maintain the order given here.
func bind() throws
Bind the server to the designated address/port
func start() throws
Start the server. Does not return until the server terminates.
func stop()
Stop the server by closing the accepting TCP socket. Calling this will cause the server to break out of the otherwise blocking `start` function.
struct TLSConfiguration
static var defaultCipherList = [
var certPath: String
var keyPath: String?
var caCertPath: String?
var certVerifyMode: OpenSSLVerifyMode?
var cipherList: [String]
func init(certPath: String, keyPath: String? = nil,
caCertPath: String? = nil, certVerifyMode: OpenSSLVerifyMode? = nil,
cipherList: [String] = TLSConfiguration.defaultCipherList)
extension HTTPServer
static func func runAs(_ user: String) -> HTTPServer.Type
struct Server
var name: String
var port: Int
var address: String
var routes: Routes
var requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)]
var responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)]
var tlsConfig: TLSConfiguration?
func init(name: String, address: String, port: Int, routes: Routes,
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = [])
func init(tlsConfig: TLSConfiguration, name: String, address: String, port: Int, routes: Routes,
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = [])
func init(name: String, port: Int, routes: Routes,
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = [])
func init(tlsConfig: TLSConfiguration, name: String, port: Int, routes: Routes,
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = [])
static func func server(name: String, port: Int, routes: Routes,
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = []) -> Server
static func func server(name: String, port: Int, routes: [Route],
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = []) -> Server
static func func server(name: String, port: Int, documentRoot root: String,
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = []) -> Server
static func func secureServer(_ tlsConfig: TLSConfiguration, name: String, port: Int, routes: [Route],
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = []) -> Server
static func func secureServer(_ tlsConfig: TLSConfiguration, name: String, port: Int, routes: Routes,
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = []) -> Server
extension HTTPServer
struct LaunchFailure: Error
class LaunchContext
var terminated = false
var server: Server
func terminate() -> LaunchContext
func wait(seconds: Double = Threading.noTimeout) throws -> Bool
extension HTTPServer
static func func launch(wait: Bool = true, _ server: Server, _ servers: Server...) throws -> [LaunchContext]
static func func launch(wait: Bool = true, name: String, port: Int, routes: [Route],
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = []) throws -> LaunchContext
static func func launch(wait: Bool = true, _ servers: [Server]) throws -> [LaunchContext]
static func func launch(wait: Bool = true, name: String, port: Int, routes: Routes,
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = []) throws -> LaunchContext
static func func launch(wait: Bool = true, name: String, port: Int, documentRoot root: String,
requestFilters: [(HTTPRequestFilter, HTTPFilterPriority)] = [],
responseFilters: [(HTTPResponseFilter, HTTPFilterPriority)] = []) throws -> LaunchContext
extension HTTPServer
static func func launch(wait: Bool = true, configurationPath path: String) throws -> [LaunchContext]
static func func launch(wait: Bool = true, configurationFile file: File) throws -> [LaunchContext]
static func func launch(wait: Bool = true, configurationData data: [String:Any]) throws -> [LaunchContext]
struct HTTPHandler
static func func staticFiles(data: [String:Any]) throws -> RequestHandler
Returns a handler which will serve static files out of the indicated directory.
If allowResponseFilters is false (which is the default) then the file will be sent in
the most efficient way possible and output filters will be bypassed.
static func func redirect(data: [String:Any]) throws -> RequestHandler
Redirect any matching URI to the server indicated by "base".
The request.uri will be appended to the base.
struct HTTPFilter
static func func custom404(data: [String:Any]) throws -> HTTPResponseFilter
Any 404 responses will have the body replaced by the indictated file's contents.
static func func customReqFilter(data: [String:Any]) throws -> HTTPRequestFilter