nl::Weave::Binding

บันทึกเป้าหมายที่ต้องการของการสื่อสารของ Weave และข้อมูลการกำหนดค่าที่เกี่ยวข้อง

สรุป

ออบเจ็กต์ การเชื่อมโยง จะระบุเป้าหมายที่มุ่งหวังของการสื่อสารของ Weave (หรือที่เรียกว่า "เพียร์") พร้อมกับชุดพารามิเตอร์การกำหนดค่าที่อธิบายวิธีการสื่อสารกับเพียร์ การเชื่อมโยงจะไม่ขึ้นอยู่กับโปรโตคอลของแอปพลิเคชันที่ทั้ง 2 ฝ่ายพูด ดังนั้น พวกเขาจะจับข้อมูล "ใคร" และ "วิธีการ" ของการสื่อสาร แต่ไม่บอกถึง "อะไร"

การกำหนดค่า

แอปพลิเคชันต้องกำหนดค่าการเชื่อมโยงด้วยพารามิเตอร์ที่เจาะจงกับประเภทช่องทางการสื่อสารที่ต้องการ การเชื่อมโยงรองรับการรับส่งข้อมูลเครือข่ายที่หลากหลาย ทั้ง TCP, UDP, UDP ที่มาพร้อม Weave Reliable Messaging และ Weave over BLE (WoBLE) แอปพลิเคชันยังสามารถขอใช้กลไกการรักษาความปลอดภัยที่เฉพาะเจาะจงเพื่อปกป้องข้อความที่ส่งระหว่างฝ่ายต่างๆ ได้ด้วย ซึ่งประกอบด้วยเซสชัน CASE และ PASE และคีย์กลุ่มแอปพลิเคชัน อินเทอร์เฟซสำหรับการกำหนดค่าการเชื่อมโยงใช้รูปแบบ API แบบประกาศ ซึ่งช่วยให้แอปพลิเคชันระบุข้อกำหนดสำหรับการสื่อสารด้วยคำง่ายๆ

โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบเกี่ยวกับ Binding::Configuration

การเตรียมพร้อม

ก่อนมีการสื่อสาร คุณต้อง "เตรียมการ" การเชื่อมโยง การเตรียมการผูกจะเกี่ยวข้องกับการกำหนดสถานะที่จำเป็นต่อการสื่อสาร ซึ่งอาจรวมถึงการแก้ไขที่อยู่เครือข่ายของเพียร์ การสร้างการเชื่อมต่อเครือข่าย และการเจรจาเกี่ยวกับคีย์ความปลอดภัย เมื่อแอปพลิเคชันกำหนดค่าแล้ว การเชื่อมโยง จะดูแลขั้นตอนทั้งหมดที่จำเป็นในการเตรียมพร้อมสำหรับการสื่อสาร โดยจะโทรกลับไปยังแอปพลิเคชันเมื่อกระบวนการเสร็จสมบูรณ์ ด้วยวิธีนี้ การผูกจะซ่อนกลไกการสื่อสารที่ทำให้แอปพลิเคชันจดจ่อกับการโต้ตอบในระดับสูง

การสื่อสาร

เมื่อเตรียม การเชื่อมโยง เรียบร้อยแล้ว ก็จะพร้อมใช้งาน ในสถานะนี้ แอปพลิเคชัน (หรือโดยทั่วไปคือโค้ดเลเยอร์โปรโตคอลที่ทำงานในนามของแอปพลิเคชัน) จะขอการเชื่อมโยงเพื่อจัดสรรบริบทของการซื้อขาย Weave บริบทของการแลกเปลี่ยนผลลัพธ์จะมีการกำหนดค่าไว้ล่วงหน้าสำหรับการสื่อสาร ซึ่งทำให้แอปพลิเคชันเริ่มต้นการแลกเปลี่ยน Weave กับแอปเทียบเท่าได้ทันที แอปพลิเคชันยังคงขอบริบทการแลกเปลี่ยนจากการเชื่อมโยงต่อไปได้จนกว่าการเชื่อมโยงจะปิดลง หรือบางเหตุการณ์ เช่น เครือข่ายล้มเหลว จะสิ้นสุดช่องทางการสื่อสารที่ใช้งานอยู่

การเปลี่ยนแปลงสถานะการเชื่อมโยง

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

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

การเชื่อมโยงตลอดอายุการใช้งาน

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

เมื่อแอปพลิเคชันใช้งานการเชื่อมโยงเสร็จแล้ว อาจเรียก Close() ในการเชื่อมโยง การดำเนินการนี้จะปล่อยการอ้างอิงของแอปพลิเคชันไปยังการเชื่อมโยง และบล็อกการส่งเหตุการณ์ API เพิ่มเติมทั้งหมด เมื่อมีการปล่อยการอ้างอิงสุดท้ายไปยังการเชื่อมโยง ระบบจะปิดการอ้างอิงนั้นโดยอัตโนมัติ

ประเภทสาธารณะ

 @23

void(* EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

 EventType

 State

void * AppState

void AddRef(
  void
)

WEAVE_ERROR AdjustResponseTimeout(
  ExchangeContext *apExchangeContext
) const 

WEAVE_ERROR AllocateRightSizedBuffer(
  PacketBuffer *& buf,
  const uint32_t desiredSize,
  const uint32_t minSize,
  uint32_t & outMaxPayloadSize
)

Configuration BeginConfiguration()

bool CanBePrepared(
  void
) const 

void Close(
  void
)

WeaveConnection * GetConnection() const 

uint32_t GetDefaultResponseTimeout() const 

const WRMPConfig & GetDefaultWRMPConfig(
  void
) const 

uint8_t GetEncryptionType(
  void
) const 

EventCallback GetEventCallback() const 

WeaveExchangeManager * GetExchangeManager() const 

uint32_t GetKeyId(
  void
) const 

uint16_t GetLogId(
  void
) const 

uint32_t GetMaxWeavePayloadSize(
  const System::PacketBuffer *msgBuf
)

void GetPeerDescription(
  char *buf,
  uint32_t bufSize
) const 

void GetPeerIPAddress(
  nl::Inet::IPAddress & address,
  uint16_t & port,
  InterfaceId & interfaceId
) const 

uint64_t GetPeerNodeId(
  void
) const 

void GetProtocolLayerCallback(
  EventCallback & callback,
  void *& state
) const 

State GetState(
  void
) const 

bool IsAuthenticMessageFromPeer(
  const WeaveMessageInfo *msgInfo
)

bool IsConnectionTransport() const 

bool IsPreparing(
  void
) const 

bool IsReady(
  void
) const 

bool IsUDPTransport() const 

bool IsUnreliableUDPTransport() const 

bool IsWRMTransport() const 

WEAVE_ERROR NewExchangeContext(
  ExchangeContext *& appExchangeContext
)

void Release(
  void
)

WEAVE_ERROR RequestPrepare()

void Reset(
  void
)

void SetDefaultResponseTimeout(
  uint32_t msec
)

void SetDefaultWRMPConfig(
  const WRMPConfig & wrmpConfig
)

void SetEventCallback(
  EventCallback aEventCallback
)

void SetProtocolLayerCallback(
  EventCallback callback,
  void *state
)

void DefaultEventHandler(
  void *apAppState,
  EventType aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)