Swiftpack.co - Package - insidegui/MultipeerKit

MultipeerKit

A high-level abstraction built on top of the MultipeerConnectivity framework, which allows iOS, macOS and tvOS devices to exchange data between them over Wi-Fi networks, peer-to-peer Wi-Fi, and Bluetooth.

Sample app

Check the example folder for a sample implementation.

Sample

Info.plist configuration

In order for MultipeerKit to work when running on iOS 14, you will have to include two keys in your app's Info.plist file.

The keys are Privacy - Local Network Usage Description (NSLocalNetworkUsageDescription) and Bonjour services (NSBonjourServices).

For the privacy key, include a human-readable description of what benefit the user gets by allowing your app to access devices on the local network.

The Bonjour services key is an array of service types that your app will browse for. For MultipeerKit, the entry should be in the format _servicename._tcp, where servicename is the serviceType you've set in your MultipeerConfiguration. If you're using the default configuration, the value of this key should be _MKSVC._tcp.

If you do not configure the above keys properly, then MultipeerKit won't work.

Usage

The main class in this library is MultipeerTransceiver, which does both the sending and receiving aspects of the multipeer communication.

MultipeerKit can transmit and receive anything that conforms to the Codable protocol, which makes it easy for you to define your own message types.

// Create a transceiver (make sure you store it somewhere, like a property)
let transceiver = MultipeerTransceiver()

// Start it up!
transceiver.resume()

// Configure message receivers
transceiver.receive(SomeCodableThing.self) { payload, sender in
print("Got my thing from \(sender.name)! \(payload)")
}

// Broadcast message to peers
let payload = SomeEncodableThing()
transceiver.broadcast(payload)

For more information on how to use MultipeerKit, check out the documentation.

Integrating

MultipeerKit is a Swift package, to use it in your project, add this to your Package.swift file:

let package = Package(
    ...
    dependencies: [
        .package(url: "https://github.com/insidegui/MultipeerKit.git", from: "0.2.0")
    ],
    ...
)

Github

link
Stars: 826

Dependencies

Used By

Total: 0

Releases

Version 0.3.1 - 2020-09-30 16:14:55

Addresses a crash which would occur when the app's Info.plist was missing required keys on iOS 14. See the readme for more information.

0.3.0 - 2020-07-08 23:16:07

Receiver blocks now receive the Peer the message was sent from. This is a breaking change to the API, but it's very easy to account for in your code.

If you were previously doing something like this:

transceiver.receive(SomeCodableThing.self) { payload in
    // handle
}

All you have to do is ignore the sender parameter in the closure, like so:

transceiver.receive(SomeCodableThing.self) { payload, _ in
    // handle
}

0.2.1 - 2020-05-14 12:24:09

Adds localPeerId property so that the your own peer ID can be accessed through the transceiver.

- 2020-04-17 15:11:21