PeerContact.Subscribe Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Subscribes the calling peer to the PeerContact, and as a result, the peer will receive any future PeerCollaboration events associated with the PeerContact.

Namespace:   System.Net.PeerToPeer.Collaboration
Assembly:  System.Net (in System.Net.dll)

public virtual void Subscribe()

Exception Condition
InvalidOperationException

The calling peer is not signed in to People Near Me.

ObjectDisposedException

The PeerContact object has been disposed.

PeerToPeerException

Unable to complete Subscribe operation. Failure may be due to an inability to establish a TCP connection to the peer.

PeerContact updates occur asynchronously after the Subscribe method has succeeded. As a result, it is possible for a PeerEndPoint to be added to the collection of a PeerContact before the associated Name is provided.

To monitor these changes, it is recommended that the user subscribe to the relevant events; for example, NameChanged.

Calling this method requires a PermissionState of Unrestricted. This state is created when the peer collaboration session begins.

.NET Framework
Available since 3.5
Return to top
Show: