gpg::NearbyConnections

#include <nearby_connections.h>

Uma API usada para criar conexões e se comunicar entre apps na mesma rede local.

Resumo

Construtores e destruidores
NearbyConnections()
~NearbyConnections()

Funções públicas
AcceptConnectionRequest(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, IMessageListener *listener)
void
Aceita uma solicitação de conexão.
AcceptConnectionRequest(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, MessageListenerHelper helper)
void
Aceita uma solicitação de conexão.
Disconnect(const std::string & remote_endpoint_id)
void
Desconecta-se do endpoint remoto com o ID especificado.
RejectConnectionRequest(const std::string & remote_endpoint_id)
void
Rejeita uma solicitação de conexão.
SendConnectionRequest(const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, IMessageListener *listener)
void
Solicita que uma conexão seja estabelecida com um endpoint remoto.
SendConnectionRequest(const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, MessageListenerHelper helper)
void
Solicita uma conexão com um endpoint remoto.
SendReliableMessage(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)
void
Envia uma mensagem confiável para o endpoint remoto com o ID especificado.
SendReliableMessage(const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)
void
Envia uma mensagem confiável para os endpoints remotos com os IDs especificados.
SendUnreliableMessage(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)
void
Envia uma mensagem não confiável para o endpoint remoto com o ID especificado.
SendUnreliableMessage(const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)
void
Envia uma mensagem não confiável para os endpoints remotos com os IDs especificados.
StartAdvertising(const std::string & name, const std::vector< AppIdentifier > & app_identifiers, Duration duration, StartAdvertisingCallback start_advertising_callback, ConnectionRequestCallback request_callback)
void
Começa a anunciar um endpoint para um app local.
StartDiscovery(const std::string & service_id, Duration duration, IEndpointDiscoveryListener *listener)
void
Encontra endpoints remotos com o ID de serviço especificado e invoca o listener repetidamente conforme o app encontra e perde os endpoints.
StartDiscovery(const std::string & service_id, Duration duration, EndpointDiscoveryListenerHelper helper)
void
Encontra endpoints remotos com o ID de serviço especificado.
Stop()
void
Desconecta de todos os endpoints remotos. interrompe qualquer publicidade ou descoberta que estiver acontecendo.
StopAdvertising()
void
Interrompe a divulgação do endpoint local.
StopDiscovery(const std::string & service_id)
void
Interrompe a localização de endpoints remotos para um ID de serviço especificado anteriormente.

Classes
gpg::NearbyConnections::Builder

Classe Builder usada para construir objetos NearbyConnections.

Funções públicas

AcceptConnectionRequest

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

Aceita uma solicitação de conexão.

Em seguida, o app pode enviar e receber mensagens do endpoint especificado. Isso pode ser feito usando listener até que o app se desconecte do outro endpoint. remote_endpoint_id precisa corresponder ao ID do endpoint remoto que solicitou a conexão. ConnectionRequestCallback fornece esse ID. O payload pode conter uma mensagem para ser enviada com a resposta da conexão. listener especifica um listener para ser notificado sobre eventos para essa conexão.

AcceptConnectionRequest

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

Aceita uma solicitação de conexão.

Essa função só difere de AcceptConnectionRequest porque usa MessageListenerHelper, em vez de IMessageListener.

Desconectar

void Disconnect(
  const std::string & remote_endpoint_id
)

Desconecta-se do endpoint remoto com o ID especificado.

NearbyConnections

 NearbyConnections()

RejectConnectionRequest

void RejectConnectionRequest(
  const std::string & remote_endpoint_id
)

Rejeita uma solicitação de conexão.

remote_endpoint_id precisa corresponder ao ID do endpoint remoto que solicitou a conexão. ConnectionRequestCallback fornece esse ID.

SendConnectionRequest

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

Solicita que uma conexão seja estabelecida com um endpoint remoto.

