Skip to content
This repository was archived by the owner on Jun 19, 2019. It is now read-only.

Repository files navigation


Swift 2.2Platforms OS X | iOS | Linux

##Features

  • Simple Atomic<T> class for numbers and strings.
  • Uncomplicated dispatch keyword for firing off background routines.
  • Awesome Chan<T> for concurrent communication.
  • Useful sync APIs. Mutex, Cond, Once, WaitGroup

Atomic

Types

Int, Int8, Int16, Int32, Int64, UInt, UInt8, UInt16, UInt32, UInt64, Float, Double, Bool, String

Operators

==, !=, &&, ||, <=, >=, >, <, !
+, -, *, /, %, <<, >>, ^, &, &+, &-, &*, ++, --, +=, -=, *=, /=, %=, +=, <<=, >>=, ^=, &=

varanum=IntA(100) // IntA is an alias for Atomic<Int>.
anum +=15 // Adds a value atomically.
letres= anum %4 // Modulo operation atomically.
print("\(anum)\(res)") // prints '115 3'.

Dispatch

Safe adds an uncomplicated method for dispatching routines.

dispatch{print("Background")}print("Foreground")

Channels

A new Chan<T> class provides a clean and simple model for concurrently sharing objects. Chan<T> is modeled after Go channels.

Sharing Memory by Communicating

Example

letjobs=Chan<Int>(5) // buffered channel
letdone=Chan<Bool>() // unbuffered channel
dispatch{
for ;; {iflet j =<-jobs {print("received job \(j)")}else{print("received all jobs")
done <-truereturn}}}
for var j =1; j <=3; j++{
jobs <- j
print("sent job \(j)")}
jobs.close()print("sent all jobs")<-done

Iterate

A channel can also be iterated through.

whilelet j =<-jobs {print("received job \(j)")}print("received all jobs")

Select

The _select keyword is a multiway communications multiplexer that works on multiple channels. _select, _case, and _default start with underscores so that they do not conflict with the select, case, and default syscall and keywords. When a _select encounters multiple channels with data, the chosen _case is selected at random

letjobs1=Chan<Int>()letjobs2=Chan<Int>()dispatch{
for ;; {_select{_case(jobs1){ j inprint("received 1: \(j)")}_case(jobs2){ j inprint("received 2: \(j)")}}}}
for var j =1; ; j++{
jobs1 <-(j *1000)
jobs2 <-(j *2000)NSThread.sleepForTimeInterval(1)}

Select with Default

A _select can contain a single _default for non-blocking operations.

_select{_case(jobs1){ j inprint("received 1: \(j)")}_case(jobs2){ j inprint("received 2: \(j)")}_default{print("channels not ready")}}

Mutex, Cond, Once, WaitGroup

Incredibly useful sync APIs.

Mutex

letm=Mutex()
m.lock() m.unlock() m.lock{
// this block is locked
}

Cond

letc=Cond(Mutex())
c.wait() // wait for signal.
c.wait(0.25) // wait for signal or 250ms to pass.
c.signal() // signal to one wait.
c.broadcast() // signal to all waits.

Once

func f(){print("hey there")}leto=Once()
o.doit(f) // runs once
o.doit(f) // noop: cannot run twice

WaitGroup

letdosomething:(NSTimeInterval,WaitGroup)->()={(delay, wg)inNSThread.sleepForTimeInterval(delay)print("Function in background, duration: \(delay)")
wg.done()}letwg=WaitGroup()
wg.add(1)dispatch{dosomething(0.40, wg)}
wg.add(1)dispatch{dosomething(0.30, wg)}
wg.add(1)dispatch{dosomething(0.15, wg)}
wg.add(1)dispatch{dosomething(0.60, wg)}
wg.wait()print("done")

##Installation (iOS and OS X)

Add the following to your Cartfile:

github "tidwall/Safe"

Then run carthage update.

Follow the current instructions in Carthage's README for up to date installation instructions.

The import Safe directive is required in order to access Safe features.

Add the following to your Podfile:

use_frameworks!pod'Safe'

Then run pod install with CocoaPods 0.36 or newer.

The import Safe directive is required in order to access Safe features.

Add the following to your Package.swift

dependencies:[....Package(url:"https://github.com/tidwall/Safe", majorVersion:1, minor:2)]

Then run swift build.

The import Safe directive is required in order to access Safe features.

Manually

Copy the Source/*.swift file into your project.

There is no need for import Safe when manually installing.

Contact

Josh Baker @tidwall

License

The Safe source code is available under the MIT License.

About

Modern Concurrency and Synchronization for Swift.

Resources

Stars

414 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages