Engine

Engine is a collection of low level transport protocols implemented in pure Swift intended for use in server side and client side applications. It is used as the core transport layer in Vapor.

Engine

HTTP and Stream layers

WebSockets

Realtime websockets

SMTP

Send emails.

🌏 Current Environment

Vapor	Xcode	Swift
0.14.x	8.0 Beta 2	3.0-PREVIEW-2

You can run the following script to verify your environment is correct.

curl -sL check.qutheory.io | bash

Linux Ready

Quick Start

HTTPClient

import Engine

let response = try HTTPClient<TCPClientStream>.get("http://pokeapi.co/api/v2/pokemon/")
print(response)

HTTPServer

import Engine

final class Responder: HTTPResponder {
    func respond(to request: HTTPRequest) throws -> HTTPResponse {
        let body = "Hello World".makeBody()
        return HTTPResponse(body: body)
    }
}

let server = try HTTPServer<TCPServerStream, HTTPParser<HTTPRequest>, HTTPSerializer<HTTPResponse>>(port: port)

print("visit http://localhost:\(port)/")
try server.start(responder: Responder()) { error in
    print("Got error: \(error)")
}

WebSocket Client

import Engine
import WebSockets

try WebSocket.connect(to: url) { ws in
    print("Connected to \(url)")

    ws.onText = { ws, text in
        print("[event] - \(text)")
    }

    ws.onClose = { ws, _, _, _ in
        print("\n[CLOSED]\n")
    }
}

WebSocket Server

import Engine
import WebSockets

final class Responder: HTTPResponder {
    func respond(to request: HTTPRequest) throws -> HTTPResponse {
        return try request.upgradeToWebSocket { ws in
            print("[ws connected]")

            ws.onText = { ws, text in
                print("[ws text] \(text)")
                try ws.send("🎙 \(text)")
            }

            ws.onClose = { _, code, reason, clean in
                print("[ws close] \(clean ? "clean" : "dirty") \(code?.description ?? "") \(reason ?? "")")
            }
        }
    }
}

let server = try HTTPServer<TCPServerStream, HTTPParser<HTTPRequest>, HTTPSerializer<HTTPResponse>>(port: port)

print("Connect websocket to http://localhost:\(port)/")
try server.start(responder: Responder()) { error in
    print("Got server error: \(error)")
}

SMTP

import SMTP

let credentials = SMTPCredentials(
    user: "server-admin-login",
    pass: "secret-server-password"
)

let from = EmailAddress(name: "Password Reset",
                        address: "noreply@myapp.com")
let to = "some-user@random.com"
let email: Email = Email(from: from,
                         to: to,
                         subject: "Vapor SMTP - Simple",
                         body: "Hello from Vapor SMTP 👋")

let client = try SMTPClient<TCPClientStream>.makeGmailClient()
try client.send(email, using: credentials)

Architecture

HTTPServer

The HTTPServer is responsible for listening and accepting remote connections, then relaying requests and responses between the received connection and the responder.

HTTPClient

The HTTPClient is responsible for establishing remote connections and relaying requests and responses between the remote connection and the caller.

📖 Documentation

Visit official Vapor Documentation for extensive information on getting setup, using, and deploying Vapor.

💙 Code of Conduct

Our goal is to create a safe and empowering environment for anyone who decides to use or contribute to Vapor. Please help us make the community a better place by abiding to this Code of Conduct during your interactions surrounding this project.

💡 Evolution

Contributing code isn't the only way to participate in Vapor. Taking a page out of the Swift team's playbook, we want you to participate in the evolution of the Vapor framework. File a GitHub issue on this repository to start a discussion or suggest an awesome idea.

💧 Community

We pride ourselves on providing a diverse and welcoming community. Join your fellow Vapor developers in our slack and take part in the conversation.

🔧 Compatibility

Vapor has been tested on OS X 10.11, Ubuntu 14.04, and Ubuntu 15.10.

Our homepage http://qutheory.io is currently running using Vapor on DigitalOcean.

👥 Authors

Made by Tanner Nelson, Logan Wright, and the hundreds of members of the Qutheory community.