diff --git a/Documentation/Home.md b/Documentation/Home.md deleted file mode 100755 index 18c40f0..0000000 --- a/Documentation/Home.md +++ /dev/null @@ -1,8 +0,0 @@ -# Types - - - [MultipeerConfiguration](MultipeerConfiguration) - - [MultipeerConfiguration.Invitation](MultipeerConfiguration_Invitation) - - [MultipeerConfiguration.Security](MultipeerConfiguration_Security) - - [MultipeerDataSource](MultipeerDataSource) - - [MultipeerTransceiver](MultipeerTransceiver) - - [Peer](Peer) diff --git a/Documentation/MultipeerConfiguration.md b/Documentation/MultipeerConfiguration.md deleted file mode 100755 index a76f954..0000000 --- a/Documentation/MultipeerConfiguration.md +++ /dev/null @@ -1,81 +0,0 @@ -# MultipeerConfiguration - -Configures several aspects of the multipeer communication. - -``` swift -public struct MultipeerConfiguration -``` - -## Initializers - -### `init(serviceType:peerName:defaults:security:invitation:)` - -Creates a new configuration. - -``` swift -public init(serviceType: String, peerName: String, defaults: UserDefaults, security: Security, invitation: Invitation) -``` - -#### Parameters - - - serviceType: This must be the same accross your app running on multiple devices, it must be a short string. Check Apple's docs on `MCNearbyServiceAdvertiser` for more info on the limitations for this field. - - peerName: A display name for this peer that will be shown to nearby peers. - - defaults: An instance of `UserDefaults` that's used to store this peer's identity so that it remains stable between different sessions. If you use MultipeerKit in app extension make sure to use a shared app group if you wish to maintain a stable identity. - - security: The security configuration. - - invitation: Defines how the multipeer connection handles newly discovered peers. New peers can be invited automatically, invited with a custom context or not invited at all, in which case you must invite them manually. - -## Properties - -### `serviceType` - -This must be the same accross your app running on multiple devices, -it must be a short string. - -``` swift -var serviceType: String -``` - -Check Apple's docs on `MCNearbyServiceAdvertiser` for more info on the limitations for this field. - -### `peerName` - -A display name for this peer that will be shown to nearby peers. - -``` swift -var peerName: String -``` - -### `defaults` - -An instance of `UserDefaults` that's used to store this peer's identity so that it -remains stable between different sessions. If you use MultipeerKit in app extensions, -make sure to use a shared app group if you wish to maintain a stable identity. - -``` swift -var defaults: UserDefaults -``` - -### `security` - -The security configuration. - -``` swift -var security: Security -``` - -### `invitation` - -Defines how the multipeer connection handles newly discovered peers. - -``` swift -var invitation: Invitation -``` - -### `` `default` `` - -The default configuration, uses the service type `MKSVC`, the name of the device/computer as the -display name, `UserDefaults.standard`, the default security configuration and automatic invitation. - -``` swift -let `default` -``` diff --git a/Documentation/MultipeerConfiguration/index.html b/Documentation/MultipeerConfiguration/index.html new file mode 100755 index 0000000..5fa9d9d --- /dev/null +++ b/Documentation/MultipeerConfiguration/index.html @@ -0,0 +1,1358 @@ + + + + + + MultipeerKit - MultipeerConfiguration + + + +
+ + + MultipeerKit + + Documentation + + Beta +
+ + + + + +
+
+

+ Structure + Multipeer​Configuration +

+ +
public struct MultipeerConfiguration
+
+

Configures several aspects of the multipeer communication.

+ +
+ +
+

Initializers

+ +
+

+ init(service​Type:​peer​Name:​defaults:​security:​invitation:​) +

+ 
public init(serviceType: String, peerName: String, defaults: UserDefaults, security: Security, invitation: Invitation)
+
+

Creates a new configuration.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
service​TypeString

This must be the same accross your app running on multiple devices, it must be a short string. Check Apple's docs on MCNearbyServiceAdvertiser for more info on the limitations for this field.

+
peer​NameString

A display name for this peer that will be shown to nearby peers.

+
defaultsUser​Defaults

An instance of UserDefaults that's used to store this peer's identity so that it remains stable between different sessions. If you use MultipeerKit in app extension make sure to use a shared app group if you wish to maintain a stable identity.

+
securitySecurity

The security configuration.

+
invitationInvitation

Defines how the multipeer connection handles newly discovered peers. New peers can be invited automatically, invited with a custom context or not invited at all, in which case you must invite them manually.

