Skip to content
/ Edge Public
forked from skylab-inc/Lightning

A Swift Multiplatform Web and Networking Framework

Notifications You must be signed in to change notification settings

carabina/Edge

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Edge
Serverside non-blocking IO in Swift
Ask questions in our Slack channel!

Edge

Build Status Slack Status

Node

Edge is an HTTP Server and TCP Client/Server framework written in Swift and inspired by Node.js. It runs on both OS X and Linux. Like Node.js, Edge uses an event-driven, non-blocking I/O model. In the same way that Node.js uses libuv to implement this model, Edge uses libdispatch.

This makes Edge fast and efficient, but it also means that Edge applications can naturally make use of libdispatch to easily offload heavy processing to a background thread.

The name Edge is a play on the name Node, as they are both components of graphs.

Reactive Programming

Edge's event API embraces the concepts of Functional Reactive Programming while still not having any external dependencies. The API is called Reflex and it is a modified version of ReactiveCocoa, but also inspired by RxSwift.

Why did we reimplement?

  • Edge should be easy to use out of the box.
  • Edge is optimized for maximum performance, which requires careful tuning of the internals.
  • The modified API is meant to be more similar to the familiar concepts of Futures and Promises.
  • We don't want to be opinionated about any one framework. We want it to be easy to integate Edge with either ReactiveCocoa or RxSwift.

FRP, greatly simplies management of asynchronous events. The general concept is that we can build a spout which pushes out asynchronous events as they happen. Then we hookup a pipeline of transformations that operate on events and pass the transformed values along. We can even do things like merge streams in interesting ways! Take a look at some of these operations or watch this talk about how FRP is used at Netflix.

Installation

Edge is available as a Swift 3 package (No current 2.2 support). Simply add Edge as a dependency to your Swift Package.

import PackageDescription

let package = Package(
    name: "MyProject",
    dependencies: [
        .Package(url: "https://github.com/SwiftOnEdge/Edge.git", majorVersion: 0, minor: 1)
    ]
)

Usage

TCP

import Edge
import Foundation

let server = try! TCP.Server()
try! server.bind(host: "0.0.0.0", port: 50000)
    
server.listen().startWithNext { connection in
    let byteStream = connection.read()
    let strings = byteStream.map { String(bytes: $0, encoding: .utf8)! }
    
    strings.onNext { message in
        print("Client \(connection) says \"\(message)\"!")
    }
    
    strings.onFailed { error in
        print("Oh no, there was an error! \(error)")
    }
    
    strings.onCompleted {
        print("Goodbye \(connection)!")
    }
    
    byteStream.start()
}

RunLoop.runAll()

Edge is not Node.js

Edge is not meant to fulfill all of the roles of Node.js. Node.js is a JavaScript runtime, while Edge is a TCP/Web server framework. The Swift compiler and package manager, combined with third-party Swift packages, make it unnecessary to build that functionality into Edge.

About

A Swift Multiplatform Web and Networking Framework

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Swift 98.9%
  • Shell 1.1%