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
ยกเลิกการเชื่อมต่อจากปลายทางระยะไกลด้วยรหัสที่ระบุ
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
ค้นหาปลายทางระยะไกลที่มีรหัสบริการที่ระบุ และเรียกใช้ Listener ซ้ำๆ เมื่อแอปพบปลายทางและสูญเสียปลายทาง
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 ระบุ 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

 NearbyConnections()

RejectConnectionRequest

void RejectConnectionRequest(
  const std::string & remote_endpoint_id
)

ปฏิเสธคำขอการเชื่อมต่อ

remote_endpoint_id ต้องตรงกับรหัสของปลายทางระยะไกลที่ขอการเชื่อมต่อ ConnectionRequestCallback ระบุรหัสดังกล่าวไว้

SendConnectionRequest

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 จะคงข้อความที่กำหนดเองไว้เพื่อส่งไปพร้อมกับคำขอการเชื่อมต่อได้ หรือแทนที่จะใช้เพย์โหลด แอปของคุณสามารถส่งผ่านเวกเตอร์ไบต์ว่างได้ ฟังก์ชันนี้จะเรียกโค้ดเรียกกลับที่ระบุในคำขอ หากดำเนินการสำเร็จ ระบบจะแสดงการตอบกลับ "ยอมรับการเชื่อมต่อ" หรือ "การเชื่อมต่อถูกปฏิเสธ" ไม่เช่นนั้นระบบจะแสดงข้อความว่าไม่สำเร็จ ในกรณีของการเชื่อมต่อที่ยอมรับ แอปจะส่งข้อความไปยังปลายทางระยะไกลได้ และแอปจะเรียก Listener ที่ระบุเมื่อได้รับข้อความหรือยกเลิกการเชื่อมต่อกับปลายทางระยะไกล

SendConnectionRequest

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 เท่านั้น

SendReliableMessage

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

ส่งข้อความที่เชื่อถือได้ไปยังปลายทางระยะไกลด้วยรหัสที่ระบุ

SendReliableMessage

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

ส่งข้อความที่เชื่อถือได้ไปยังปลายทางระยะไกลด้วยรหัสที่ระบุ

SendUnreliableMessage

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

ส่งข้อความที่ไม่น่าเชื่อถือไปยังปลายทางระยะไกลที่มีรหัสที่ระบุ

SendUnreliableMessage

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

ส่งข้อความที่ไม่น่าเชื่อถือไปยังปลายทางระยะไกลที่มีรหัสที่ระบุ

StartAdvertising

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 หรือระยะเวลาผ่านไป หากมีปลายทางที่โฆษณาอยู่ การโทรนี้จะไม่สำเร็จ

StartDiscovery

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

ค้นหาปลายทางระยะไกลที่มีรหัสบริการที่ระบุ และเรียกใช้ Listener ซ้ำๆ เมื่อแอปพบปลายทางและสูญเสียปลายทาง

ทำเช่นนี้ไปเรื่อยๆ จนกว่าแอปจะเรียกใช้ StopDiscovery ด้วยรหัสบริการที่ระบุ service_id ควรตรงกับมูลค่าที่แอปมอบให้เมื่อโฆษณาผ่าน StartAdvertising duration ระบุระยะเวลาสูงสุด (เป็นมิลลิวินาที) เพื่อให้การค้นหาทำงาน (อาจหยุดเร็วกว่านั้นหากแอปเรียกใช้ StopDiscovery()) หากค่า Duration เท่ากับ gpg::Duration::zero() การค้นพบจะดำเนินต่อไปเรื่อยๆ จนกว่าแอปจะเรียก StopDiscovery() หรือ Stop() หากมี Listener ที่ลงทะเบียนเพื่อค้นหาปลายทางสำหรับรหัสบริการที่ระบุอยู่แล้ว การโทรนี้จะไม่สำเร็จ

StartDiscovery

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

ค้นหาปลายทางระยะไกลที่มีรหัสบริการที่ระบุ

ฟังก์ชันนี้แตกต่างจาก StartDiscovery ตรงที่ใช้ EndpointDiscoveryListenerHelper แทน IEndpointDiscoveryListener เท่านั้น

หยุด

void Stop()

ยกเลิกการเชื่อมต่อจากปลายทางระยะไกลทั้งหมด หยุดการโฆษณาหรือการค้นพบที่เกิดขึ้น

ล้างสถานะภายใน

StopAdvertising

void StopAdvertising()

หยุดการโฆษณาปลายทางในเครื่อง

การทำเช่นนี้ไม่ทำให้การเชื่อมต่อที่มีอยู่ถูกตัดออก

StopDiscovery

void StopDiscovery(
  const std::string & service_id
)

หยุดการค้นหาปลายทางระยะไกลสำหรับรหัสบริการที่ระบุก่อนหน้านี้

~การเชื่อมต่อใกล้เคียง

 ~NearbyConnections()