nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::ConnectRequest

#include <src/lib/profiles/service-directory/ServiceDirectory.h>

คลาสนี้แสดงธุรกรรมรายการเดียวที่จัดการโดยผู้ดูแลบริการ

สรุป

แอตทริบิวต์สาธารณะ

mAppState
void *
mAuthMode
WeaveAuthMode
mConnIntf
InterfaceId
อินเทอร์เฟซสำหรับตั้งค่าการเชื่อมต่อ
mConnectTimeoutMsecs
uint32_t
ระยะหมดเวลาเพื่อให้การเรียกใช้ Connect เสร็จสมบูรณ์หรือส่งกลับข้อผิดพลาด
mConnection
การเชื่อมต่อที่จะนำไปเก็บที่นี่ขณะรอการดำเนินการให้เสร็จสิ้น
mConnectionCompleteHandler
ตัวชี้ไปยังฟังก์ชันที่จะถูกเรียกใช้เมื่อการเชื่อมต่อกับปลายทางบริการปลายทางเสร็จสมบูรณ์
mServiceEp
uint64_t
mStatusHandler
ตัวชี้ไปยังฟังก์ชันที่จะถูกเรียกใช้เมื่อได้รับรายงานสถานะ

ฟังก์ชันสาธารณะ

finalize(void)
void
วิธีนี้จะล้างสถานะภายใน รวมถึงการปิดการเชื่อมต่อ
free(void)
void
วิธีนี้จะปล่อยออบเจ็กต์คำขอการเชื่อมต่อโดยส่งกลับไปยังพูล
init(WeaveServiceManager *aManager, const uint64_t & aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnIntf)
เมธอดนี้จะเริ่มต้นอินสแตนซ์ ConnectRequest ด้วยอาร์กิวเมนต์ที่ส่งผ่าน
isAllocatedTo(const uint64_t & aServiceEp, void *aAppState)
bool
ฟังก์ชันนี้ทดสอบว่ามีการใช้คำขอเชื่อมต่อนี้เพื่อเชื่อมต่อกับปลายทางบริการที่เฉพาะเจาะจงสำหรับเอนทิตีแอปพลิเคชันของผู้เข้าร่วมหรือไม่
isFree(void)
bool
ฟังก์ชันนี้จะทดสอบว่าไม่มีการจัดสรรคำขอเชื่อมต่อในขณะนี้
onConnectionComplete(WEAVE_ERROR aError)
void
เมธอดนี้เป็นแทรมโพลีนไปยังเลเยอร์ของแอปพลิเคชันสำหรับเหตุการณ์การเชื่อมต่อที่สมบูรณ์

แอตทริบิวต์สาธารณะ

mAppState

void * mAppState

mAuthMode

WeaveAuthMode mAuthMode

mConnIntf

InterfaceId mConnIntf

อินเทอร์เฟซสำหรับตั้งค่าการเชื่อมต่อ

mConnectTimeoutMsecs

uint32_t mConnectTimeoutMsecs

ระยะหมดเวลาเพื่อให้การเรียกใช้ Connect เสร็จสมบูรณ์หรือส่งกลับข้อผิดพลาด

mConnection

WeaveConnection * mConnection

การเชื่อมต่อที่จะนำไปเก็บที่นี่ขณะรอการดำเนินการให้เสร็จสิ้น

mConnectionCompleteHandler

WeaveConnection::ConnectionCompleteFunct mConnectionCompleteHandler

ตัวชี้ไปยังฟังก์ชันที่จะถูกเรียกใช้เมื่อการเชื่อมต่อกับปลายทางบริการปลายทางเสร็จสมบูรณ์

mServiceEp

uint64_t mServiceEp

mStatusHandler

StatusHandler mStatusHandler

ตัวชี้ไปยังฟังก์ชันที่จะถูกเรียกใช้เมื่อได้รับรายงานสถานะ

ฟังก์ชันสาธารณะ

finalize

void finalize(
  void
)

