гпг:: РядомСоединения

#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
Отключается от удаленной конечной точки с указанным идентификатором.
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
Отправляет надежное сообщение на удаленную конечную точку с указанным идентификатором.
SendReliableMessage (const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)
void
Отправляет надежное сообщение на удаленные конечные точки с указанными идентификаторами.
SendUnreliableMessage (const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)
void
Отправляет ненадежное сообщение на удаленную конечную точку с указанным идентификатором.
SendUnreliableMessage (const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)
void
Отправляет ненадежное сообщение на удаленные конечные точки с указанными идентификаторами.
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
Находит удаленные конечные точки с указанным идентификатором службы и повторно вызывает прослушиватель по мере того, как приложение находит и теряет конечные точки.
StartDiscovery (const std::string & service_id, Duration duration, EndpointDiscoveryListenerHelper helper)
void
Находит удаленные конечные точки с указанным идентификатором службы.
Stop ()
void
Отключается от всех удаленных конечных точек; останавливает любую рекламу или открытия, которые происходят.
StopAdvertising ()
void
Останавливает рекламу локальной конечной точки.
StopDiscovery (const std::string & service_id)
void
Останавливает поиск удаленных конечных точек для ранее указанного идентификатора службы.

Классы

gpg:: NearbyConnections:: Builder

Класс Builder , используемый для создания объектов NearbyConnections .

Общественные функции

AcceptConnectionRequest 

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

Принимает запрос на соединение.

Впоследствии приложение может отправлять сообщения и получать их от указанной конечной точки. Он может делать это с помощью listener до тех пор, пока приложение не отключится от другой конечной точки. remote_endpoint_id должен совпадать с идентификатором удаленной конечной точки, запросившей соединение. ConnectionRequestCallback предоставляет этот идентификатор. payload может содержать сообщение для отправки вместе с ответом на соединение. listener указывает прослушиватель, который будет уведомлен о событиях для этого соединения.

AcceptConnectionRequest 

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
)

Отключается от удаленной конечной точки с указанным идентификатором.

РядомСоединения 

 NearbyConnections()

Отклонить запрос соединения 

void RejectConnectionRequest(
  const std::string & remote_endpoint_id
)

Отклоняет запрос на соединение.

remote_endpoint_id должен совпадать с идентификатором удаленной конечной точки, запросившей соединение. ConnectionRequestCallback предоставляет этот идентификатор.

Отправить запрос соединения 

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 — это идентификатор удаленной конечной точки, к которой это приложение отправляет запрос на подключение. 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 .

ОтправитьReliableMessage 

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

Отправляет надежное сообщение на удаленную конечную точку с указанным идентификатором.

ОтправитьReliableMessage 

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

Отправляет надежное сообщение на удаленные конечные точки с указанными идентификаторами.

ОтправитьUnreliableMessage 

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

Отправляет ненадежное сообщение на удаленную конечную точку с указанным идентификатором.

ОтправитьUnreliableMessage 

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

Отправляет ненадежное сообщение на удаленные конечные точки с указанными идентификаторами.

НачатьРекламу 

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
)

Находит удаленные конечные точки с указанным идентификатором службы и повторно вызывает прослушиватель по мере того, как приложение находит и теряет конечные точки.

Продолжает делать это до тех пор, пока приложение не вызовет StopDiscovery с указанным идентификатором службы. service_id должен соответствовать значению, которое приложения предоставляют при рекламе через StartAdvertising . duration определяет максимальную продолжительность (в миллисекундах) запуска обнаружения (оно может прекратиться раньше, если приложение вызывает StopDiscovery() ). Если значение Duration равно gpg::Duration::zero() , обнаружение продолжается бесконечно, пока приложение не вызовет StopDiscovery() или Stop() . Если уже зарегистрирован прослушиватель для поиска конечных точек для указанного идентификатора службы, этот вызов завершится неудачей.

НачатьОбнаружение 

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

Находит удаленные конечные точки с указанным идентификатором службы.

Эта функция отличается от StartDiscovery только тем, что она использует EndpointDiscoveryListenerHelper вместо IEndpointDiscoveryListener .

Останавливаться 

void Stop()

Отключается от всех удаленных конечных точек; останавливает любую рекламу или открытия, которые происходят.

Проясняет внутреннее состояние.

СтопРеклама 

void StopAdvertising()

Останавливает рекламу локальной конечной точки.

Это НЕ приведет к разрыву существующих соединений.

СтопДискавери 

void StopDiscovery(
  const std::string & service_id
)

Останавливает поиск удаленных конечных точек для ранее указанного идентификатора службы.

~NearbyConnections 

 ~NearbyConnections()