gpg::NearbyConnections

#include <nearby_connections.h>

API yang digunakan untuk membuat koneksi dan berkomunikasi antar-aplikasi di jaringan lokal yang sama.

Ringkasan

Konstruktor dan Destruktor
NearbyConnections()
~NearbyConnections()

Fungsi publik
AcceptConnectionRequest(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, IMessageListener *listener)
void
Menerima permintaan koneksi.
AcceptConnectionRequest(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, MessageListenerHelper helper)
void
Menerima permintaan koneksi.
Disconnect(const std::string & remote_endpoint_id)
void
Terputus dari endpoint jarak jauh dengan ID yang ditentukan.
RejectConnectionRequest(const std::string & remote_endpoint_id)
void
Menolak permintaan koneksi.
SendConnectionRequest(const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, IMessageListener *listener)
void
Meminta koneksi dibuat dengan endpoint jarak jauh.
SendConnectionRequest(const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, MessageListenerHelper helper)
void
Meminta koneksi ke endpoint jarak jauh.
SendReliableMessage(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)
void
Mengirim pesan yang andal ke endpoint jarak jauh dengan ID yang ditentukan.
SendReliableMessage(const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)
void
Mengirim pesan yang andal ke endpoint jarak jauh dengan ID yang ditentukan.
SendUnreliableMessage(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)
void
Mengirim pesan yang tidak dapat diandalkan ke endpoint jarak jauh dengan ID yang ditentukan.
SendUnreliableMessage(const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)
void
Mengirim pesan yang tidak dapat diandalkan ke endpoint jarak jauh dengan ID yang ditentukan.
StartAdvertising(const std::string & name, const std::vector< AppIdentifier > & app_identifiers, Duration duration, StartAdvertisingCallback start_advertising_callback, ConnectionRequestCallback request_callback)
void
Mulai mengiklankan endpoint untuk aplikasi lokal.
StartDiscovery(const std::string & service_id, Duration duration, IEndpointDiscoveryListener *listener)
void
Menemukan endpoint jarak jauh dengan ID layanan yang ditentukan, dan memanggil pemroses berulang kali saat aplikasi menemukan dan kehilangan endpoint.
StartDiscovery(const std::string & service_id, Duration duration, EndpointDiscoveryListenerHelper helper)
void
Menemukan endpoint jarak jauh dengan ID layanan yang ditentukan.
Stop()
void
Terputus dari semua endpoint jarak jauh; menghentikan iklan atau penemuan apa pun yang terjadi.
StopAdvertising()
void
Berhenti mengiklankan endpoint lokal.
StopDiscovery(const std::string & service_id)
void
Berhenti menemukan endpoint jarak jauh untuk ID layanan yang ditentukan sebelumnya.

Class
gpg::NearbyConnections::Builder

Class Builder yang digunakan untuk membuat objek NearbyConnections.

Fungsi publik

AcceptConnectionRequest

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

Menerima permintaan koneksi.

Selanjutnya, aplikasi dapat mengirim pesan ke, dan menerimanya dari, endpoint yang ditentukan. Aplikasi dapat melakukannya menggunakan listener, hingga koneksi aplikasi terputus dari endpoint lainnya. remote_endpoint_id harus cocok dengan ID endpoint jarak jauh yang meminta koneksi. ConnectionRequestCallback memberikan ID tersebut. payload dapat menyimpan pesan untuk dikirim bersama dengan respons koneksi. listener menentukan pemroses yang akan diberi tahu peristiwa untuk koneksi ini.

AcceptConnectionRequest

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

Menerima permintaan koneksi.

Fungsi ini hanya berbeda dari AcceptConnectionRequest karena menggunakan MessageListenerHelper, bukan IMessageListener.

Putuskan koneksi

void Disconnect(
  const std::string & remote_endpoint_id
)

Terputus dari endpoint jarak jauh dengan ID yang ditentukan.

NearbyConnections

 NearbyConnections()

RejectConnectionRequest

void RejectConnectionRequest(
  const std::string & remote_endpoint_id
)

Menolak permintaan koneksi.

remote_endpoint_id harus cocok dengan ID endpoint jarak jauh yang meminta koneksi. ConnectionRequestCallback memberikan ID tersebut.

SendConnectionRequest

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

Meminta koneksi dibuat dengan endpoint jarak jauh.

