nl::Weave::Binding::Configuration

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

הממשק הזה מספק ממשק בסגנון ההצהרה להגדרה והכנה של אובייקט Binding.

סיכום

כשמגדירים קישור, האפליקציות צריכות להפעיל שיטה אחת לפחות מכל אחת מקבוצות ההגדרה הבאות: Target , Transport ו-Security. ניתן להפעיל שיטות אחרות לפי הצורך כדי לשנות את התנהגות ברירת המחדל.

אם מופעלות הגדרות בלעדיות הדדיות (למשל, 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.
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.
Security_SharedCASESession(uint64_t aRouterNodeId)
כשמתקשרים עם האפליקציה השכנה, שולחים ומקבלים הודעות שמוצפנות באמצעות מפתח משותף לסשן CASE שנוצר עם צומת של נתב ספציפי.
Security_TAKESession()
במהלך תקשורת עם אפליקציה להשוואה, ניתן לשלוח ולקבל הודעות שמוצפנות באמצעות מפתח לסשן Takeout שנוצר בצומת העמית.
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 שנגזרת ממזהה הצומת של העמית ותת-רשת שצוינה.
TargetAddress_WeaveService(void)
בעת תקשורת עם העמית, השתמש בכתובת מארג שירות של Weave שנגזרת ממזהה הצומת של העמית.
Target_NodeId(uint64_t aPeerNodeId)
הגדרת הקישור כדי לתקשר עם מזהה צומת ספציפי של Weave.
Target_ServiceEndpoint(uint64_t aPeerNodeId)
הגדרת הקישור לתקשורת עם נקודת קצה ספציפית של שירות Weave.
Transport_DefaultWRMPConfig(const WRMPConfig & aWRMPConfig)
יש לקבוע את תצורת ברירת המחדל של WRMP בהקשרים של Exchange שנוצרו מאובייקט Binding זה.
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 Trusted Messaging במהלך תקשורת עם קולך.

תפקידים ציבוריים

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
זמן התגובה שמוגדר כברירת מחדל באלפיות השנייה
החזרות
הפניה לאובייקט המקשר.

GetError

WEAVE_ERROR GetError(
  void
) const

מחזירים את השגיאות שאירעו במהלך הגדרת הקישור.

PrepareBinding

WEAVE_ERROR PrepareBinding(
  void
)

להיות תהליך הכנת הקישור לתקשורת עם העמיתים.

Security_AppGroupKey

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

בתקשורת עם אפליקציה להשוואה, עליך לשלוח ולקבל הודעות שהוצפנו עבור קבוצת אפליקציות של Weave.

פרטים
פרמטרים
[in] aAppGroupGlobalId
המזהה הגלובלי של קבוצת האפליקציות שבה ההודעות צריכות להיות מוצפנות.
[in] aRootKeyId
מפתח השורש שמשמש להפקת מפתחות הצפנה עבור קבוצת אפליקציות Weave שצוינה.
[in] aUseRotatingKey
True אם קבוצת האפליקציות Weave משתמשת במקשי הודעות מסתובבים.
החזרות
הפניה לאובייקט קישור.

Security_AuthenticationMode

Configuration & Security_AuthenticationMode(
  WeaveAuthMode aAuthMode
)

הגדרת מצב האימות המבוקש שישמש לאימות של אפליקציה להשוואה.

פרטים
פרמטרים
[in] aAuthMode
מצב האימות המבוקש.
החזרות
הפניה לאובייקט קישור.

Security_CASESession

Configuration & Security_CASESession(
  void
)

במהלך תקשורת עם העמיתים, שליחה וקבלה של הודעות שמוצפנות באמצעות מפתח לסשן CASE שנוצר עם הצומת של האפליקציה להשוואה.

אם הסשן הנדרש לא זמין, הוא ייווצר באופן אוטומטי כחלק מהכנת הקישור.

פרטים
החזרות
הפניה לאובייקט המקשר.

Security_EncryptionType

Configuration & Security_EncryptionType(
  uint8_t aEncType
)

כשמתקשרים עם האפליקציה השכנה, אפשר לשלוח ולקבל הודעות שמוצפנות באמצעות סוג הצפנת ההודעות שצוין.

פרטים
פרמטרים
[in] aEncType
סוג ההצפנה של הודעות ב-Weave.
החזרות
הפניה לאובייקט קישור.

Security_Key

Configuration & Security_Key(
  uint32_t aKeyId
)

במהלך תקשורת עם האפליקציה להשוואה, ניתן לשלוח ולקבל הודעות שמוצפנות באמצעות מפתח מסוים.

פרטים
פרמטרים
[in] aKeyId
המזהה של מפתח ההצפנה. המפתח שצוין חייב להתאים להצפנת הודעות ב-Weave.
החזרות
הפניה לאובייקט קישור.

Security_None

Configuration & Security_None(
  void
)

במהלך תקשורת עם העמיתים, שליחה וקבלה של תוכן לא מוצפן (כלומר

הודעות לא מאובטחות.

פרטים
החזרות
הפניה לאובייקט המקשר.

Security_PASESession

Configuration & Security_PASESession(
  uint8_t aPasswordSource
)

במהלך תקשורת עם אפליקציה להשוואה, ניתן לשלוח ולקבל הודעות שמוצפנות באמצעות מפתח סשן PASE שנוצר בצומת העמית.

אם הסשן הנדרש לא זמין, הוא ייווצר באופן אוטומטי כחלק מהכנת הקישור.

פרטים
פרמטרים
[in] aPasswordSource
המקור של הסיסמה שבה יש להשתמש במהלך יצירת פעילות PASE.
החזרות
הפניה לאובייקט המקשר.

Security_SharedCASESession

Configuration & Security_SharedCASESession(
  void
)

במהלך התקשורת עם האפליקציה השכנה, עליך לשלוח ולקבל הודעות שהוצפנו באמצעות מפתח משותף לסשן CASE שנוצר באמצעות נתב הליבה של Nest.

אם הסשן הנדרש לא זמין, הוא ייווצר באופן אוטומטי כחלק מהכנת הקישור.

פרטים
החזרות
הפניה לאובייקט המקשר.

Security_SharedCASESession

Configuration & Security_SharedCASESession(
  uint64_t aRouterNodeId
)

כשמתקשרים עם האפליקציה השכנה, שולחים ומקבלים הודעות שמוצפנות באמצעות מפתח משותף לסשן CASE שנוצר עם צומת של נתב ספציפי.

אם הסשן הנדרש לא זמין, הוא ייווצר באופן אוטומטי כחלק מהכנת הקישור.

פרטים
פרמטרים
[in] aRouterNodeId
מזהה הצומת של Weave של הנתב שאיתו יש ליצור פעילות מקרה משותפת.
החזרות
הפניה לאובייקט המקשר.

Security_TAKESession

Configuration & Security_TAKESession()

במהלך תקשורת עם אפליקציה להשוואה, ניתן לשלוח ולקבל הודעות שמוצפנות באמצעות מפתח לסשן Takeout שנוצר בצומת העמית.

אם הסשן הנדרש לא זמין, הוא ייווצר באופן אוטומטי כחלק מהכנת הקישור.

פרטים
החזרות
הפניה לאובייקט המקשר.

TargetAddress_IP

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

כשיוצרים תקשורת עם האפליקציה השכנה, יש להשתמש בכתובת ה-IP, ביציאה ובממשק הרשת הספציפיים.

פרטים
פרמטרים
[in] aPeerAddress
כתובת ה-IP של האפליקציה להשוואה
[in] aPeerPort
יציאה מרוחקת
[in] aInterfaceId
המזהה של ממשק הרשת המקומית שישמש לתקשורת
החזרות
הפניה לאובייקט המקשר.

TargetAddress_IP

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

כשמתקשרים עם האפליקציה השכנה, יש להשתמש בשם המארח הספציפי, ביציאה ובממשק הרשת.

הערה: מבצע הקריאה החוזרת חייב לוודא שמחרוזת שם המארח שצוינה נשארת בתוקף עד לסיום שלב ההכנה המקשר.

פרטים
פרמטרים
[in] aHostName
מחרוזת מסתיימת ב-NULL שמכילה את שם המארח של העמית.
[in] aPeerPort
יציאה מרוחקת לשימוש בתקשורת עם עמית.
[in] aInterfaceId
המזהה של ממשק הרשת המקומית לשימוש לתקשורת.
החזרות
הפניה לאובייקט המקשר.

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
המזהה של ממשק הרשת המקומית לשימוש לתקשורת.
החזרות
הפניה לאובייקט המקשר.

TargetAddress_WeaveFabric

Configuration & TargetAddress_WeaveFabric(
  uint16_t aSubnetId
)

בעת תקשורת עם העמית, השתמש בכתובת מארג של Weave שנגזרת ממזהה הצומת של העמית ותת-רשת שצוינה.

פרטים
פרמטרים
[in] aSubnetId
מזהה תת-הרשת שישמש ליצירת כתובת בד ה-Weave של העמית.
החזרות
הפניה לאובייקט המקשר.

TargetAddress_WeaveService

Configuration & TargetAddress_WeaveService(
  void
)

בעת תקשורת עם העמית, השתמש בכתובת מארג שירות של Weave שנגזרת ממזהה הצומת של העמית.

פרטים
החזרות
הפניה לאובייקט המקשר.

Target_NodeId

Configuration & Target_NodeId(
  uint64_t aPeerNodeId
)

הגדרת הקישור כדי לתקשר עם מזהה צומת ספציפי של Weave.

פרטים
פרמטרים
[in] aPeerNodeId
מזהה הצומת של הצומת של אפליקציה להשוואה.
החזרות
הפניה לאובייקט המקשר.

Target_ServiceEndpoint

Configuration & Target_ServiceEndpoint(
  uint64_t aPeerNodeId
)

הגדרת הקישור לתקשורת עם נקודת קצה ספציפית של שירות Weave.

אם לא נקבעה הגדרה אחרת, הכתובת של הצד השני בשיחה מוגדרת לכתובת הבד של Weave של נקודת הקצה של השירות.

פרטים
פרמטרים
[in] serviceEndpointId
מזהה הצומת של נקודת הקצה של השירות שאיתה תתבצע התקשורת.
החזרות
הפניה לאובייקט המקשר.

Transport_DefaultWRMPConfig

Configuration & Transport_DefaultWRMPConfig(
  const WRMPConfig & aWRMPConfig
)

יש לקבוע את תצורת ברירת המחדל של WRMP בהקשרים של Exchange שנוצרו מאובייקט Binding זה.

פרטים
פרמטרים
[in] aWRMPConfig
הפניה לברירת המחדל החדשה של הגדרות WRMP.
החזרות
הפניה לאובייקט המקשר.

Transport_ExistingConnection

Configuration & Transport_ExistingConnection(
  WeaveConnection *apConnection
)

שימוש בחיבור קיים ל-Weave לצורך תקשורת עם העמית.

הערה: ספירת ההפניות באובייקט החיבור גדלה כאשר הכנת הקישור מצליחה. לכן האפליקציה אחראית לוודא שאובייקט החיבור יישאר פעיל עד לזמן הזה.

פרטים
פרמטרים
[in] con
מצביע לחיבור הקיים ב-Weave.
החזרות
הפניה לאובייקט המקשר.

Transport_TCP

Configuration & Transport_TCP(
  void
)

שימוש ב-TCP כדי לתקשר עם אפליקציה להשוואה.

פרטים
החזרות
הפניה לאובייקט המקשר.

Transport_UDP

Configuration & Transport_UDP(
  void
)

שימוש ב-UDP לתקשורת עם אפליקציה להשוואה.

פרטים
החזרות
הפניה לאובייקט המקשר.

Transport_UDP_PathMTU

Configuration & Transport_UDP_PathMTU(
  uint32_t aPathMTU
)

צריך להגדיר את הנתיב הצפוי של ה-MTU עבור חבילות UDP שנוסעות לעמית.

בפרוטוקולים מסוימים של Weave ייעשה שימוש בהתאמה דינמית של גודל המטען הייעודי (payload) של הודעת Weave.

פרטים
פרמטרים
[in] aPathMTU
הנתיב הצפוי של ה-MTU עבור חבילות UDP שנוסעות לעמית.
החזרות
הפניה לאובייקט המקשר.

Transport_UDP_WRM

Configuration & Transport_UDP_WRM(
  void
)

השתמש בפרוטוקול Weave Trusted Messaging במהלך תקשורת עם קולך.

פרטים
החזרות
הפניה לאובייקט המקשר.