Add a bit of documentation about broadcast discovery event

This commit is contained in:
Gioacchino Mazzurco 2019-04-16 17:10:46 +02:00
parent fcb2875312
commit cc973d1ea5
No known key found for this signature in database
GPG key ID: A1FBCA3872E87051

View file

@ -43,6 +43,7 @@ class RsBroadcastDiscovery;
*/ */
extern std::shared_ptr<RsBroadcastDiscovery> rsBroadcastDiscovery; extern std::shared_ptr<RsBroadcastDiscovery> rsBroadcastDiscovery;
struct RsBroadcastDiscoveryResult : RsSerializable struct RsBroadcastDiscoveryResult : RsSerializable
{ {
PGPFingerprintType mPgpFingerprint; PGPFingerprintType mPgpFingerprint;
@ -65,6 +66,11 @@ struct RsBroadcastDiscoveryResult : RsSerializable
~RsBroadcastDiscoveryResult() override; ~RsBroadcastDiscoveryResult() override;
}; };
/**
* @brief Event emitted when a non friend new peer is found in the local network
* @see RsEvents
*/
struct RsBroadcastDiscoveryPeerFoundEvent : RsEvent struct RsBroadcastDiscoveryPeerFoundEvent : RsEvent
{ {
RsBroadcastDiscoveryPeerFoundEvent( RsBroadcastDiscoveryPeerFoundEvent(
@ -84,6 +90,7 @@ struct RsBroadcastDiscoveryPeerFoundEvent : RsEvent
~RsBroadcastDiscoveryPeerFoundEvent() override; ~RsBroadcastDiscoveryPeerFoundEvent() override;
}; };
/** /**
* Announce own RetroShare instace and look friends and peers in own broadcast * Announce own RetroShare instace and look friends and peers in own broadcast
* domain (aka LAN). * domain (aka LAN).