+
+
+
+
+

Properties

+ +
+

+ service​Type +

+ 
var serviceType: String
+
+

This must be the same accross your app running on multiple devices, +it must be a short string.

+ +
+
+

Check Apple's docs on MCNearbyServiceAdvertiser for more info on the limitations for this field.

+ +
+
+
+

+ peer​Name +

+ 
var peerName: String
+
+

A display name for this peer that will be shown to nearby peers.

+ +
+
+
+

+ defaults +

+ 
var defaults: UserDefaults
+
+

An instance of UserDefaults that's used to store this peer's identity so that it +remains stable between different sessions. If you use MultipeerKit in app extensions, +make sure to use a shared app group if you wish to maintain a stable identity.

+ +
+
+
+

+ security +

+ 
var security: Security
+
+

The security configuration.

+ +
+
+
+

+ invitation +

+ 
var invitation: Invitation
+
+

Defines how the multipeer connection handles newly discovered peers.

+ +
+
+
+

+ `default` +

+ 
let `default`
+
+

The default configuration, uses the service type MKSVC, the name of the device/computer as the +display name, UserDefaults.standard, the default security configuration and automatic invitation.

+ +
+
+
+ + + +
+
+ + + + diff --git a/Documentation/MultipeerConfiguration_Invitation.md b/Documentation/MultipeerConfiguration_Invitation.md deleted file mode 100755 index a32bdab..0000000 --- a/Documentation/MultipeerConfiguration_Invitation.md +++ /dev/null @@ -1,36 +0,0 @@ -# MultipeerConfiguration.Invitation - -Defines how the multipeer connection handles newly discovered peers. -New peers can be invited automatically, invited with a custom context and timeout, -or not invited at all, in which case you must invite them manually. - -``` swift -public enum Invitation -``` - -## Enumeration Cases - -### `automatic` - -When `.automatic` is used, all found peers will be immediately invited to join the session. - -``` swift -case automatic -``` - -### `custom` - -Use `.custom` when you want to control the invitation of new peers to your session, -but still invite them at the time of discovery. - -``` swift -case custom(: (Peer) throws -> (context: Data, timeout: TimeInterval)?) -``` - -### `none` - -Use `.none` when you want to manually invite peers by calling `invite` in `MultipeerTransceiver`. - -``` swift -case none -``` diff --git a/Documentation/MultipeerConfiguration_Invitation/index.html b/Documentation/MultipeerConfiguration_Invitation/index.html new file mode 100755 index 0000000..5cedb97 --- /dev/null +++ b/Documentation/MultipeerConfiguration_Invitation/index.html @@ -0,0 +1,1266 @@ + + + + + + MultipeerKit - MultipeerConfiguration.Invitation + + + +
+ + + MultipeerKit + + Documentation + + Beta +
+ + + + + +
+
+

+ Enumeration + Multipeer​Configuration.​Invitation +

+ +
public enum Invitation
+
+

Defines how the multipeer connection handles newly discovered peers. +New peers can be invited automatically, invited with a custom context and timeout, +or not invited at all, in which case you must invite them manually.

+ +
+ +
+

Enumeration Cases

+ +
+

+ automatic +

+ 
case automatic
+
+

When .automatic is used, all found peers will be immediately invited to join the session.

+ +
+
+
+

+ custom +

+ 
case custom(: (Peer) throws -> (context: Data, timeout: TimeInterval)?)
+
+

Use .custom when you want to control the invitation of new peers to your session, +but still invite them at the time of discovery.

+ +
+
+
+

+ none +

+ 
case none
+
+

Use .none when you want to manually invite peers by calling invite in MultipeerTransceiver.

