gpg::NearbyConnections

#include <nearby_connections.h>

API utilisée pour créer des connexions et communiquer entre les applications sur le même réseau local.

Résumé

Constructeurs et destructeurs
NearbyConnections()
~NearbyConnections()

Fonctions publiques
AcceptConnectionRequest(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, IMessageListener *listener)	void Accepte une demande de connexion.
AcceptConnectionRequest(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, MessageListenerHelper helper)	void Accepte une demande de connexion.
Disconnect(const std::string & remote_endpoint_id)	void Se déconnecte du point de terminaison distant avec l'ID spécifié.
RejectConnectionRequest(const std::string & remote_endpoint_id)	void Refuse une demande de connexion.
SendConnectionRequest(const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, IMessageListener *listener)	void Demande l'établissement d'une connexion avec un point de terminaison distant.
SendConnectionRequest(const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, MessageListenerHelper helper)	void Demande une connexion à un point de terminaison distant.
SendReliableMessage(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)	void Envoie un message fiable au point de terminaison distant avec l'ID spécifié.
SendReliableMessage(const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)	void Envoie un message fiable aux points de terminaison distants avec les ID spécifiés.
SendUnreliableMessage(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)	void Envoie un message non fiable au point de terminaison distant avec l'ID spécifié.
SendUnreliableMessage(const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)	void Envoie un message non fiable aux points de terminaison distants avec les ID spécifiés.
StartAdvertising(const std::string & name, const std::vector< AppIdentifier > & app_identifiers, Duration duration, StartAdvertisingCallback start_advertising_callback, ConnectionRequestCallback request_callback)	void Commence à promouvoir un point de terminaison pour une application locale.
StartDiscovery(const std::string & service_id, Duration duration, IEndpointDiscoveryListener *listener)	void Recherche les points de terminaison distants avec l'ID de service spécifié et appelle l'écouteur à plusieurs reprises lorsque l'application trouve et perd des points de terminaison.
StartDiscovery(const std::string & service_id, Duration duration, EndpointDiscoveryListenerHelper helper)	void Recherche les points de terminaison distants avec l'ID de service spécifié.
Stop()	void Se déconnecte de tous les points de terminaison distants et arrête toute publicité ou découverte en cours.
StopAdvertising()	void Arrête d'afficher le point de terminaison local.
StopDiscovery(const std::string & service_id)	void Arrête de rechercher des points de terminaison distants pour un ID de service spécifié précédemment.

Classes
gpg::NearbyConnections::Builder	Builder utilisée pour construire des objets NearbyConnections

Fonctions publiques

AcceptConnectionRequest

void AcceptConnectionRequest(
  const std::string & remote_endpoint_id,
  const std::vector< uint8_t > & payload,
  IMessageListener *listener
)

Accepte une demande de connexion.

L'application peut ensuite envoyer des messages au point de terminaison spécifié et en recevoir. Pour ce faire, il peut utiliser listener jusqu'à ce que l'application se déconnecte de l'autre point de terminaison. remote_endpoint_id doit correspondre à l'ID du point de terminaison distant qui a demandé la connexion. ConnectionRequestCallback fournit cet ID. payload peut conserver un message à envoyer avec la réponse de connexion. listener spécifie un écouteur à notifier pour les événements de cette connexion.

AcceptConnectionRequest

void AcceptConnectionRequest(
  const std::string & remote_endpoint_id,
  const std::vector< uint8_t > & payload,
  MessageListenerHelper helper
)

Accepte une demande de connexion.

Cette fonction diffère uniquement de AcceptConnectionRequest dans la mesure où elle utilise MessageListenerHelper au lieu de IMessageListener.

Déconnecter

void Disconnect(
  const std::string & remote_endpoint_id
)

Se déconnecte du point de terminaison distant avec l'ID spécifié.

NearbyConnections

 NearbyConnections()

RejectConnectionRequest

void RejectConnectionRequest(
  const std::string & remote_endpoint_id
)

Refuse une demande de connexion.

remote_endpoint_id doit correspondre à l'ID du point de terminaison distant qui a demandé la connexion. ConnectionRequestCallback fournit cet ID.

SendConnectionRequest

void SendConnectionRequest(
  const std::string & name,
  const std::string & remote_endpoint_id,
  const std::vector< uint8_t > & payload,
  ConnectionResponseCallback callback,
  IMessageListener *listener
)

Demande l'établissement d'une connexion avec un point de terminaison distant.

name est un nom que l'application peut présenter aux utilisateurs de l'autre appareil afin d'identifier ce point de terminaison. Si vous spécifiez une chaîne vide, le nom de l'appareil est utilisé. remote_endpoint_id est l'ID du point de terminaison distant auquel cette application envoie une requête de connexion. payload peut mettre en attente un message personnalisé à envoyer avec la demande de connexion. Au lieu d'une charge utile, votre application peut également transmettre un vecteur d'octets vide. Cette fonction appelle le rappel spécifié en réponse à la requête. Si l'opération réussit, une réponse de type "Connexion acceptée" ou "Connexion refusée" s'affiche. Sinon, un message d'échec s'affiche. Dans le cas d'une connexion acceptée, l'application peut envoyer des messages au point de terminaison distant. Elle appelle l'écouteur spécifié à la réception d'un message ou d'une déconnexion du point de terminaison distant.