name é um nome que o app pode mostrar aos usuários do outro dispositivo para identificar esse endpoint. Se você especificar uma string vazia, o nome do dispositivo será usado. remote_endpoint_id é o ID do endpoint remoto ao qual este app está enviando uma solicitação de conexão. O payload pode armazenar uma mensagem personalizada para enviar com a solicitação de conexão. Como alternativa, em vez de um payload, seu app pode passar um vetor de byte vazio. Esta função invoca o callback especificado em resposta à solicitação. Se a operação for bem-sucedida, ela produzirá um erro "Connection Accepted" ou "Conexão rejeitada" resposta. Caso contrário, ele gera uma mensagem de falha. No caso de uma conexão ser aceita, o aplicativo pode enviar mensagens para o endpoint remoto e invoca o listener especificado ao receber uma mensagem ou desconexão do endpoint remoto.

SendConnectionRequest

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

Solicita uma conexão com um endpoint remoto.

Difere de SendConnectionRequest apenas porque usa MessageListenerHelper em vez de IMessageListener.

SendReliableMessage

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

Envia uma mensagem confiável para o endpoint remoto com o ID especificado.

SendReliableMessage

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

Envia uma mensagem confiável para os endpoints remotos com os IDs especificados.

SendUnreliableMessage

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

Envia uma mensagem não confiável para o endpoint remoto com o ID especificado.

SendUnreliableMessage

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

Envia uma mensagem não confiável para os endpoints remotos com os IDs especificados.

StartAdvertising

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

Começa a anunciar um endpoint para um app local.

name pode ser um nome que o app mostra aos usuários para identificar o endpoint. Se você especificar uma string vazia, o nome do dispositivo será usado. Se especificado, app_identifiers determina como instalar ou iniciar esse app em diferentes plataformas. duration especifica a duração (em milissegundos) de execução do anúncio, a menos que o app invoque StopAdvertising() ou Stop() antes que a duração expire. Se o valor de duration for igual a gpg::Duration::zero(), a publicidade vai continuar indefinidamente até que o app chame StopAdvertising(). Essa função invoca start_advertising_callback quando a publicidade é iniciada ou falha. esse callback recebe as informações do endpoint em caso de sucesso ou um código de erro em caso de falha. Essa função invoca request_callback quando um endpoint remoto solicita uma conexão com o endpoint do app. A função continua anunciando a presença desse endpoint até que o app chame StopAdvertising ou até o final da duração. Se já houver um endpoint sendo anunciado, a chamada vai falhar.

StartDiscovery

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

Encontra endpoints remotos com o ID de serviço especificado e invoca o listener repetidamente conforme o app encontra e perde os endpoints.

Continua fazendo isso até que o app invoque StopDiscovery com o ID de serviço especificado. service_id precisa corresponder ao valor que os apps fornecem ao anunciar via StartAdvertising. duration especifica a duração máxima (em milissegundos) para a descoberta ser executada. Ela poderá ser interrompida antes se o app invocar StopDiscovery(). Se o valor de Duration for igual a gpg::Duration::zero(), a descoberta vai continuar indefinidamente até que o app chame StopDiscovery() ou Stop(). Se já houver um listener registrado para encontrar endpoints para o ID de serviço especificado, a chamada vai falhar.

StartDiscovery

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

Encontra endpoints remotos com o ID de serviço especificado.

Essa função difere de StartDiscovery apenas porque usa EndpointDiscoveryListenerHelper em vez de IEndpointDiscoveryListener.

Parar

void Stop()

Desconecta de todos os endpoints remotos. interrompe qualquer publicidade ou descoberta que estiver acontecendo.

Limpa o estado interno.

StopAdvertising

void StopAdvertising()

Interrompe a divulgação do endpoint local.

Isso NÃO vai causar a desativação das conexões atuais.

StopDiscovery

void StopDiscovery(
  const std::string & service_id
)

Interrompe a localização de endpoints remotos para um ID de serviço especificado anteriormente.

~NearbyConnections

 ~NearbyConnections()