+ +
+
+
+ + + +
+
+ + + + diff --git a/Documentation/MultipeerConfiguration_Security.md b/Documentation/MultipeerConfiguration_Security.md deleted file mode 100755 index f34d2f5..0000000 --- a/Documentation/MultipeerConfiguration_Security.md +++ /dev/null @@ -1,71 +0,0 @@ -# MultipeerConfiguration.Security - -Configures security-related aspects of the multipeer connection. - -``` swift -public struct Security -``` - -## Nested Type Aliases - -### `InvitationHandler` - -``` swift -public typealias InvitationHandler = (Peer, Data?, @escaping (Bool) -> Void) -> Void -``` - -## Initializers - -### `init(identity:encryptionPreference:invitationHandler:)` - -``` swift -public init(identity: [Any]?, encryptionPreference: MCEncryptionPreference, invitationHandler: @escaping InvitationHandler) -``` - -## Properties - -### `identity` - -An array of information that can be used to identify the peer to other nearby peers. - -``` swift -var identity: [Any]? -``` - -The first object in this array should be a `SecIdentity` object that provides the local peer’s identity. - -The remainder of the array should contain zero or more additional SecCertificate objects that provide any -intermediate certificates that nearby peers might require when verifying the local peer’s identity. -These certificates should be sent in certificate chain order. - -Check Apple's `MCSession` docs for more information. - -### `encryptionPreference` - -Configure the level of encryption to be used for communications. - -``` swift -var encryptionPreference: MCEncryptionPreference -``` - -### `invitationHandler` - -A custom closure to be used when handling invitations received by remote peers. - -``` swift -var invitationHandler: InvitationHandler -``` - -It receives the `Peer` that sent the invitation, a custom `Data` value -that's a context that can be used to customize the invitation, -and a closure to be called with `true` to accept the invitation or `false` to reject it. - -The default implementation accepts all invitations. - -### `` `default` `` - -The default security configuration, which has no identity, uses no encryption and accepts all invitations. - -``` swift -let `default` -``` diff --git a/Documentation/MultipeerConfiguration_Security/index.html b/Documentation/MultipeerConfiguration_Security/index.html new file mode 100755 index 0000000..064ff67 --- /dev/null +++ b/Documentation/MultipeerConfiguration_Security/index.html @@ -0,0 +1,1311 @@ + + + + + + MultipeerKit - MultipeerConfiguration.Security + + + +
+ + + MultipeerKit + + Documentation + + Beta +
+ + + + + +
+
+

+ Structure + Multipeer​Configuration.​Security +

+ +
public struct Security
+
+

Configures security-related aspects of the multipeer connection.

+ +
+ +
+

Nested Type Aliases

+ +
+

+ Invitation​Handler +

+ 
public typealias InvitationHandler = (Peer, Data?, @escaping (Bool) -> Void) -> Void
+
+
+
+

Initializers

+ +
+

+ init(identity:​encryption​Preference:​invitation​Handler:​) +

+ 
public init(identity: [Any]?, encryptionPreference: MCEncryptionPreference, invitationHandler: @escaping InvitationHandler)
+
+
+
+

Properties

+ +
+

+ identity +

+ 
var identity: [Any]?
+
+

An array of information that can be used to identify the peer to other nearby peers.

+ +
+
+

The first object in this array should be a SecIdentity object that provides the local peer’s identity.

+ +

The remainder of the array should contain zero or more additional SecCertificate objects that provide any +intermediate certificates that nearby peers might require when verifying the local peer’s identity. +These certificates should be sent in certificate chain order.

+ +

Check Apple's MCSession docs for more information.

+ +
+
+
+

+ encryption​Preference +

+ 
var encryptionPreference: MCEncryptionPreference
+
+

Configure the level of encryption to be used for communications.

+ +
+
+
+

+ invitation​Handler +

+ 
var invitationHandler: InvitationHandler
+
+

A custom closure to be used when handling invitations received by remote peers.

+ +
+
+

It receives the Peer that sent the invitation, a custom Data value +that's a context that can be used to customize the invitation, +and a closure to be called with true to accept the invitation or false to reject it.

+ +

The default implementation accepts all invitations.

+ +
+
+
+

+ `default` +

+ 
let `default`
+
+

The default security configuration, which has no identity, uses no encryption and accepts all invitations.

+ +
+
+
+ + + +
+
+ + + + diff --git a/Documentation/MultipeerDataSource.md b/Documentation/MultipeerDataSource.md deleted file mode 100755 index f359435..0000000 --- a/Documentation/MultipeerDataSource.md +++ /dev/null @@ -1,39 +0,0 @@ -# MultipeerDataSource - -``` swift -@available(tvOS 13.0, *) @available(OSX 10.15, *) @available(iOS 13.0, *) public final class MultipeerDataSource: ObservableObject -``` - -## Inheritance - -`ObservableObject` - -## Initializers - -### `init(transceiver:)` - -Initializes a new data source. - -``` swift -public init(transceiver: MultipeerTransceiver) -``` - -#### Parameters - - - transceiver: The transceiver to be used by this data source. Note that the data source will set `availablePeersDidChange` on the transceiver, so if you wish to use that closure yourself, you won't be able to use the data source. - -## Properties - -### `transceiver` - -``` swift -let transceiver: MultipeerTransceiver -``` - -### `availablePeers` - -Peers currently available for invitation, connection and data transmission. - -``` swift -var availablePeers: [Peer] -``` diff --git a/Documentation/MultipeerDataSource/index.html b/Documentation/MultipeerDataSource/index.html new file mode 100755 index 0000000..462b504 --- /dev/null +++ b/Documentation/MultipeerDataSource/index.html @@ -0,0 +1,1323 @@ + + + + + + MultipeerKit - MultipeerDataSource + + + +
+ + + MultipeerKit + + Documentation + + Beta +
+ + + + + +
+
+

