gpg::NearbyConnections

#include <nearby_connections.h>

用于在同一本地网络上的应用之间创建连接和通信的 API。

摘要

构造函数和析构函数
NearbyConnections()
~NearbyConnections()

公共函数
AcceptConnectionRequest(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, IMessageListener *listener)
void
接受连接请求。
AcceptConnectionRequest(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, MessageListenerHelper helper)
void
接受连接请求。
Disconnect(const std::string & remote_endpoint_id)
void
断开与指定 ID 的远程端点的连接。
RejectConnectionRequest(const std::string & remote_endpoint_id)
void
拒绝连接请求。
SendConnectionRequest(const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, IMessageListener *listener)
void
请求与远程端点建立连接。
SendConnectionRequest(const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, MessageListenerHelper helper)
void
请求连接到远程端点。
SendReliableMessage(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)
void
向指定 ID 的远程端点发送可靠消息。
SendReliableMessage(const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)
void
向指定 ID 的多个远程端点发送可靠消息。
SendUnreliableMessage(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)
void
向指定 ID 的远程端点发送不可靠消息。
SendUnreliableMessage(const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)
void
向指定 ID 的多个远程端点发送不可靠消息。
StartAdvertising(const std::string & name, const std::vector< AppIdentifier > & app_identifiers, Duration duration, StartAdvertisingCallback start_advertising_callback, ConnectionRequestCallback request_callback)
void
开始为本地应用宣传端点。
StartDiscovery(const std::string & service_id, Duration duration, IEndpointDiscoveryListener *listener)
void
查找具有指定服务 ID 的远程端点，并在应用查找和丢失端点时重复调用侦听器。
StartDiscovery(const std::string & service_id, Duration duration, EndpointDiscoveryListenerHelper helper)
void
查找具有指定服务 ID 的远程端点。
停止()
void
断开与所有远程端点的连接；停止正在进行的任何宣传或发现。
停止宣传()
void
停止宣传本地端点。
StopDiscovery(const std::string & service_id)
void
停止查找之前指定服务 ID 的远程端点。

类
gpg::NearbyConnections::Builder

Builder 类用于构建 NearbyConnections 对象。

公共函数

接受连接请求

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

接受连接请求。

随后，应用可以向指定端点发送消息，并从该端点接收消息。它可以使用 listener 执行此操作，直到应用断开与其他端点的连接。remote_endpoint_id 必须与请求连接的远程端点的 ID 匹配。ConnectionRequestCallback 提供该 ID。payload 可以保存要与连接响应一起发送的消息。listener 指定一个侦听器，以通知此连接的事件。

接受连接请求

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

接受连接请求。

此函数与 AcceptConnectionRequest 的唯一区别在于它使用 MessageListenerHelper 而不是 IMessageListener。

断开连接

void Disconnect(
  const std::string & remote_endpoint_id
)

断开与指定 ID 的远程端点的连接。

NearbyConnections

 NearbyConnections()

拒绝连接请求

void RejectConnectionRequest(
  const std::string & remote_endpoint_id
)

拒绝连接请求。

remote_endpoint_id 必须与请求连接的远程端点的 ID 匹配。ConnectionRequestCallback 提供该 ID。

发送连接请求

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

请求与远程端点建立连接。

name 是应用可以在其他设备上显示给用户以识别此端点的名称。如果指定空字符串，则使用设备名称。remote_endpoint_id 是此应用正在发送连接请求的远程端点的 ID。payload 可以保存要与连接请求一起发送的自定义消息。或者，您的应用可以传递一个空的字节向量，而不是有效负载。此函数在响应请求时调用指定的回调。如果操作成功，则会生成“连接已接受”或“连接已拒绝”响应。否则，它会生成错误消息。在连接已接受的情况下，应用可以向远程端点发送消息，并且应用在收到消息或与远程端点断开连接时调用指定的侦听器。

发送连接请求

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

请求连接到远程端点。

与 SendConnectionRequest 的唯一区别在于它使用 MessageListenerHelper 而不是 IMessageListener。

发送可靠消息

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

向指定 ID 的远程端点发送可靠消息。

发送可靠消息

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

向指定 ID 的多个远程端点发送可靠消息。

发送不可靠消息

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

向指定 ID 的远程端点发送不可靠消息。

发送不可靠消息

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

向指定 ID 的多个远程端点发送不可靠消息。

开始宣传

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

开始为本地应用宣传端点。

name 可以是应用显示给用户以识别端点的名称。如果指定空字符串，则使用设备名称。如果指定，app_identifiers 指定如何在不同平台上安装或启动此应用。duration 指定广告将运行的持续时间（以毫秒为单位），除非应用在持续时间到期之前调用 StopAdvertising() 或 Stop()。如果 duration 的值为 gpg::Duration::zero()，则广告将无限期地继续，直到应用调用 StopAdvertising()。此函数在广告开始或失败时调用 start_advertising_callback；此回调在成功时接收端点信息，在失败时接收错误代码。此函数在远程端点请求与应用端点连接时调用 request_callback。此函数将继续宣传此端点的存在，直到应用调用 StopAdvertising 或持续时间到期。如果已经有正在宣传的端点，则此调用将失败。

开始发现

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

查找具有指定服务 ID 的远程端点，并在应用查找和丢失端点时重复调用侦听器。

继续这样做，直到应用使用指定的服务 ID 调用 StopDiscovery。service_id 应与应用通过 StartAdvertising 进行宣传时提供的 value 匹配。duration 指定发现运行的最大持续时间（以毫秒为单位）（如果应用调用 StopDiscovery()，则可能会提前停止）。如果 Duration 的值为 gpg::Duration::zero()，则发现将无限期地继续，直到应用调用 StopDiscovery() 或 Stop()。如果已经为查找指定服务 ID 的端点注册了侦听器，则此调用将失败。

开始发现

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

查找具有指定服务 ID 的远程端点。

此函数与 StartDiscovery 的唯一区别在于它使用 EndpointDiscoveryListenerHelper 而不是 IEndpointDiscoveryListener。

停止

void Stop()

断开与所有远程端点的连接；停止正在进行的任何宣传或发现。

清除内部状态。

停止宣传

void StopAdvertising()

停止宣传本地端点。

这样做不会导致现有连接断开。

停止发现

void StopDiscovery(
  const std::string & service_id
)

停止查找之前指定服务 ID 的远程端点。

~NearbyConnections

 ~NearbyConnections()