gpg::NearbyConnections

#include <nearby_connections.h>

API utilisée pour créer des connexions et communiquer entre les applications d'un 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. empêche toute publicité ou découverte d'événements en cours.
StopAdvertising()
void
Arrête d'annoncer le point de terminaison local.
StopDiscovery(const std::string & service_id)
void
Arrête de trouver des points de terminaison distants pour un ID de service précédemment spécifié.

Classes
gpg::NearbyConnections::Builder

Builder utilisé 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 de celui-ci. Il peut le faire à l'aide de 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 la connexion. listener spécifie un écouteur à informer des é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 ne diffère que de AcceptConnectionRequest, car 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 afficher sur l'autre appareil pour 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 conserver un message personnalisé à envoyer avec la demande de connexion. Votre application peut également transmettre un vecteur d'octets vide au lieu d'une charge utile. Cette fonction invoque le rappel spécifié en réponse à la requête. Si l'opération réussit, le message "Connection Approved" (Connexion acceptée) s'affiche. ou "Connexion refusée" de réponse. Sinon, elle génère un message d'échec. Dans le cas d'une connexion acceptée, l'application peut envoyer des messages au point de terminaison distant, puis 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 seule différence avec SendConnectionRequest est qu'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 affiche aux utilisateurs pour identifier le point de terminaison. Si vous spécifiez une chaîne vide, le nom de l'appareil est utilisé. Si elle est spécifiée, app_identifiers indique comment installer ou lancer cette application sur différentes plates-formes. duration spécifie la durée (en millisecondes) pendant laquelle l'annonce sera diffusée, sauf si l'application appelle StopAdvertising() ou Stop() avant l'expiration du délai. 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é démarre 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 le délai soit écoulé. Si un point de terminaison est déjà annoncé, 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.

Continue à le faire jusqu'à ce que l'application appelle StopDiscovery avec l'ID de service spécifié. service_id doit correspondre à la valeur des applis lorsqu'elles diffusent des annonces via StartAdvertising. duration spécifie la durée maximale (en millisecondes) d'exécution de la détection (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 échoue.

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 dans la mesure où elle utilise EndpointDiscoveryListenerHelper au lieu de IEndpointDiscoveryListener.

Arrêter

void Stop()

Se déconnecte de tous les points de terminaison distants. empêche toute publicité ou découverte d'événements en cours.

Efface l'état interne.

StopAdvertising

void StopAdvertising()

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

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

StopDiscovery

void StopDiscovery(
  const std::string & service_id
)

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

~NearbyConnections

 ~NearbyConnections()