+ Class + Multipeer​Data​Source +

+ +
@available(tvOS 13.0, *) @available(OSX 10.15, *) @available(iOS 13.0, *) public final class MultipeerDataSource: ObservableObject
+
+ +
+ + + + + + +%3 + + + +MultipeerDataSource + + +MultipeerDataSource + + + + + +ObservableObject + +ObservableObject + + + +MultipeerDataSource->ObservableObject + + + + + + + + +
+

Conforms To

+
+
ObservableObject
+
+
+
+

Initializers

+ +
+

+ init(transceiver:​) +

+ 
public init(transceiver: MultipeerTransceiver)
+
+

Initializes a new data source.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + +
transceiverMultipeer​Transceiver

The transceiver to be used by this data source. Note that the data source will set availablePeersDidChange on the transceiver, so if you wish to use that closure yourself, you won't be able to use the data source.

+
+
+
+
+

Properties

+ +
+

+ transceiver +

+ 
let transceiver: MultipeerTransceiver
+
+
+

+ available​Peers +

+ 
var availablePeers: [Peer]
+
+

Peers currently available for invitation, connection and data transmission.

+ +
+
+
+ + + +
+
+ + + + diff --git a/Documentation/MultipeerTransceiver.md b/Documentation/MultipeerTransceiver.md deleted file mode 100755 index 42e0d73..0000000 --- a/Documentation/MultipeerTransceiver.md +++ /dev/null @@ -1,137 +0,0 @@ -# MultipeerTransceiver - -Handles all aspects related to the multipeer communication. - -``` swift -public final class MultipeerTransceiver -``` - -## Initializers - -### `init(configuration:)` - -Initializes a new transceiver. - -``` swift -public init(configuration: MultipeerConfiguration = .default) -``` - -#### Parameters - - - configuration: The configuration, uses the default configuration if none specified. - -## Properties - -### `availablePeersDidChange` - -Called on the main queue when available peers have changed (new peers discovered or peers removed). - -``` swift -var availablePeersDidChange: ([Peer]) -> Void -``` - -### `peerAdded` - -Called on the main queue when a new peer discovered. - -``` swift -var peerAdded: (Peer) -> Void -``` - -### `peerRemoved` - -Called on the main queue when a peer removed. - -``` swift -var peerRemoved: (Peer) -> Void -``` - -### `availablePeers` - -All peers currently available for invitation, connection and data transmission. - -``` swift -var availablePeers: [Peer] -``` - -## Methods - -### `receive(_:using:)` - -Configures a new handler for a specific `Codable` type. - -``` swift -public func receive(_ type: T.Type, using closure: @escaping (_ payload: T) -> Void) -``` - -MultipeerKit communicates data between peers as JSON-encoded payloads which originate with -`Codable` entities. You register a closure to handle each specific type of entity, -and this closure is automatically called by the framework when a remote peer sends -a message containing an entity that decodes to the specified type. - -#### Parameters - - - type: The `Codable` type to receive. - - closure: The closure that will be called whenever a payload of the specified type is received. - - payload: The payload decoded from the remote message. - -### `resume()` - -Resumes the transceiver, allowing this peer to be discovered and to discover remote peers. - -``` swift -public func resume() -``` - -### `stop()` - -Stops the transceiver, preventing this peer from discovering and being discovered. - -``` swift -public func stop() -``` - -### `broadcast(_:)` - -Sends a message to all connected peers. - -``` swift -public func broadcast(_ payload: T) -``` - -#### Parameters - - - payload: The payload to be sent. - -### `send(_:to:)` - -Sends a message to a specific peer. - -``` swift -public func send(_ payload: T, to peers: [Peer]) -``` - -#### Parameters - - - payload: The payload to be sent. - - peers: An array of peers to send the message to. - -### `invite(_:with:timeout:completion:)` - -Manually invite a peer for communicating. - -``` swift -public func invite(_ peer: Peer, with context: Data?, timeout: TimeInterval, completion: InvitationCompletionHandler?) -``` - -You can call this method to manually invite a peer for communicating if you set the -`invitation` parameter to `.none` in the transceiver's `configuration`. - -> Warning: If the invitation parameter is not set to `.none`, you shouldn't call this method, since the transceiver does the inviting automatically. - -#### Parameters - - - peer: The peer to be invited. - - context: Custom data to be sent alongside the invitation. - - timeout: How long to wait for the remote peer to accept the invitation. - - completion: Called when the invitation succeeds or fails. diff --git a/Documentation/MultipeerTransceiver/index.html b/Documentation/MultipeerTransceiver/index.html new file mode 100755 index 0000000..50bf9b1 --- /dev/null +++ b/Documentation/MultipeerTransceiver/index.html @@ -0,0 +1,1498 @@ + + + + + + MultipeerKit - MultipeerTransceiver + + + +
+ + + MultipeerKit + + Documentation + + Beta +
+ + + + + +
+
+

