125 lines
4.5 KiB
Markdown
125 lines
4.5 KiB
Markdown
SwiftZMQ
|
|
========
|
|
|
|
[](https://developer.apple.com/swift/)
|
|
[](https://developer.apple.com/swift/)
|
|
[](https://github.com/Carthage/Carthage)
|
|
[](https://tldrlegal.com/license/mit-license)
|
|
[](https://travis-ci.org/Zewo/SwiftZMQ)
|
|
[](http://codecov.io/github/Zewo/SwiftZMQ?branch=master)
|
|
[](https://zewo-slackin.herokuapp.com)
|
|
|
|
**SwiftZMQ** is a [ZeroMQ](http://zeromq.org/) binding for **Swift 2**.
|
|
|
|
## Features
|
|
|
|
- [x] No `Foundation` dependency (**Linux ready**)
|
|
- [x] Context
|
|
- [x] Socket
|
|
- [x] Message
|
|
- [x] Poller
|
|
- [x] Proxy
|
|
|
|
This fork clones the libzmq repo and compiles it statically into the SwiftZMQ framework, also it adds the iOS framework target
|
|
|
|
##Example
|
|
|
|
```swift
|
|
import SwiftZMQ
|
|
|
|
do {
|
|
let context = try Context()
|
|
|
|
let inbound = try context.socket(.Pull)
|
|
try inbound.bind("tcp://127.0.0.1:5555")
|
|
|
|
let outbound = try context.socket(.Push)
|
|
try outbound.connect("tcp://127.0.0.1:5555")
|
|
|
|
try outbound.sendString("Hello World!")
|
|
try outbound.sendString("Bye!")
|
|
|
|
while let data = try inbound.receiveString() where data != "Bye!" {
|
|
print(data) // "Hello World!"
|
|
}
|
|
} catch {
|
|
// Something bad happened :(
|
|
}
|
|
```
|
|
|
|
## Dependency
|
|
|
|
**SwiftZMQ** requires ZeroMQ version 4.2 to be installed. The easiest way on Mac OS X is through brew.
|
|
|
|
```
|
|
> brew install zeromq --with-libsodium --HEAD
|
|
```
|
|
|
|
## Installation
|
|
|
|
### Carthage
|
|
|
|
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
|
|
|
|
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
|
|
|
|
```bash
|
|
$ brew update
|
|
$ brew install carthage
|
|
```
|
|
|
|
To integrate **SwiftZMQ** into your Xcode project using Carthage, specify it in your `Cartfile`:
|
|
|
|
```ogdl
|
|
github "Zewo/SwiftZMQ"
|
|
```
|
|
|
|
### Manually
|
|
|
|
If you prefer not to use a dependency manager, you can integrate **SwiftZMQ** into your project manually.
|
|
|
|
#### Embedded Framework
|
|
|
|
- Open up Terminal, `cd` into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
|
|
|
|
```bash
|
|
$ git init
|
|
```
|
|
|
|
- Add **SwiftZMQ** as a git [submodule](http://git-scm.com/docs/git-submodule) by running the following command:
|
|
|
|
```bash
|
|
$ git submodule add https://github.com/Zewo/SwiftZMQ.git
|
|
```
|
|
|
|
- Open the new `SwiftZMQ` folder, and drag the `SwiftZMQ.xcodeproj` into the Project Navigator of your application's Xcode project.
|
|
|
|
> It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.
|
|
|
|
- Select the `SwiftZMQ.xcodeproj` in the Project Navigator and verify the deployment target matches that of your application target.
|
|
- Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
|
|
- In the tab bar at the top of that window, open the "General" panel.
|
|
- Click on the `+` button under the "Embedded Binaries" section.
|
|
- You will see two different `SwiftZMQ.xcodeproj` folders each with two different versions of the `SwiftZMQ.framework` nested inside a `Products` folder.
|
|
|
|
> It does not matter which `Products` folder you choose from, but it does matter whether you choose the top or bottom `SwiftZMQ.framework`.
|
|
|
|
- Select the top `SwiftZMQ.framework` for OS X and the bottom one for iOS.
|
|
|
|
> You can verify which one you selected by inspecting the build log for your project. The build target for `SwiftZMQ` will be listed as either `SwiftZMQ iOS` or `SwiftZMQ OSX`.
|
|
|
|
- And that's it!
|
|
|
|
> The `SwiftZMQ.framework` is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.
|
|
|
|
## Community
|
|
|
|
[](https://zewo-slackin.herokuapp.com)
|
|
|
|
Join us on [Slack](https://zewo-slackin.herokuapp.com).
|
|
|
|
License
|
|
-------
|
|
|
|
**SwiftZMQ** is released under the MIT license. See LICENSE for details.
|