https://github.com/tobias/vertx-swift-eventbus

Lib for using the Vert.x TCP EventBus bridge from Swift
https://github.com/tobias/vertx-swift-eventbus

Last synced: about 2 months ago
JSON representation

Lib for using the Vert.x TCP EventBus bridge from Swift

• Host: GitHub
• URL: https://github.com/tobias/vertx-swift-eventbus
• Owner: tobias
• License: apache-2.0
• Created: 2016-05-13T14:56:53.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-04-24T14:50:30.000Z (over 6 years ago)
• Last Synced: 2024-05-01T23:24:01.320Z (5 months ago)
• Language: Swift
• Size: 128 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• vertx-awesome - Swift - Event bus client for [Apple's Swift](https://swift.org) using the [TCP-based protocol](https://github.com/vert-x3/vertx-tcp-eventbus-bridge). (Vert.x Event Bus Clients)

README

        

**Maintainer Wanted - see [here](https://github.com/tobias/vertx-swift-eventbus/issues/11)**

This provides a Swift client for talking to [Vert.x](http://vertx.io)

via the

[vertx-tcp-eventbus-bridge](https://github.com/vert-x3/vertx-tcp-eventbus-bridge).

It has only been tested with [Swift 3.1](https://swift.org/download/)

on MacOS X and Ubuntu.

A simple example application is available in [example-project](https://github.com/tobias/vertx-swift-eventbus/tree/master/example-project).

The API docs are available at http://tobias.github.io/vertx-swift-eventbus/.

## Usage

The latest release is `0.2.0`. To use it with Swift Package Manager,

add the following to your dependencies in `Package.swift`:

```swift

.Package(url: "https://github.com/tobias/vertx-swift-eventbus.git", "0.2.0")

```

## Running the tests

`make test`

The tests build a Vert.x server and launch it, so you'll need Java (8

or higher) and maven installed.

## Generating docs

To generate documentation, you'll need to have

[`sourcekitten`](https://github.com/jpsim/SourceKitten) and

[`jazzy`](https://github.com/realm/jazzy) installed. The easiest way

to do that (on MacOS) is with:

```

brew install sourcekitten

sudo gem install jazzy

```

Then, build the docs with:

`make docs`

The generated docs will be available in `docs/`.

## License

vertx-swift-eventbus is licensed under the Apache License, v2. See

[LICENSE](https://github.com/tobias/vertx-swift-eventbus/blob/master/LICENSE) for details.