nl::Weave::Binding::Configuration

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

میانایی با سبک اعلانی برای پیکربندی و آماده‌سازی شیء Binding ارائه می‌دهد.

خلاصه

هنگام پیکربندی Binding، برنامه‌ها باید حداقل یک روش را از هریک از گروه‌های پیکربندی زیر فراخوانی کنند: Target،‏ Transport، و Security. درصورت نیاز، ممکن است روش‌های دیگری برای لغو رفتار پیش‌فرض فراخوانی شود.

اگر پیکربندی‌های ناسازگار فراخوانده شوند (برای مثال، Transport_TCP() و سپس Transport_UDP())، آخرین پیکربندی فراخوانده‌شده اعمال می‌شود.

عملکردهای عمومی

ConfigureFromMessage(const WeaveMessageInfo *aMsgInfo, const Inet::IPPacketInfo *aPacketInfo)
اتصال را پیکربندی کنید تا امکان برقراری ارتباط با فرستنده پیام دریافتی فراهم شود.
DNS_Options(uint8_t dnsOptions)
هنگام حل کردن نام میزبان همتا، از گزینه‌های ساناد مشخص‌شده استفاده کنید.
Exchange_ResponseTimeoutMsec(uint32_t aResponseTimeoutMsec)
تنظیم زمان استراحت پاسخ پیش‌فرض برای زمینه‌های تبادل ایجادشده از این شیء Binding.
GetError(void) const
هر خطایی را که هنگام پیکربندی Binding رخ داده است برگردانید.
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()
هنگام برقراری ارتباط با همتا، پیام‌های رمزگذاری‌شده را بااستفاده از کلید جلسه 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 استفاده کنید که از شناسه گره همتا و زیرشبکه مشخص‌شده مشتق شده است.
TargetAddress_WeaveService(void)
هنگام برقراری ارتباط با همتا، از نشانی ساختار سرویس Weave که از شناسه گره همتا مشتق شده است استفاده کنید.
Target_NodeId(uint64_t aPeerNodeId)
اتصال را برای برقراری ارتباط با شناسه گره Weave خاصی پیکربندی کنید.
Target_ServiceEndpoint(uint64_t aPeerNodeId)
اتصال را برای برقراری ارتباط با نقطه پایانی سرویس Weave خاصی پیکربندی کنید.
Transport_DefaultWRMPConfig(const WRMPConfig & aWRMPConfig)
پیکربندی WRMP پیش‌فرض را برای زمینه‌های تبادل ایجادشده از این شیء 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 Reliable Messaging استفاده کنید.

عملکردهای عمومی

ConfigureFromMessage

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

اتصال را پیکربندی کنید تا امکان برقراری ارتباط با فرستنده پیام دریافتی فراهم شود.

جزئیات
پارامترها
[in] aMsgInfo
ساختار اطلاعات پیام مرتبط با پیام دریافتی.
[in] aPacketInfo
اطلاعات بسته برای پیام دریافتی.

DNS_Options

Configuration & DNS_Options(
  uint8_t dnsOptions
)

هنگام حل کردن نام میزبان همتا، از گزینه‌های ساناد مشخص‌شده استفاده کنید.

جزئیات
پارامترها
[in] dnsOptions
مقدار عدد صحیحی که نحوه انجام تفکیک نام میزبان را کنترل می‌کند. مقدار باید یکی از مقادیر شمارش #::nl::Inet::DNSOptions باشد.
کالاهای مرجوعی
ارجاع به شیء الزام‌آور.

Exchange_ResponseTimeoutMsec

Configuration & Exchange_ResponseTimeoutMsec(
  uint32_t aResponseTimeoutMsec
)

تنظیم زمان استراحت پاسخ پیش‌فرض برای زمینه‌های تبادل ایجادشده از این شیء Binding.

جزئیات
پارامترها
[in] aResponseTimeoutMsec
زمان پاسخ پیش‌فرض، برحسب میلی‌ثانیه.
کالاهای مرجوعی
ارجاع به شیء الزام‌آور.

GetError

WEAVE_ERROR GetError(
  void
) const 

هر خطایی را که هنگام پیکربندی Binding رخ داده است برگردانید.

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
اگر «گروه برنامه Weave» از کلیدهای پیام چرخشی استفاده کند، True است.
کالاهای مرجوعی
ارجاع به شیء Binding.

Security_AuthenticationMode

Configuration & Security_AuthenticationMode(
  WeaveAuthMode aAuthMode
)

حالت اصالت‌سنجی درخواستی را برای استفاده در اصالت‌سنجی همتا تنظیم کنید.

جزئیات
پارامترها
[in] aAuthMode
حالت اصالت‌سنجی درخواست‌شده.
کالاهای مرجوعی
ارجاع به شیء Binding.

Security_CASESession

Configuration & Security_CASESession(
  void
)

هنگام برقراری ارتباط با همتا، پیام‌های رمزگذاری‌شده را بااستفاده از کلید جلسه CASE که با گره همتا ایجاد شده است ارسال و دریافت کنید.

اگر جلسه لازم دردسترس نباشد، به‌طور خودکار به‌عنوان بخشی از آماده‌سازی اتصال برقرار خواهد شد.

جزئیات
کالاهای مرجوعی
ارجاع به شیء الزام‌آور.

Security_EncryptionType

Configuration & Security_EncryptionType(
  uint8_t aEncType
)

هنگام برقراری ارتباط با همتا، پیام‌ها را بااستفاده از نوع رمزگذاری پیام مشخص‌شده رمزگذاری کنید و ارسال و دریافت کنید.

جزئیات
پارامترها
[in] aEncType
نوع رمزگذاری پیام Weave.
کالاهای مرجوعی
ارجاع به شیء Binding.

Security_Key

Configuration & Security_Key(
  uint32_t aKeyId
)

هنگام برقراری ارتباط با همتا، پیام‌ها را بااستفاده از کلید مشخص‌شده رمزگذاری و ارسال و دریافت کنید.

جزئیات
پارامترها
[in] aKeyId
شناسه کلید رمزگذاری. کلید مشخص‌شده باید برای رمزگذاری پیام Weave مناسب باشد.
کالاهای مرجوعی
ارجاع به شیء Binding.

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 مربوط به مسیریابی که جلسه CASE مشترک باید با آن برقرار شود.
کالاهای مرجوعی
ارجاع به شیء الزام‌آور.

Security_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
شناسه میانای شبکه محلی برای استفاده در ارتباطات
کالاهای مرجوعی
ارجاع به شیء الزام‌آور.

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 پیش‌فرض را برای زمینه‌های تبادل ایجادشده از این شیء 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، از این مقدار برای تنظیم پویای اندازه بار پیام Weave استفاده می‌شود.

جزئیات
پارامترها
[in] aPathMTU
MTU مسیر موردانتظار برای بسته‌های UDP که به همتا می‌روند.
کالاهای مرجوعی
ارجاع به شیء الزام‌آور.

Transport_UDP_WRM

Configuration & Transport_UDP_WRM(
  void
)

هنگام برقراری ارتباط با همتا، از پروتکل Weave Reliable Messaging استفاده کنید.

جزئیات
کالاهای مرجوعی
ارجاع به شیء الزام‌آور.