+ Class + Multipeer​Transceiver +

+ +
public final class MultipeerTransceiver
+
+

Handles all aspects related to the multipeer communication.

+ +
+ +
+

Initializers

+ +
+

+ init(configuration:​) +

+ 
public init(configuration: MultipeerConfiguration = .default)
+
+

Initializes a new transceiver.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + +
configurationMultipeer​Configuration

The configuration, uses the default configuration if none specified.

+
+
+
+
+

Properties

+ +
+

+ available​Peers​Did​Change +

+ 
var availablePeersDidChange: ([Peer]) -> Void
+
+

Called on the main queue when available peers have changed (new peers discovered or peers removed).

+ +
+
+
+

+ peer​Added +

+ 
var peerAdded: (Peer) -> Void
+
+

Called on the main queue when a new peer discovered.

+ +
+
+
+

+ peer​Removed +

+ 
var peerRemoved: (Peer) -> Void
+
+

Called on the main queue when a peer removed.

+ +
+
+
+

+ available​Peers +

+ 
var availablePeers: [Peer]
+
+

All peers currently available for invitation, connection and data transmission.

+ +
+
+
+
+

Methods

+ +
+

+ receive(_:​using:​) +

+ 
public func receive<T: Codable>(_ type: T.Type, using closure: @escaping (_ payload: T) -> Void)
+
+

Configures a new handler for a specific Codable type.

+ +
+
+

MultipeerKit communicates data between peers as JSON-encoded payloads which originate with +Codable entities. You register a closure to handle each specific type of entity, +and this closure is automatically called by the framework when a remote peer sends +a message containing an entity that decodes to the specified type.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
typeT.​Type

The Codable type to receive.

+
closure@escaping (_ payload:​ T) -> Void

The closure that will be called whenever a payload of the specified type is received.

+
payload

The payload decoded from the remote message.

+
+
+
+

+ resume() +

+ 
public func resume()
+
+

Resumes the transceiver, allowing this peer to be discovered and to discover remote peers.

+ +
+
+
+

+ stop() +

+ 
public func stop()
+
+

Stops the transceiver, preventing this peer from discovering and being discovered.

+ +
+
+
+

+ broadcast(_:​) +

+ 
public func broadcast<T: Encodable>(_ payload: T)
+
+

Sends a message to all connected peers.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + +
payloadT

The payload to be sent.

+
+
+
+

+ send(_:​to:​) +

+ 
public func send<T: Encodable>(_ payload: T, to peers: [Peer])
+
+

Sends a message to a specific peer.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
payloadT

The payload to be sent.

+
peers[Peer]

An array of peers to send the message to.

+
+
+
+

+ invite(_:​with:​timeout:​completion:​) +

+ 
public func invite(_ peer: Peer, with context: Data?, timeout: TimeInterval, completion: InvitationCompletionHandler?)
+
+

Manually invite a peer for communicating.

+ +
+
+

You can call this method to manually invite a peer for communicating if you set the +invitation parameter to .none in the transceiver's configuration.

+ + +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
peerPeer

The peer to be invited.

+
contextData?

Custom data to be sent alongside the invitation.

+
timeoutTime​Interval

How long to wait for the remote peer to accept the invitation.

+
completionInvitation​Completion​Handler?

Called when the invitation succeeds or fails.

+
+
+
+ + + +
+
+ +
+

+ Generated on using swift-doc. +

