nl::Weave::Binding

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

สรุป

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

การกำหนดค่า

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

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

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

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

การสื่อสาร

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

การเปลี่ยนแปลงสถานะที่มีผลผูกพัน

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

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

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

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

เมื่อแอปพลิเคชันเสร็จสิ้นการเชื่อมโยงแล้ว แอปพลิเคชันอาจเรียกใช้ Close() ในการเชื่อมโยง การดำเนินการนี้จะเผยแพร่การอ้างอิงของแอปพลิเคชันกับ Binding และบล็อกการส่งเหตุการณ์ 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
)