Reconnecting to disconnected peers

Question

I'm using the iOS 7 Multipeer framework in my app but I'm experiencing a problem with devices disconnecting. If I open the app in two devices: device A and device B the two devices connect to each other automatically. However, after several seconds device A disconnects from device B. i.e. At first the connection is like this:

A ---> B
A <--- B

After several seconds:

A ---> B
A      B

Device A maintains it's connection but device B get's a MCSessionStateNotConnected.

This means that A can send data to B but B can't reply. I tried to get around this by checking if the device is connected and if it's not, re-initiating the connection using:

[browser invitePeer:peerID toSession:_session withContext:Nil timeout:10];

But the didChangeState callback just get's called with MCSessionStateNotConnected.

Strangely if I send app A to the background, then re-open it, B reconnects to it and the connection is maintained.

The Multipeer API (and documentation) seems a bit sparse so I was assuming that it would just work. In this situation how should I re-connect the device?

Solution 1

I was having the same problem, and it seems to have been related to my app browsing and advertising at the same time, and two invitations being sent/accepted. When I stopped doing this and let one peer defer to the other for invitations the devices stayed connected.

In my browser delegate I'm checking the hash value of the discovered peer's displayName and only sending an invitation if my peer has a higher hash value:

Edit

As pointed out by @Masa the hash value of an NSString will be different on 32 and 64 bit devices, so it's safer to use the compare: method on displayName.

- (void)browser:(MCNearbyServiceBrowser *)browser foundPeer:(MCPeerID *)peerID withDiscoveryInfo:(NSDictionary *)info {

    NSLog(@"Browser found peer ID %@",peerID.displayName);       

    //displayName is created with [[NSUUID UUID] UUIDString]

    BOOL shouldInvite = ([_myPeerID.displayName compare:peerID.displayName]==NSOrderedDescending);

    if (shouldInvite){
        [browser invitePeer:peerID toSession:_session withContext:nil timeout:1.0]; 
    }
    else {
        NSLog(@"Not inviting");
    }
}

As you say, the documentation is sparse so who knows what Apple really wants us to do, but I've experimented with both sending and accepting invitations using a single session, and also creating a new session for each invitation accepted/sent, but this particular way of doing things has given me the most success.

Solution 2

For anyone interested, I created MCSessionP2P, a demo app that illustrates the ad-hoc networking features of MCSession. The app both advertises itself on the local network and programmatically connects to available peers, establishing a peer-to-peer network. Hat tip to @ChrisH for his technique of comparing hash values for inviting peers.

Solution 3

I liked ChrisH's solution, which reveals the key insight that only one peer should connect to the other peer, not both. Mutual connection attempts results in mutual disconnection (though not that a single-sided connection actually is, counter-intuitively, a mutual connection in terms of status and communication, so that works fine).

However, I think a better approach than one peer inviting is for both peers to invite but only one peer to accept. I use this method now and it works great, because both peers have an opportunity to pass rich information to the other via the context parameter of the invitation, as opposed to having to rely on scant information available in the foundPeer delegate method.

Therefore, I recommend a solution like so:

- (void)browser:(MCNearbyServiceBrowser *)browser foundPeer:(MCPeerID *)peerID withDiscoveryInfo:(NSDictionary *)info
{
    [self invitePeer:peerID];
}

- (void)advertiser:(MCNearbyServiceAdvertiser *)advertiser didReceiveInvitationFromPeer:(MCPeerID *)peerID withContext:(NSData *)context invitationHandler:(void (^)(BOOL accept, MCSession *session))invitationHandler
{
    NSDictionary *hugePackageOfInformation = [NSKeyedUnarchiver unarchiveObjectWithData:context];
    BOOL shouldAccept = ([hugePackageOfInformation.UUID.UUIDString compare:self.user.UUID.UUIDString] == NSOrderedDescending);

    invitationHandler(shouldAccept && ![self isPeerConnected:peerID], [self openSession]);
}

Solution 4

I have the same issue when devices trying to connect to each other at the same time and I don't know how to find a reason because we don't have any errors with MCSessionStateNotConnected.

We can use some crafty way to solve this issue: Put into txt records ( discovery info ) a time [[NSDate date] timeIntervalSince1970] when app started. Who started first - send invitation to others.

But I think it's not a right way ( if apps start at the same time, unlikely... :) ). We need to figure out the reason.

Solution 5

This is the result of a bug, which I've reported to Apple. I've explained how to fix it in my response to another question: Why does my MCSession peer disconnect randomly?

I have not flagged these questions for merging, because while the underlying bug and solution are the same, the two questions describe different problems.

View more solutions

Comments

[ChrisH]

This seems to be the missing piece of the puzzle, at least for me. Thanks!

[artud2000]

– invitePeer:toSession:withContext:timeout: yes

[James Andrews]

I tried that and it just sends a PeerNotConnected to the status delegate.

[artud2000]

What are you passing as a serviceType when looking for the device the first time?

[jjxtra]

Even with the certificate handler, I'm still getting disconnects

[Masa]

Very helpful, thanks. Note that hash on NSString returns an NSUInteger. The results are therefore different on 32 and 64 bit systems. So I just had the case that no one was sending invites. I solved it by simply doing a string compare on the displayNames instead of using hash. (Apart from that, note also that hash on NSString should be used with care: abakia.de/blog/2012/12/05/nsstring-hash-is-bad)

[ChrisH]

@Masa that's interesting, thanks. I'll definitely switch to using a string compare instead.

[SG1]

A better solution is to pass information in the invitation context parameter. Since both devices can invite each other fine, but only one can accept, you can do the discerning over who should accept in the received-invitation delegate method using this context, instead of who should invite in the found-peer delegate method.

[SG1]

A timer isn't necessary. Once you've connected, you will ever-after receive delegate methods when the state changes. If it becomes disconnected then try and reconnect after the timeout period for connection has expired, if the peer has not become connected in the interim. @Ben, this is the same solution to your problem.

[Carl Boisvert]

I would argue that @SG1's approach is less desirable since it wastes bandwidth.

[joon]

isn't there a risk that devices have the same display name? what if I have 2 iphones names 'Joon's iPhone' ?

[ChrisH]

@joon the onus there is on you to make sure you are creating unique peer IDs, which they should always be.

[joon]

what's the best practice for this? The demo's I've seen just use device name which is not unique afaik.

[ChrisH]

[[NSUUID UUID] UUIDString] will produce a different string regardless of the device name

[ChrisH]

Nice starting point for someone currently using MCBrowserViewController and MCAdvertiserAssistant

[Niels Castle]

Beware of comparing the displayNames, by default all iPads are named "Users' iPad". Lesser problem with iPhones since the same user tends to only have one. Still high risk of collision.

[radar]

Using hashes, as suggested on other threads (if myPeerId.hash > peerID.hash) may not be enough since the result may be different on two terminals (iPhone 7 in my case) running the same OS version (iOS 12.0.1). I have a situation where myPeerId.hash is lower than peerID.hash on both devices and then none send the invitation?