+
+ + diff --git a/Documentation/Peer.md b/Documentation/Peer.md deleted file mode 100755 index 163a06f..0000000 --- a/Documentation/Peer.md +++ /dev/null @@ -1,45 +0,0 @@ -# Peer - -Represents a remote peer. - -``` swift -public struct Peer: Hashable, Identifiable -``` - -## Inheritance - -`Hashable`, `Identifiable` - -## Properties - -### `id` - -The unique identifier for the peer. - -``` swift -let id: String -``` - -### `name` - -The peer's display name. - -``` swift -let name: String -``` - -### `discoveryInfo` - -Discovery info provided by the peer. - -``` swift -let discoveryInfo: [String: String]? -``` - -### `isConnected` - -`true` if we are currently connected to this peer. - -``` swift -var isConnected: Bool -``` diff --git a/Documentation/Peer/index.html b/Documentation/Peer/index.html new file mode 100755 index 0000000..e62befe --- /dev/null +++ b/Documentation/Peer/index.html @@ -0,0 +1,1331 @@ + + + + + + MultipeerKit - Peer + + + +
+ + + MultipeerKit + + Documentation + + Beta +
+ + + + + +
+
+

+ Structure + Peer +

+ +
public struct Peer: Hashable, Identifiable
+
+

Represents a remote peer.

+ +
+
+ +
+ + + + + + +%3 + + + +Peer + + +Peer + + + + + +Hashable + +Hashable + + + +Peer->Hashable + + + + + +Identifiable + +Identifiable + + + +Peer->Identifiable + + + + + + + + +
+

Conforms To

+
+
Hashable
+
Identifiable
+
+
+
+

Properties

+ +
+

+ id +

+ 
let id: String
+
+

The unique identifier for the peer.

+ +
+
+
+

+ name +

+ 
let name: String
+
+

The peer's display name.

+ +
+
+
+

+ discovery​Info +

+ 
let discoveryInfo: [String: String]?
+
+

Discovery info provided by the peer.

+ +
+
+
+

+ is​Connected +

+ 
var isConnected: Bool
+
+

true if we are currently connected to this peer.

+ +
+
+
+ + + +
+
+ +
+

+ Generated on using swift-doc. +

+
+ + diff --git a/Documentation/_Footer.md b/Documentation/_Footer.md deleted file mode 100755 index d868372..0000000 --- a/Documentation/_Footer.md +++ /dev/null @@ -1 +0,0 @@ -Generated at 2020-04-26T10:28:31-0300 using [swift-doc](https://github.com/SwiftDocOrg/swift-doc). diff --git a/Documentation/_Sidebar.md b/Documentation/_Sidebar.md deleted file mode 100755 index 1d14c96..0000000 --- a/Documentation/_Sidebar.md +++ /dev/null @@ -1,11 +0,0 @@ -
-Types - - - [MultipeerConfiguration](/MultipeerConfiguration) - - [MultipeerConfiguration.Invitation](/MultipeerConfiguration_Invitation) - - [MultipeerConfiguration.Security](/MultipeerConfiguration_Security) - - [MultipeerDataSource](/MultipeerDataSource) - - [MultipeerTransceiver](/MultipeerTransceiver) - - [Peer](/Peer) - -
diff --git a/Documentation/index.html b/Documentation/index.html new file mode 100755 index 0000000..95a3918 --- /dev/null +++ b/Documentation/index.html @@ -0,0 +1,1285 @@ + + + + + + MultipeerKit - MultipeerKit + + + +
+ + + MultipeerKit + + Documentation + + Beta +
+ + + + + +
+
+
+

Classes

+
+
+ + Multipeer​Data​Source + +
+
+ +
+
+ + Multipeer​Transceiver + +
+
+

Handles all aspects related to the multipeer communication.

+ +
+
+
+
+

Structures

+
+
+ + Peer + +
+
+

Represents a remote peer.

+ +
+
+ + Multipeer​Configuration + +
+
+

Configures several aspects of the multipeer communication.

+ +
+
+ + Multipeer​Configuration.​Security + +
+
+

Configures security-related aspects of the multipeer connection.

+ +
+
+
+
+

Enumerations

+
+
+ + Multipeer​Configuration.​Invitation + +
+
+

Defines how the multipeer connection handles newly discovered peers. +New peers can be invited automatically, invited with a custom context and timeout, +or not invited at all, in which case you must invite them manually.

+ +
+
+
+
+
+ + + + diff --git a/gendocs.sh b/gendocs.sh new file mode 100755 index 0000000..bc49638 --- /dev/null +++ b/gendocs.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +swift-doc generate Sources/MultipeerKit/Public\ API --module-name MultipeerKit --output Documentation --format=html \ No newline at end of file