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 )
اتصال را پیکربندی کنید تا امکان برقراری ارتباط با فرستنده پیام دریافتی فراهم شود.
| جزئیات | |||||
|---|---|---|---|---|---|
| پارامترها |
|
||||
DNS_Options
Configuration & DNS_Options( uint8_t dnsOptions )
هنگام حل کردن نام میزبان همتا، از گزینههای ساناد مشخصشده استفاده کنید.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||
Exchange_ResponseTimeoutMsec
Configuration & Exchange_ResponseTimeoutMsec( uint32_t aResponseTimeoutMsec )
تنظیم زمان استراحت پاسخ پیشفرض برای زمینههای تبادل ایجادشده از این شیء Binding.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||
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» مشخصی ارسال و دریافت کنید.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| پارامترها |
|
||||||
| کالاهای مرجوعی |
ارجاع به شیء Binding.
|
||||||
Security_AuthenticationMode
Configuration & Security_AuthenticationMode( WeaveAuthMode aAuthMode )
حالت اصالتسنجی درخواستی را برای استفاده در اصالتسنجی همتا تنظیم کنید.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء Binding.
|
||
Security_CASESession
Configuration & Security_CASESession( void )
هنگام برقراری ارتباط با همتا، پیامهای رمزگذاریشده را بااستفاده از کلید جلسه CASE که با گره همتا ایجاد شده است ارسال و دریافت کنید.
اگر جلسه لازم دردسترس نباشد، بهطور خودکار بهعنوان بخشی از آمادهسازی اتصال برقرار خواهد شد.
| جزئیات | |
|---|---|
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
Security_EncryptionType
Configuration & Security_EncryptionType( uint8_t aEncType )
هنگام برقراری ارتباط با همتا، پیامها را بااستفاده از نوع رمزگذاری پیام مشخصشده رمزگذاری کنید و ارسال و دریافت کنید.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء Binding.
|
||
Security_Key
Configuration & Security_Key( uint32_t aKeyId )
هنگام برقراری ارتباط با همتا، پیامها را بااستفاده از کلید مشخصشده رمزگذاری و ارسال و دریافت کنید.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء Binding.
|
||
Security_None
Configuration & Security_None( void )
هنگام برقراری ارتباط با همتا، ارسال و دریافت بهصورت رمزگذارینشده (یعنی
پیامهای ناامن) را ارسال کنید.
| جزئیات | |
|---|---|
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
Security_PASESession
Configuration & Security_PASESession( uint8_t aPasswordSource )
هنگام برقراری ارتباط با همتا، پیامهای رمزگذاریشده را بااستفاده از کلید جلسه PASE که با گره همتا ایجاد شده است ارسال و دریافت کنید.
اگر جلسه لازم دردسترس نباشد، بهطور خودکار بهعنوان بخشی از آمادهسازی اتصال برقرار خواهد شد.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||
Security_SharedCASESession
Configuration & Security_SharedCASESession( void )
هنگام برقراری ارتباط با همتا، پیامهای رمزگذاریشده را بااستفاده از کلید جلسه CASE همرسانیشده که با روتر اصلی Nest ایجاد شده است ارسال و دریافت کنید.
اگر جلسه لازم دردسترس نباشد، بهطور خودکار بهعنوان بخشی از آمادهسازی اتصال برقرار خواهد شد.
| جزئیات | |
|---|---|
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
Security_SharedCASESession
Configuration & Security_SharedCASESession( uint64_t aRouterNodeId )
هنگام برقراری ارتباط با همتا، پیامهای رمزگذاریشده را بااستفاده از کلید جلسه CASE همرسانیشده که با گره مسیریاب مشخصی ایجاد شده است ارسال و دریافت کنید.
اگر جلسه لازم دردسترس نباشد، بهطور خودکار بهعنوان بخشی از آمادهسازی اتصال برقرار خواهد شد.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||
Security_TAKESession
Configuration & Security_TAKESession()
هنگام برقراری ارتباط با همتا، پیامهای رمزگذاریشده را بااستفاده از کلید جلسه TAKE که با گره همتا ایجاد شده است ارسال و دریافت کنید.
اگر جلسه لازم دردسترس نباشد، بهطور خودکار بهعنوان بخشی از آمادهسازی اتصال برقرار خواهد شد.
| جزئیات | |
|---|---|
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
TargetAddress_IP
Configuration & TargetAddress_IP( nl::Inet::IPAddress aPeerAddress, uint16_t aPeerPort, InterfaceId aInterfaceId )
هنگام برقراری ارتباط با همتا، از نشانی IP، درگاه، و میانای شبکه خاصی استفاده کنید.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| پارامترها |
|
||||||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||||||
TargetAddress_IP
Configuration & TargetAddress_IP( const char *aHostName, uint16_t aPeerPort, InterfaceId aInterfaceId )
هنگام برقراری ارتباط با همتا، از نام میزبان، درگاه، و میانای شبکه خاص استفاده کنید.
توجه: فراخواننده باید مطمئن شود که رشته نام میزبان ارائهشده تا زمان تکمیل مرحله آمادهسازی اتصال معتبر باقی میماند.
| جزئیات | |||||||
|---|---|---|---|---|---|---|---|
| پارامترها |
|
||||||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||||||
TargetAddress_IP
Configuration & TargetAddress_IP( const char *aHostName, size_t aHostNameLen, uint16_t aPeerPort, InterfaceId aInterfaceId )
هنگام برقراری ارتباط با همتا، از نام میزبان، درگاه، و میانای شبکه خاص استفاده کنید.
توجه: فراخواننده باید مطمئن شود که رشته نام میزبان ارائهشده تا زمان تکمیل مرحله آمادهسازی اتصال معتبر باقی میماند.
| جزئیات | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| پارامترها |
|
||||||||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||||||||
TargetAddress_WeaveFabric
Configuration & TargetAddress_WeaveFabric( uint16_t aSubnetId )
هنگام برقراری ارتباط با همتا، از نشانی ساختار Weave استفاده کنید که از شناسه گره همتا و زیرشبکه مشخصشده مشتق شده است.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||
TargetAddress_WeaveService
Configuration & TargetAddress_WeaveService( void )
هنگام برقراری ارتباط با همتا، از نشانی ساختار سرویس Weave که از شناسه گره همتا مشتق شده است استفاده کنید.
| جزئیات | |
|---|---|
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
Target_NodeId
Configuration & Target_NodeId( uint64_t aPeerNodeId )
اتصال را برای برقراری ارتباط با شناسه گره Weave خاصی پیکربندی کنید.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||
Target_ServiceEndpoint
Configuration & Target_ServiceEndpoint( uint64_t aPeerNodeId )
اتصال را برای برقراری ارتباط با نقطه پایانی سرویس Weave خاصی پیکربندی کنید.
اگر بهگونه دیگری پیکربندی نشده باشد، نشانی همتا روی نشانی ساختار Weave نقطه پایانی سرویس تنظیم میشود.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||
Transport_DefaultWRMPConfig
Configuration & Transport_DefaultWRMPConfig( const WRMPConfig & aWRMPConfig )
پیکربندی WRMP پیشفرض را برای زمینههای تبادل ایجادشده از این شیء Binding تنظیم کنید.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||
Transport_ExistingConnection
Configuration & Transport_ExistingConnection( WeaveConnection *apConnection )
از اتصال 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 استفاده میشود.
| جزئیات | |||
|---|---|---|---|
| پارامترها |
|
||
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|
||
Transport_UDP_WRM
Configuration & Transport_UDP_WRM( void )
هنگام برقراری ارتباط با همتا، از پروتکل Weave Reliable Messaging استفاده کنید.
| جزئیات | |
|---|---|
| کالاهای مرجوعی |
ارجاع به شیء الزامآور.
|