name adalah nama yang dapat ditampilkan aplikasi kepada pengguna di perangkat lain untuk mengidentifikasi endpoint ini. Jika Anda menentukan string kosong, nama perangkat akan digunakan. remote_endpoint_id adalah ID endpoint jarak jauh yang dikirimi permintaan untuk terhubung oleh aplikasi ini. payload dapat menyimpan pesan kustom untuk dikirim bersama dengan permintaan koneksi. Atau, sebagai ganti payload, aplikasi Anda bisa meneruskan vektor byte kosong. Fungsi ini memanggil callback yang ditentukan sebagai respons terhadap permintaan. Jika operasi berhasil, tindakan ini akan menghasilkan pesan "Koneksi Diterima" atau "Koneksi Ditolak" yang dihasilkan. Jika tidak, pesan kegagalan akan muncul. Dalam kasus koneksi yang diterima, aplikasi dapat mengirim pesan ke endpoint jarak jauh, dan aplikasi memanggil pemroses yang ditentukan saat menerima pesan atau pemutusan koneksi dari endpoint jarak jauh.

SendConnectionRequest

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

Meminta koneksi ke endpoint jarak jauh.

Berbeda dari SendConnectionRequest hanya karena menggunakan MessageListenerHelper, bukan IMessageListener.

SendReliableMessage

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

Mengirim pesan yang andal ke endpoint jarak jauh dengan ID yang ditentukan.

SendReliableMessage

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

Mengirim pesan yang andal ke endpoint jarak jauh dengan ID yang ditentukan.

SendUnreliableMessage

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

Mengirim pesan yang tidak dapat diandalkan ke endpoint jarak jauh dengan ID yang ditentukan.

SendUnreliableMessage

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

Mengirim pesan yang tidak dapat diandalkan ke endpoint jarak jauh dengan ID yang ditentukan.

StartAdvertising

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

Mulai mengiklankan endpoint untuk aplikasi lokal.

name dapat menjadi nama yang ditampilkan aplikasi kepada pengguna untuk mengidentifikasi endpoint. Jika Anda menentukan string kosong, nama perangkat akan digunakan. Jika ditentukan, app_identifiers menentukan cara menginstal atau meluncurkan aplikasi ini di platform berbeda. duration menentukan durasi (dalam milidetik) saat iklan akan berjalan, kecuali jika aplikasi memanggil StopAdvertising() atau Stop() sebelum durasi berakhir. Jika nilai duration sama dengan gpg::Duration::zero(), iklan akan terus berlanjut tanpa batas waktu hingga aplikasi memanggil StopAdvertising(). Fungsi ini memanggil start_advertising_callback saat iklan dimulai atau gagal; callback ini menerima info endpoint tentang keberhasilan atau kode error jika gagal. Fungsi ini memanggil request_callback saat endpoint jarak jauh meminta koneksi dengan endpoint aplikasi. Fungsi ini terus mengiklankan keberadaan endpoint ini hingga aplikasi memanggil StopAdvertising, atau durasi berlalu. Jika sudah ada endpoint yang diiklankan, panggilan ini akan gagal.

StartDiscovery

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

Menemukan endpoint jarak jauh dengan ID layanan yang ditentukan, dan memanggil pemroses berulang kali saat aplikasi menemukan dan kehilangan endpoint.

Terus lakukan hal ini hingga aplikasi memanggil StopDiscovery dengan ID layanan yang ditentukan. service_id harus cocok dengan nilai yang diberikan aplikasi saat beriklan melalui StartAdvertising. duration menentukan durasi maksimum (dalam milidetik) agar penemuan dapat dijalankan (mungkin berhenti lebih cepat jika aplikasi memanggil StopDiscovery()). Jika nilai Duration sama dengan gpg::Duration::zero(), penemuan berlanjut tanpa batas waktu hingga aplikasi memanggil StopDiscovery() atau Stop(). Jika sudah ada pemroses yang terdaftar untuk menemukan endpoint bagi ID layanan yang ditentukan, panggilan ini akan gagal.

StartDiscovery

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

Menemukan endpoint jarak jauh dengan ID layanan yang ditentukan.

Fungsi ini berbeda dari StartDiscovery hanya karena menggunakan EndpointDiscoveryListenerHelper, bukan IEndpointDiscoveryListener.

Hentikan

void Stop()

Terputus dari semua endpoint jarak jauh; menghentikan iklan atau penemuan apa pun yang terjadi.

Menghapus status internal.

StopAdvertising

void StopAdvertising()

Berhenti mengiklankan endpoint lokal.

Melakukan hal ini TIDAK menyebabkan koneksi yang ada terputus.

StopDiscovery

void StopDiscovery(
  const std::string & service_id
)

Berhenti menemukan endpoint jarak jauh untuk ID layanan yang ditentukan sebelumnya.

~NearbyConnections

 ~NearbyConnections()