ไม่มี:: สาน:: ผูกพัน:: การกำหนดค่า

#include <src/lib/core/WeaveBinding.h>

มีอินเตอร์เฟซที่เปิดเผยแบบสำหรับการกำหนดค่าและการเตรียม การผูก วัตถุ

สรุป

เมื่อกำหนดค่า ผูกมัด การใช้งานจะต้องเรียกวิธีการอย่างน้อยหนึ่งจากแต่ละกลุ่มต่อไปนี้: Target, ขนส่ง, และความมั่นคง อาจมีการเรียกวิธีการอื่นตามความจำเป็นเพื่อแทนที่การทำงานเริ่มต้น

หากการกำหนดค่าพิเศษร่วมกันจะเรียก (เช่น Transport_TCP () ตามด้วย Transport_UDP () ) คนสุดท้ายที่จะถูกเรียกว่าชนะ

งานสาธารณะ

ConfigureFromMessage (const WeaveMessageInfo *aMsgInfo, const Inet::IPPacketInfo *aPacketInfo)
กำหนดค่าการเชื่อมโยงเพื่อให้สามารถสื่อสารกับผู้ส่งข้อความที่ได้รับ
DNS_Options (uint8_t dnsOptions)
เมื่อแก้ไขชื่อโฮสต์ของเพียร์ ให้ใช้ตัวเลือก DNS ที่ระบุ
Exchange_ResponseTimeoutMsec (uint32_t aResponseTimeoutMsec)
ชุดหมดเวลาการตอบสนองเริ่มต้นสำหรับบริบทแลกเปลี่ยนที่สร้างขึ้นจากนี้ การผูก วัตถุ
GetError (void) const
กลับข้อผิดพลาดใด ๆ ที่เกิดขึ้นในขณะที่การกำหนดค่า เข้าเล่ม
PrepareBinding (void)
เป็นขั้นตอนการเตรียมการ เข้าเล่ม สำหรับการสื่อสารกับเพียร์
Security_AppGroupKey (uint32_t aAppGroupGlobalId, uint32_t aRootKeyId, bool aUseRotatingKey)
เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสสำหรับ Weave Application Group ที่ระบุ
Security_AuthenticationMode (WeaveAuthMode aAuthMode)
ตั้งค่าโหมดการตรวจสอบสิทธิ์ที่ร้องขอเพื่อใช้ตรวจสอบสิทธิ์เพียร์
Security_CASESession (void)
เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์เซสชันของ CASE ที่สร้างด้วยโหนดเพียร์
Security_EncryptionType (uint8_t aEncType)
เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้ประเภทการเข้ารหัสข้อความที่ระบุ
Security_Key (uint32_t aKeyId)
เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์ที่ระบุ
Security_None (void)
เมื่อสื่อสารกับเพียร์ ให้ส่งและรับแบบไม่เข้ารหัส (เช่น
Security_PASESession (uint8_t aPasswordSource)
เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์เซสชัน PASE ที่สร้างด้วยโหนดเพียร์
Security_SharedCASESession (void)
เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์เซสชัน CASE ที่แชร์ซึ่งสร้างด้วยเราเตอร์ Nest core
Security_SharedCASESession (uint64_t aRouterNodeId)
เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์เซสชัน CASE ที่ใช้ร่วมกันซึ่งสร้างด้วยโหนดเราเตอร์ที่ระบุ
Security_TAKESession ()
เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์เซสชัน TAKE ที่สร้างด้วยโหนดเพียร์
TargetAddress_IP ( nl::Inet::IPAddress aPeerAddress, uint16_t aPeerPort, InterfaceId aInterfaceId)
เมื่อสื่อสารกับเพียร์ ให้ใช้ที่อยู่ IP พอร์ต และอินเทอร์เฟซเครือข่ายเฉพาะ
TargetAddress_IP (const char *aHostName, uint16_t aPeerPort, InterfaceId aInterfaceId)
เมื่อสื่อสารกับเพียร์ ให้ใช้ชื่อโฮสต์ พอร์ต และอินเทอร์เฟซเครือข่ายเฉพาะ
TargetAddress_IP (const char *aHostName, size_t aHostNameLen, uint16_t aPeerPort, InterfaceId aInterfaceId)
เมื่อสื่อสารกับเพียร์ ให้ใช้ชื่อโฮสต์ พอร์ต และอินเทอร์เฟซเครือข่ายเฉพาะ
TargetAddress_WeaveFabric (uint16_t aSubnetId)
เมื่อสื่อสารกับเพียร์ ให้ใช้ที่อยู่ Weave fabric ที่ได้มาจาก id โหนดของเพียร์และซับเน็ตที่ระบุ
TargetAddress_WeaveService (void)
เมื่อสื่อสารกับเพียร์ ให้ใช้ที่อยู่บริการแฟบริก Weave ที่ได้มาจาก id โหนดของเพียร์
Target_NodeId (uint64_t aPeerNodeId)
กำหนดค่าการเชื่อมโยงเพื่อสื่อสารกับ id โหนด Weave เฉพาะ
Target_ServiceEndpoint (uint64_t aPeerNodeId)
กำหนดค่าการเชื่อมโยงเพื่อสื่อสารกับจุดปลายบริการ Weave เฉพาะ
Transport_DefaultWRMPConfig (const WRMPConfig & aWRMPConfig)
ตั้งค่าการกำหนดค่าเริ่มต้นสำหรับ WRMP บริบทแลกเปลี่ยนที่สร้างขึ้นจากนี้ การผูก วัตถุ
Transport_ExistingConnection ( WeaveConnection *apConnection)
ใช้การเชื่อมต่อ Weave ที่มีอยู่เพื่อสื่อสารกับเพื่อน
Transport_TCP (void)
ใช้ TCP เพื่อสื่อสารกับเพียร์
Transport_UDP (void)
ใช้ UDP เพื่อสื่อสารกับเพียร์
Transport_UDP_PathMTU (uint32_t aPathMTU)
ตั้งค่าเส้นทาง MTU ที่คาดไว้สำหรับแพ็กเก็ต UDP ที่เดินทางไปยังเพียร์
Transport_UDP_WRM (void)
ใช้โปรโตคอลการส่งข้อความที่เชื่อถือได้ของ Weave เมื่อสื่อสารกับเพื่อน

งานสาธารณะ

ConfigureFromMessage

Configuration & ConfigureFromMessage(
  const WeaveMessageInfo *aMsgInfo,
  const Inet::IPPacketInfo *aPacketInfo
)

กำหนดค่าการเชื่อมโยงเพื่อให้สามารถสื่อสารกับผู้ส่งข้อความที่ได้รับ

รายละเอียด
พารามิเตอร์
[in] aMsgInfo
โครงสร้างข้อมูลข้อความที่เกี่ยวข้องกับข้อความที่ได้รับ
[in] aPacketInfo
ข้อมูลแพ็คเก็ตสำหรับข้อความที่ได้รับ

DNS_Options

Configuration & DNS_Options(
  uint8_t dnsOptions
)

เมื่อแก้ไขชื่อโฮสต์ของเพียร์ ให้ใช้ตัวเลือก DNS ที่ระบุ

รายละเอียด
พารามิเตอร์
[in] dnsOptions
ค่าจำนวนเต็มควบคุมวิธีการแก้ไขชื่อโฮสต์ ค่าควรเป็นหนึ่งในค่าจากการแจงนับ #::nl::Inet::DNSOptions
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

Exchange_ResponseTimeoutMsec

Configuration & Exchange_ResponseTimeoutMsec(
  uint32_t aResponseTimeoutMsec
)

ชุดหมดเวลาการตอบสนองเริ่มต้นสำหรับบริบทแลกเปลี่ยนที่สร้างขึ้นจากนี้ การผูก วัตถุ

รายละเอียด
พารามิเตอร์
[in] aResponseTimeoutMsec
เวลาตอบสนองเริ่มต้น หน่วยเป็นมิลลิวินาที
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

รับข้อผิดพลาด

WEAVE_ERROR GetError(
  void
) const

กลับข้อผิดพลาดใด ๆ ที่เกิดขึ้นในขณะที่การกำหนดค่า เข้าเล่ม

เตรียมเข้าเล่ม

WEAVE_ERROR PrepareBinding(
  void
)

เป็นขั้นตอนการเตรียมการ เข้าเล่ม สำหรับการสื่อสารกับเพียร์

Security_AppGroupKey

Configuration & Security_AppGroupKey(
  uint32_t aAppGroupGlobalId,
  uint32_t aRootKeyId,
  bool aUseRotatingKey
)

เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสสำหรับ Weave Application Group ที่ระบุ

รายละเอียด
พารามิเตอร์
[in] aAppGroupGlobalId
รหัสส่วนกลางของกลุ่มแอปพลิเคชันที่ควรเข้ารหัสข้อความ
[in] aRootKeyId
คีย์รูทที่ใช้เพื่อรับคีย์การเข้ารหัสสำหรับ Weave Application Group ที่ระบุ
[in] aUseRotatingKey
True หาก Weave Application Group ใช้แป้นข้อความแบบหมุน
คืนสินค้า
การอ้างอิงไปยัง ผูก วัตถุ

Security_AuthenticationMode

Configuration & Security_AuthenticationMode(
  WeaveAuthMode aAuthMode
)

ตั้งค่าโหมดการตรวจสอบสิทธิ์ที่ร้องขอเพื่อใช้ตรวจสอบสิทธิ์เพียร์

รายละเอียด
พารามิเตอร์
[in] aAuthMode
โหมดการรับรองความถูกต้องที่ร้องขอ
คืนสินค้า
การอ้างอิงไปยัง ผูก วัตถุ

ความปลอดภัย_CASESession

Configuration & Security_CASESession(
  void
)

เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์เซสชันของ CASE ที่สร้างด้วยโหนดเพียร์

หากไม่มีเซสชันที่จำเป็น ระบบจะสร้างเซสชันโดยอัตโนมัติเพื่อเป็นส่วนหนึ่งของการเตรียมการผูก

รายละเอียด
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

Security_EncryptionType

Configuration & Security_EncryptionType(
  uint8_t aEncType
)

เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้ประเภทการเข้ารหัสข้อความที่ระบุ

รายละเอียด
พารามิเตอร์
[in] aEncType
ประเภทการเข้ารหัสข้อความสาน
คืนสินค้า
การอ้างอิงไปยัง ผูก วัตถุ

กุญแจสำคัญในการรักษาความปลอดภัย

Configuration & Security_Key(
  uint32_t aKeyId
)

เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์ที่ระบุ

รายละเอียด
พารามิเตอร์
[in] aKeyId
รหัสของคีย์การเข้ารหัส คีย์ที่ระบุต้องเหมาะสมกับการเข้ารหัสข้อความ Weave
คืนสินค้า
การอ้างอิงไปยัง ผูก วัตถุ

ความปลอดภัย_ไม่มี

Configuration & Security_None(
  void
)

เมื่อสื่อสารกับเพียร์ ให้ส่งและรับแบบไม่เข้ารหัส (เช่น

ไม่ปลอดภัย) ข้อความ

รายละเอียด
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

ความปลอดภัย_PASESession

Configuration & Security_PASESession(
  uint8_t aPasswordSource
)

เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์เซสชัน PASE ที่สร้างด้วยโหนดเพียร์

หากไม่มีเซสชันที่จำเป็น ระบบจะสร้างเซสชันโดยอัตโนมัติเพื่อเป็นส่วนหนึ่งของการเตรียมการผูก

รายละเอียด
พารามิเตอร์
[in] aPasswordSource
แหล่งที่มาของรหัสผ่านที่จะใช้ระหว่างการสร้างเซสชัน PASE
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

Security_SharedCASESession

Configuration & Security_SharedCASESession(
  void
)

เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์เซสชัน CASE ที่แชร์ซึ่งสร้างด้วยเราเตอร์ Nest core

หากไม่มีเซสชันที่จำเป็น ระบบจะสร้างเซสชันโดยอัตโนมัติเพื่อเป็นส่วนหนึ่งของการเตรียมการผูก

รายละเอียด
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

Security_SharedCASESession

Configuration & Security_SharedCASESession(
  uint64_t aRouterNodeId
)

เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์เซสชัน CASE ที่ใช้ร่วมกันซึ่งสร้างด้วยโหนดเราเตอร์ที่ระบุ

หากไม่มีเซสชันที่จำเป็น ระบบจะสร้างเซสชันโดยอัตโนมัติเพื่อเป็นส่วนหนึ่งของการเตรียมการผูก

รายละเอียด
พารามิเตอร์
[in] aRouterNodeId
Weave node ID ของเราเตอร์ที่ควรสร้างเซสชัน CASE ที่ใช้ร่วมกัน
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

ความปลอดภัย_TAKESession

Configuration & Security_TAKESession()

เมื่อสื่อสารกับเพียร์ ให้ส่งและรับข้อความที่เข้ารหัสโดยใช้คีย์เซสชัน TAKE ที่สร้างด้วยโหนดเพียร์

หากไม่มีเซสชันที่จำเป็น ระบบจะสร้างเซสชันโดยอัตโนมัติเพื่อเป็นส่วนหนึ่งของการเตรียมการผูก

รายละเอียด
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

TargetAddress_IP

Configuration & TargetAddress_IP(
  nl::Inet::IPAddress aPeerAddress,
  uint16_t aPeerPort,
  InterfaceId aInterfaceId
)

เมื่อสื่อสารกับเพียร์ ให้ใช้ที่อยู่ IP พอร์ต และอินเทอร์เฟซเครือข่ายเฉพาะ

รายละเอียด
พารามิเตอร์
[in] aPeerAddress
ที่อยู่ IP สำหรับเพียร์
[in] aPeerPort
พอร์ตระยะไกล
[in] aInterfaceId
ID ของอินเทอร์เฟซเครือข่ายท้องถิ่นที่จะใช้สำหรับการสื่อสาร
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

TargetAddress_IP

Configuration & TargetAddress_IP(
  const char *aHostName,
  uint16_t aPeerPort,
  InterfaceId aInterfaceId
)

เมื่อสื่อสารกับเพียร์ ให้ใช้ชื่อโฮสต์ พอร์ต และอินเทอร์เฟซเครือข่ายเฉพาะ

หมายเหตุ: ผู้เรียกต้องแน่ใจว่าสตริงชื่อโฮสต์ที่ให้มายังคงใช้ได้จนกว่าขั้นตอนการเตรียมการผูกจะเสร็จสิ้น

รายละเอียด
พารามิเตอร์
[in] aHostName
สตริงที่สิ้นสุดด้วยค่า NULL ที่มีชื่อโฮสต์ของเพียร์
[in] aPeerPort
พอร์ตระยะไกลที่จะใช้เมื่อสื่อสารกับเพียร์
[in] aInterfaceId
ID ของอินเทอร์เฟซเครือข่ายท้องถิ่นที่จะใช้สำหรับการสื่อสาร
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

TargetAddress_IP

Configuration & TargetAddress_IP(
  const char *aHostName,
  size_t aHostNameLen,
  uint16_t aPeerPort,
  InterfaceId aInterfaceId
)

เมื่อสื่อสารกับเพียร์ ให้ใช้ชื่อโฮสต์ พอร์ต และอินเทอร์เฟซเครือข่ายเฉพาะ

หมายเหตุ: ผู้เรียกต้องแน่ใจว่าสตริงชื่อโฮสต์ที่ให้มายังคงใช้ได้จนกว่าขั้นตอนการเตรียมการผูกจะเสร็จสิ้น

รายละเอียด
พารามิเตอร์
[in] aHostName
สตริงที่มีชื่อโฮสต์ของเพียร์ สตริงนี้ไม่จำเป็นต้องถูกยกเลิก NULL
[in] aHostNameLen
ความยาวของสตริงที่ aHostName ชี้ไป
[in] aPeerPort
พอร์ตระยะไกลที่จะใช้เมื่อสื่อสารกับเพียร์
[in] aInterfaceId
ID ของอินเทอร์เฟซเครือข่ายท้องถิ่นที่จะใช้สำหรับการสื่อสาร
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

TargetAddress_WeaveFabric

Configuration & TargetAddress_WeaveFabric(
  uint16_t aSubnetId
)

เมื่อสื่อสารกับเพียร์ ให้ใช้ที่อยู่ Weave fabric ที่ได้มาจาก id โหนดของเพียร์และซับเน็ตที่ระบุ

รายละเอียด
พารามิเตอร์
[in] aSubnetId
id ซับเน็ตที่จะใช้ในการสร้างที่อยู่ทอผ้าของเพียร์
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

TargetAddress_WeaveService

Configuration & TargetAddress_WeaveService(
  void
)

เมื่อสื่อสารกับเพียร์ ให้ใช้ที่อยู่บริการแฟบริก Weave ที่ได้มาจาก id โหนดของเพียร์

รายละเอียด
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

Target_NodeId

Configuration & Target_NodeId(
  uint64_t aPeerNodeId
)

กำหนดค่าการเชื่อมโยงเพื่อสื่อสารกับ id โหนด Weave เฉพาะ

รายละเอียด
พารามิเตอร์
[in] aPeerNodeId
โหนด id ของโหนดเพียร์
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

Target_ServiceEndpoint

Configuration & Target_ServiceEndpoint(
  uint64_t aPeerNodeId
)

กำหนดค่าการเชื่อมโยงเพื่อสื่อสารกับจุดปลายบริการ Weave เฉพาะ

หากไม่ได้กำหนดค่าไว้เป็นอย่างอื่น ที่อยู่เพียร์จะถูกตั้งค่าเป็นที่อยู่ทอผ้าของจุดปลายบริการ

รายละเอียด
พารามิเตอร์
[in] serviceEndpointId
node id ของ service endpoint ที่จะทำการสื่อสาร
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

Transport_DefaultWRMPConfig

Configuration & Transport_DefaultWRMPConfig(
  const WRMPConfig & aWRMPConfig
)

ตั้งค่าการกำหนดค่าเริ่มต้นสำหรับ WRMP บริบทแลกเปลี่ยนที่สร้างขึ้นจากนี้ การผูก วัตถุ

รายละเอียด
พารามิเตอร์
[in] aWRMPConfig
การอ้างอิงถึงคอนฟิกูเรชัน WRMP เริ่มต้นใหม่
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

Transport_ExistingConnection

Configuration & Transport_ExistingConnection(
  WeaveConnection *apConnection
)

ใช้การเชื่อมต่อ Weave ที่มีอยู่เพื่อสื่อสารกับเพื่อน

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

รายละเอียด
พารามิเตอร์
[in] con
ตัวชี้ไปยังการเชื่อมต่อ Weave ที่มีอยู่
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

ขนส่ง_TCP

Configuration & Transport_TCP(
  void
)

ใช้ TCP เพื่อสื่อสารกับเพียร์

รายละเอียด
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

ขนส่ง_UDP

Configuration & Transport_UDP(
  void
)

ใช้ UDP เพื่อสื่อสารกับเพียร์

รายละเอียด
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

Transport_UDP_PathMTU

Configuration & Transport_UDP_PathMTU(
  uint32_t aPathMTU
)

ตั้งค่าเส้นทาง MTU ที่คาดไว้สำหรับแพ็กเก็ต UDP ที่เดินทางไปยังเพียร์

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

รายละเอียด
พารามิเตอร์
[in] aPathMTU
เส้นทาง MTU ที่คาดไว้สำหรับแพ็กเก็ต UDP ที่เดินทางไปยังเพียร์
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน

ขนส่ง_UDP_WRM

Configuration & Transport_UDP_WRM(
  void
)

ใช้โปรโตคอลการส่งข้อความที่เชื่อถือได้ของ Weave เมื่อสื่อสารกับเพื่อน

รายละเอียด
คืนสินค้า
การอ้างอิงถึงวัตถุที่มีผลผูกพัน