วิธีนี้จะล้างสถานะภายใน รวมถึงการปิดการเชื่อมต่อ

ฟรี

void free(
  void
)

วิธีนี้จะปล่อยออบเจ็กต์คำขอการเชื่อมต่อโดยส่งกลับไปยังพูล

init

WEAVE_ERROR init(
  WeaveServiceManager *aManager,
  const uint64_t & aServiceEp,
  WeaveAuthMode aAuthMode,
  void *aAppState,
  StatusHandler aStatusHandler,
  WeaveConnection::ConnectionCompleteFunct aCompleteHandler,
  const uint32_t aConnectTimeoutMsecs,
  const InterfaceId aConnIntf
)

เมธอดนี้จะเริ่มต้นอินสแตนซ์ ConnectRequest ด้วยอาร์กิวเมนต์ที่ส่งผ่าน

รายละเอียด
พารามิเตอร์
[in] aManager
ตัวชี้ไปยังตัวจัดการบริการที่มีอยู่
[in] aServiceEp
รหัสของปลายทางบริการที่ต้องการสำหรับคำขอเชื่อมต่อนี้
[in] aAuthMode
คำอธิบายสำหรับวิธีการตรวจสอบสิทธิ์ที่ควรใช้สำหรับการเชื่อมต่อนี้
[in] aAppState
ตัวชี้ที่กำหนดเองซึ่งจะถูกส่งคืนในการเรียกกลับ
[in] aStatusHandler
ตัวชี้ไปยังฟังก์ชันเรียกกลับซึ่งจะจัดการรายงานสถานะเพื่อตอบสนองการค้นหาปลายทางบริการ
[in] aCompleteHandler
ตัวชี้ไปยังฟังก์ชันเรียกกลับที่จัดการเหตุการณ์การเชื่อมต่อเสร็จสมบูรณ์
[in] aConnectTimeoutMsecs
ระยะหมดเวลาเพื่อให้การเรียกใช้ Connect เสร็จสมบูรณ์หรือส่งกลับข้อผิดพลาด
[in] aConnectIntf
อินเทอร์เฟซที่จะสร้างการเชื่อมต่อ
การส่งคืน
WEAVE_NO_ERROR อาจเป็นโค้ดที่สำเร็จ หรือรหัสข้อผิดพลาดที่เกี่ยวข้อง

isAllocatedTo

bool isAllocatedTo(
  const uint64_t & aServiceEp,
  void *aAppState
)

ฟังก์ชันนี้ทดสอบว่ามีการใช้คำขอเชื่อมต่อนี้เพื่อเชื่อมต่อกับปลายทางบริการที่เฉพาะเจาะจงสำหรับเอนทิตีแอปพลิเคชันของผู้เข้าร่วมหรือไม่

รายละเอียด
พารามิเตอร์
[in] aServiceEp
รหัสปลายทางของบริการที่จะเปรียบเทียบกับสิ่งที่คงไว้ชั่วคราวคำขอเชื่อมต่อนี้
[in] aAppState
ตัวชี้ไปยังสถานะของแอปพลิเคชัน ซึ่งใช้เพื่อเปรียบเทียบกับสถานะของคำขอเชื่อมต่อนี้
การส่งคืน
true หากผ่านการทดสอบ มิเช่นนั้นให้เป็นเท็จ

isFree

bool isFree(
  void
)

ฟังก์ชันนี้จะทดสอบว่าไม่มีการจัดสรรคำขอเชื่อมต่อในขณะนี้

รายละเอียด
การส่งคืน
true หากผ่านการทดสอบ มิเช่นนั้นให้เป็นเท็จ

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

เมธอดนี้เป็นแทรมโพลีนไปยังเลเยอร์ของแอปพลิเคชันสำหรับเหตุการณ์การเชื่อมต่อที่สมบูรณ์

ซึ่งจะเรียกเครื่องจัดการการเชื่อมต่อที่สมบูรณ์ซึ่งกำหนดไว้ที่ lookupAndConnect()