SendConnectionRequest

void SendConnectionRequest(
  const std::string & name,
  const std::string & remote_endpoint_id,
  const std::vector< uint8_t > & payload,
  ConnectionResponseCallback callback,
  MessageListenerHelper helper
)

Demande une connexion à un point de terminaison distant.

La différence avec SendConnectionRequest n'est que dans la mesure où elle utilise MessageListenerHelper au lieu de IMessageListener.

SendReliableMessage

void SendReliableMessage(
  const std::string & remote_endpoint_id,
  const std::vector< uint8_t > & payload
)

Envoie un message fiable au point de terminaison distant avec l'ID spécifié.

SendReliableMessage

void SendReliableMessage(
  const std::vector< std::string > & remote_endpoint_ids,
  const std::vector< uint8_t > & payload
)

Envoie un message fiable aux points de terminaison distants avec les ID spécifiés.

SendUnreliableMessage

void SendUnreliableMessage(
  const std::string & remote_endpoint_id,
  const std::vector< uint8_t > & payload
)

Envoie un message non fiable au point de terminaison distant avec l'ID spécifié.

SendUnreliableMessage

void SendUnreliableMessage(
  const std::vector< std::string > & remote_endpoint_ids,
  const std::vector< uint8_t > & payload
)

Envoie un message non fiable aux points de terminaison distants avec les ID spécifiés.

StartAdvertising

void StartAdvertising(
  const std::string & name,
  const std::vector< AppIdentifier > & app_identifiers,
  Duration duration,
  StartAdvertisingCallback start_advertising_callback,
  ConnectionRequestCallback request_callback
)

Commence à promouvoir un point de terminaison pour une application locale.

name peut être un nom que l'application présente aux utilisateurs pour identifier le point de terminaison. Si vous spécifiez une chaîne vide, le nom de l'appareil est utilisé. S'il est spécifié, app_identifiers indique comment installer ou lancer cette appli sur différentes plates-formes. duration spécifie la durée (en millisecondes) de diffusion de la publicité, sauf si l'application appelle StopAdvertising() ou Stop() avant la fin de cette durée. Si la valeur de duration est égale à gpg::Duration::zero(), la publicité continue indéfiniment jusqu'à ce que l'application appelle StopAdvertising(). Cette fonction appelle start_advertising_callback lorsque la publicité commence ou échoue. Ce rappel reçoit les informations sur le point de terminaison en cas de réussite ou un code d'erreur en cas d'échec. Cette fonction appelle request_callback lorsqu'un point de terminaison distant demande une connexion avec le point de terminaison de l'application. Cette fonction continue d'annoncer la présence de ce point de terminaison jusqu'à ce que l'application appelle StopAdvertising ou que la durée soit écoulée. Si un point de terminaison est déjà en cours d'annonce, cet appel échoue.

StartDiscovery

void StartDiscovery(
  const std::string & service_id,
  Duration duration,
  IEndpointDiscoveryListener *listener
)

Recherche les points de terminaison distants avec l'ID de service spécifié et appelle l'écouteur à plusieurs reprises lorsque l'application trouve et perd des points de terminaison.

Se poursuit jusqu'à ce que l'application appelle StopDiscovery avec l'ID de service spécifié. La valeur de service_id doit correspondre à la valeur apportée par les applications lorsqu'elles diffusent des annonces via StartAdvertising. duration spécifie la durée maximale (en millisecondes) d'exécution de la découverte (elle peut s'arrêter plus tôt si l'application appelle StopDiscovery()). Si la valeur de Duration est égale à gpg::Duration::zero(), la découverte se poursuit indéfiniment jusqu'à ce que l'application appelle StopDiscovery() ou Stop(). Si un écouteur est déjà enregistré pour rechercher des points de terminaison pour l'ID de service spécifié, cet appel échouera.

StartDiscovery

void StartDiscovery(
  const std::string & service_id,
  Duration duration,
  EndpointDiscoveryListenerHelper helper
)

Recherche les points de terminaison distants avec l'ID de service spécifié.

Cette fonction diffère de StartDiscovery uniquement en ce sens qu'elle utilise EndpointDiscoveryListenerHelper au lieu de IEndpointDiscoveryListener.

Arrêter

void Stop()

Se déconnecte de tous les points de terminaison distants et arrête toute publicité ou découverte en cours.

Efface l'état interne.

StopAdvertising

void StopAdvertising()

Arrête d'afficher le point de terminaison local.

Cela n'entraîne PAS la suppression des connexions existantes.

StopDiscovery

void StopDiscovery(
  const std::string & service_id
)

Arrête de rechercher des points de terminaison distants pour un ID de service spécifié précédemment.

~NearbyConnections

 ~NearbyConnections()