Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rchatham/PeerConnectivity
Functional wrapper for Apple's MultipeerConnectivity framework.
https://github.com/rchatham/PeerConnectivity
Last synced: about 1 month ago
JSON representation
Functional wrapper for Apple's MultipeerConnectivity framework.
- Host: GitHub
- URL: https://github.com/rchatham/PeerConnectivity
- Owner: rchatham
- License: mit
- Created: 2016-06-09T21:42:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-16T22:34:53.000Z (about 1 year ago)
- Last Synced: 2024-12-03T12:12:47.369Z (about 1 month ago)
- Language: Swift
- Homepage:
- Size: 2.57 MB
- Stars: 56
- Watchers: 3
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - PeerConnectivity - Functional wrapper for Apple's MultipeerConnectivity framework. (Hardware / Bluetooth)
- awesome-ios-star - PeerConnectivity - Functional wrapper for Apple's MultipeerConnectivity framework. (Hardware / Bluetooth)
README
[]()
[](https://developer.apple.com/swift)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/PeerConnectivity)
[](http://cocoadocs.org/docsets/PeerConnectivity)
[]()
#### A functional wrapper for the MultipeerConnectivity framework.
#### PeerConnectivity is meant to have a lightweight easy to use syntax, be extensible and flexible, and handle the heavy lifting and edge cases of the MultipeerConnectivity framework quietly in the background.
#### Please open an issue or submit a pull request if you have any suggestions!
#### 🔌 Blog post [https://goo.gl/HJcMbE](https://goo.gl/HJcMbE)
## Installation
#### Cocoapods
The easiest way to get started is to use [CocoaPods](http://cocoapods.org/). Just add the following line to your Podfile:
```ruby
pod 'PeerConnectivity', '~> 0.5.4'
```
#### Carthage
```ruby
github "rchatham/PeerConnectivity"
```
## Creating/Stopping/Starting
```swift
var pcm = PeerConnectionManager(serviceType: "local")
// Start
pcm.start()
// Stop
// - You should always stop the connection manager
// before attempting to create a new one
pcm.stop()
// Can join chatrooms using PeerConnectionType.Automatic, .InviteOnly, and .Custom
// - .Automatic : automatically searches and joins other devices with the same service type
// - .InviteOnly : provides a browserViewController and invite alert controllers
// - .Custom : no default behavior is implemented
// The manager can be initialized with a contructed peer representing the local user
// with a custom displayName
pcm = PeerConnectionManager(serviceType: "local", connectionType: .Automatic, displayName: "I_AM_KING")
// Start again at any time
pcm.start() {
// Do something when finished starting the session
}
```
## Sending Events to Peers
```swift
let event: [String: Any] = [
"EventKey" : Date()
]
// Sends to all connected peers
pcm.sendEvent(event)
// Use this to access the connectedPeers
let connectedPeers: [Peer] = pcm.connectedPeers
// Events can be sent to specific peers
if let somePeerThatIAmConnectedTo = connectedPeers.first {
pcm.sendEvent(event, toPeers: [somePeerThatIAmConnectedTo])
}
```
## Listening for Events
```swift
// Listen to an event
pcm.observeEventListenerForKey("someEvent") { (eventInfo, peer) in
print("Received some event \(eventInfo) from \(peer.displayName)")
guard let date = eventInfo["eventKey"] as? Date else { return }
print(date)
}
// Stop listening to an event
pcm.removeListenerForKey("SomeEvent")
```
## Acknowledgments
Icon from the [Noun Project](https://thenounproject.com/search/?q=circle+people&i=125108).
### Helpful links
- Check out the [Demo project](https://github.com/rchatham/PeerConnectivity/tree/master/PeerConnectivityDemo) and [Playground](https://github.com/rchatham/PeerConnectivity/blob/master/PeerPlayground.playground/Contents.swift) for examples to help you take you're app to the next level!!!
- Read the [docs!](http://reidchatham.com/docs/PeerConnectivity/index.html)