nl::Weave::Binding::Configuration

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

Binding nesnesini yapılandırmak ve hazırlamak için bildirim temelli bir arayüz sağlar.

Özet

Bir Binding yapılandırırken uygulamalar şu yapılandırma gruplarının her birinden en az bir yöntem çağırmalıdır: Target (Target), Transport (Aktarma) ve Security. Varsayılan davranışı geçersiz kılmak için gerektiğinde başka yöntemler çağrılabilir.

Birlikte kullanılamayan yapılandırmalar çağrılırsa (ör. Transport_TCP() ve ardından Transport_UDP()) çağrılır ve kazanır.

Kamu işlevleri
ConfigureFromMessage(const WeaveMessageInfo *aMsgInfo, const Inet::IPPacketInfo *aPacketInfo)
Bağlantıyı, alınan iletiyi gönderenle iletişime izin verecek şekilde yapılandırın.
DNS_Options(uint8_t dnsOptions)
Eşin ana makine adını çözümlerken, belirtilen DNS seçeneklerini kullanın.
Exchange_ResponseTimeoutMsec(uint32_t aResponseTimeoutMsec)
Bu Binding nesnesinden oluşturulan exchange bağlamları için varsayılan yanıt zaman aşımını ayarlayın.
GetError(void) const
Bağlayıcı yapılandırılırken oluşan hataları döndürün.
PrepareBinding(void)
Emsal ile iletişim için Bağlayıcı'yı hazırlama sürecidir.
Security_AppGroupKey(uint32_t aAppGroupGlobalId, uint32_t aRootKeyId, bool aUseRotatingKey)
Eşinizle iletişim kurarken, belirli bir Weave Uygulama Grubu için şifrelenmiş iletiler gönderin ve alın.
Security_AuthenticationMode(WeaveAuthMode aAuthMode)
Eşin kimliğini doğrulamak için kullanılacak kimlik doğrulama modunu ayarlayın.
Security_CASESession(void)
Eşle iletişim kurarken, eş düğümle oluşturulan CASE oturum anahtarı kullanılarak şifrelenmiş iletiler gönderin ve alın.
Security_EncryptionType(uint8_t aEncType)
Eşle iletişim kurarken, belirtilen ileti şifreleme türünü kullanarak şifrelenmiş iletiler gönderin ve alın.
Security_Key(uint32_t aKeyId)
Eşle iletişim kurarken belirli bir anahtarı kullanarak şifrelenmiş iletiler gönderin ve alın.
Security_None(void)
Eşle iletişim kurarken şifrelenmemiş olarak gönderin ve alın (ör.
Security_PASESession(uint8_t aPasswordSource)
Eşle iletişim kurarken, eş düğümle oluşturulan bir PASE oturum anahtarı kullanılarak şifrelenmiş iletiler gönderin ve alın.
Security_SharedCASESession(void)
Eşle iletişim kurarken Nest Core yönlendiriciyle oluşturulan paylaşılan bir CASE oturum anahtarı kullanarak şifrelenmiş mesajlar gönderin ve alın.
Security_SharedCASESession(uint64_t aRouterNodeId)
Eşle iletişim kurarken, belirtilen yönlendirici düğümüyle oluşturulan paylaşılan bir CASE oturum anahtarı kullanılarak şifrelenmiş iletiler gönderin ve alın.
Security_TAKESession()
Eşle iletişim kurarken, eş düğümle oluşturulan Take oturum anahtarı kullanılarak şifrelenmiş iletiler gönderin ve alın.
TargetAddress_IP(nl::Inet::IPAddress aPeerAddress, uint16_t aPeerPort, InterfaceId aInterfaceId)
Eşle iletişim kurarken spesifik IP adresini, bağlantı noktasını ve ağ arayüzünü kullanın.
TargetAddress_IP(const char *aHostName, uint16_t aPeerPort, InterfaceId aInterfaceId)
Eşle iletişim kurarken özel ana makine adını, bağlantı noktasını ve ağ arayüzünü kullanın.
TargetAddress_IP(const char *aHostName, size_t aHostNameLen, uint16_t aPeerPort, InterfaceId aInterfaceId)
Eşle iletişim kurarken özel ana makine adını, bağlantı noktasını ve ağ arayüzünü kullanın.
TargetAddress_WeaveFabric(uint16_t aSubnetId)
Eşle iletişim kurarken eşin düğüm kimliğinden ve belirtilen alt ağdan türetilen Weave yapı adresini kullanın.
TargetAddress_WeaveService(void)
Eşle iletişim kurarken eşin düğüm kimliğinden türetilen bir Weave hizmet yapı adresi kullanın.
Target_NodeId(uint64_t aPeerNodeId)
Bağlantıyı belirli bir Weave düğüm kimliğiyle iletişim kuracak şekilde yapılandırın.
Target_ServiceEndpoint(uint64_t aPeerNodeId)
Bağlantıyı belirli bir Weave hizmet uç noktasıyla iletişim kuracak şekilde yapılandırın.
Transport_DefaultWRMPConfig(const WRMPConfig & aWRMPConfig)
Bu Binding nesnesinden oluşturulan exchange bağlamları için varsayılan WRMP yapılandırmasını ayarlayın.
Transport_ExistingConnection(WeaveConnection *apConnection)
Eşle iletişim kurmak için mevcut bir Weave bağlantısını kullanın.
Transport_TCP(void)
Eşle iletişim kurmak için TCP'yi kullanın.
Transport_UDP(void)
Eşle iletişim kurmak için UDP'yi kullanın.
Transport_UDP_PathMTU(uint32_t aPathMTU)
Eşe giden UDP paketleri için beklenen MTU yolunu ayarlayın.
Transport_UDP_WRM(void)
Eşle iletişim kurarken Weave Reliable Messaging protokolünü kullanın.

Kamu işlevleri

ConfigureFromMessage

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

Bağlantıyı, alınan iletiyi gönderenle iletişime izin verecek şekilde yapılandırın.

Ayrıntılar
Parametreler
[in] aMsgInfo
Alınan mesajla ilişkili mesaj bilgileri yapısı.
[in] aPacketInfo
Alınan iletinin paket bilgileri.

DNS_Options

Configuration & DNS_Options(
  uint8_t dnsOptions
)

Eşin ana makine adını çözümlerken, belirtilen DNS seçeneklerini kullanın.

Ayrıntılar
Parametreler
[in] dnsOptions
Ana makine adı çözümlemesinin nasıl gerçekleştirileceğini kontrol eden bir tam sayı değeridir. Değer, #::nl::Inet::DNSOptions numaralandırmasındaki değerlerden biri olmalıdır.
İadeler
Bağlama nesnesine referans.

Exchange_ResponseTimeoutMsec

Configuration & Exchange_ResponseTimeoutMsec(
  uint32_t aResponseTimeoutMsec
)

Bu Binding nesnesinden oluşturulan exchange bağlamları için varsayılan yanıt zaman aşımını ayarlayın.

Ayrıntılar
Parametreler
[in] aResponseTimeoutMsec
ms cinsinden varsayılan yanıt süresi.
İadeler
Bağlama nesnesine referans.

GetError

WEAVE_ERROR GetError(
  void
) const

Bağlayıcı yapılandırılırken oluşan hataları döndürün.

PrepareBinding

WEAVE_ERROR PrepareBinding(
  void
)

Emsal ile iletişim için Bağlayıcı'yı hazırlama sürecidir.

Security_AppGroupKey

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

Eşinizle iletişim kurarken, belirli bir Weave Uygulama Grubu için şifrelenmiş iletiler gönderin ve alın.

Ayrıntılar
Parametreler
[in] aAppGroupGlobalId
İletilerin şifrelenmesi gereken uygulama grubunun genel kimliği.
[in] aRootKeyId
Belirtilen Weave Uygulama Grubu için şifreleme anahtarlarını türetmek üzere kullanılan kök anahtar.
[in] aUseRotatingKey
Weave Application Group dönen mesaj tuşları kullanıyorsa doğru değerini alır.
İadeler
Binding nesnesine referans.

Security_AuthenticationMode

Configuration & Security_AuthenticationMode(
  WeaveAuthMode aAuthMode
)

Eşin kimliğini doğrulamak için kullanılacak kimlik doğrulama modunu ayarlayın.

Ayrıntılar
Parametreler
[in] aAuthMode
İstenen kimlik doğrulama modu.
İadeler
Binding nesnesine referans.

Security_CASESession

Configuration & Security_CASESession(
  void
)

Eşle iletişim kurarken, eş düğümle oluşturulan CASE oturum anahtarı kullanılarak şifrelenmiş iletiler gönderin ve alın.

Gerekli oturum mevcut değilse bağlama hazırlama sürecinin bir parçası olarak otomatik olarak oluşturulur.

Ayrıntılar
İadeler
Bağlama nesnesine referans.

Security_EncryptionType

Configuration & Security_EncryptionType(
  uint8_t aEncType
)

Eşle iletişim kurarken, belirtilen ileti şifreleme türünü kullanarak şifrelenmiş iletiler gönderin ve alın.

Ayrıntılar
Parametreler
[in] aEncType
Weave mesaj şifreleme türü.
İadeler
Binding nesnesine referans.

Security_Key

Configuration & Security_Key(
  uint32_t aKeyId
)

Eşle iletişim kurarken belirli bir anahtarı kullanarak şifrelenmiş iletiler gönderin ve alın.

Ayrıntılar
Parametreler
[in] aKeyId
Şifreleme anahtarının kimliği. Belirtilen anahtar, Weave mesaj şifrelemesine uygun olmalıdır.
İadeler
Binding nesnesine referans.

Security_None

Configuration & Security_None(
  void
)

Eşle iletişim kurarken şifrelenmemiş olarak gönderin ve alın (ör.

güvenli olmayan) iletiler alırsınız.

Ayrıntılar
İadeler
Bağlama nesnesine referans.

Security_PASESession

Configuration & Security_PASESession(
  uint8_t aPasswordSource
)

Eşle iletişim kurarken, eş düğümle oluşturulan bir PASE oturum anahtarı kullanılarak şifrelenmiş iletiler gönderin ve alın.

Gerekli oturum mevcut değilse bağlama hazırlama sürecinin bir parçası olarak otomatik olarak oluşturulur.

Ayrıntılar
Parametreler
[in] aPasswordSource
PASE oturumu oluşturulurken kullanılacak şifrenin kaynağı.
İadeler
Bağlama nesnesine referans.

Security_SharedCASESession

Configuration & Security_SharedCASESession(
  void
)

Eşle iletişim kurarken Nest Core yönlendiriciyle oluşturulan paylaşılan bir CASE oturum anahtarı kullanarak şifrelenmiş mesajlar gönderin ve alın.

Gerekli oturum mevcut değilse bağlama hazırlama sürecinin bir parçası olarak otomatik olarak oluşturulur.

Ayrıntılar
İadeler
Bağlama nesnesine referans.

Security_SharedCASESession

Configuration & Security_SharedCASESession(
  uint64_t aRouterNodeId
)

Eşle iletişim kurarken, belirtilen yönlendirici düğümüyle oluşturulan paylaşılan bir CASE oturum anahtarı kullanılarak şifrelenmiş iletiler gönderin ve alın.

Gerekli oturum mevcut değilse bağlama hazırlama sürecinin bir parçası olarak otomatik olarak oluşturulur.

Ayrıntılar
Parametreler
[in] aRouterNodeId
Paylaşılan CASE oturumunun kurulması gereken yönlendiricinin Weave düğüm kimliği.
İadeler
Bağlama nesnesine referans.

Security_TAKESession

Configuration & Security_TAKESession()

Eşle iletişim kurarken, eş düğümle oluşturulan Take oturum anahtarı kullanılarak şifrelenmiş iletiler gönderin ve alın.

Gerekli oturum mevcut değilse bağlama hazırlama sürecinin bir parçası olarak otomatik olarak oluşturulur.

Ayrıntılar
İadeler
Bağlama nesnesine referans.

TargetAddress_IP

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

Eşle iletişim kurarken spesifik IP adresini, bağlantı noktasını ve ağ arayüzünü kullanın.

Ayrıntılar
Parametreler
[in] aPeerAddress
Eşin IP adresi
[in] aPeerPort
Uzak bağlantı noktası
[in] aInterfaceId
İletişim için kullanılacak yerel ağ arayüzünün kimliği
İadeler
Bağlama nesnesine referans.

TargetAddress_IP

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

Eşle iletişim kurarken özel ana makine adını, bağlantı noktasını ve ağ arayüzünü kullanın.

NOT: Arayan, sağlanan ana makine adı dizesinin, bağlama hazırlığı aşaması tamamlanana kadar geçerli olduğundan emin olmalıdır.

Ayrıntılar
Parametreler
[in] aHostName
Eşin ana makine adını içeren NULL sonlandırılmış bir dize.
[in] aPeerPort
Eşle iletişim kurarken kullanılacak uzak bağlantı noktası.
[in] aInterfaceId
İletişim için kullanılacak yerel ağ arayüzünün kimliği.
İadeler
Bağlama nesnesine referans.

TargetAddress_IP

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

Eşle iletişim kurarken özel ana makine adını, bağlantı noktasını ve ağ arayüzünü kullanın.

NOT: Arayan, sağlanan ana makine adı dizesinin, bağlama hazırlığı aşaması tamamlanana kadar geçerli olduğundan emin olmalıdır.

Ayrıntılar
Parametreler
[in] aHostName
Eşin ana makine adını içeren bir dize. Bu dizenin NULL sonlandırılması gerekmez.
[in] aHostNameLen
aHostName tarafından işaret edilen dizenin uzunluğu.
[in] aPeerPort
Eşle iletişim kurarken kullanılacak uzak bağlantı noktası.
[in] aInterfaceId
İletişim için kullanılacak yerel ağ arayüzünün kimliği.
İadeler
Bağlama nesnesine referans.

TargetAddress_WeaveFabric

Configuration & TargetAddress_WeaveFabric(
  uint16_t aSubnetId
)

Eşle iletişim kurarken eşin düğüm kimliğinden ve belirtilen alt ağdan türetilen Weave yapı adresini kullanın.

Ayrıntılar
Parametreler
[in] aSubnetId
Eşin Weave kumaş adresini oluşturmada kullanılacak alt ağ kimliği.
İadeler
Bağlama nesnesine referans.

TargetAddress_WeaveService

Configuration & TargetAddress_WeaveService(
  void
)

Eşle iletişim kurarken eşin düğüm kimliğinden türetilen bir Weave hizmet yapı adresi kullanın.

Ayrıntılar
İadeler
Bağlama nesnesine referans.

Target_NodeId

Configuration & Target_NodeId(
  uint64_t aPeerNodeId
)

Bağlantıyı belirli bir Weave düğüm kimliğiyle iletişim kuracak şekilde yapılandırın.

Ayrıntılar
Parametreler
[in] aPeerNodeId
Eş düğümün düğüm kimliği.
İadeler
Bağlama nesnesine referans.

Target_ServiceEndpoint

Configuration & Target_ServiceEndpoint(
  uint64_t aPeerNodeId
)

Bağlantıyı belirli bir Weave hizmet uç noktasıyla iletişim kuracak şekilde yapılandırın.

Aksi şekilde yapılandırılmamışsa eş adresi, hizmet uç noktasının Weave yapı adresine ayarlanır.

Ayrıntılar
Parametreler
[in] serviceEndpointId
İletişimin gerçekleşeceği hizmet uç noktasının düğüm kimliği.
İadeler
Bağlama nesnesine referans.

Transport_DefaultWRMPConfig

Configuration & Transport_DefaultWRMPConfig(
  const WRMPConfig & aWRMPConfig
)

Bu Binding nesnesinden oluşturulan exchange bağlamları için varsayılan WRMP yapılandırmasını ayarlayın.

Ayrıntılar
Parametreler
[in] aWRMPConfig
Yeni varsayılan WRMP yapılandırmasına referans.
İadeler
Bağlama nesnesine referans.

Transport_ExistingConnection

Configuration & Transport_ExistingConnection(
  WeaveConnection *apConnection
)

Eşle iletişim kurmak için mevcut bir Weave bağlantısını kullanın.

NOT: Bağlama hazırlığı başarılı olduğunda bağlantı nesnesindeki referans sayısı artar. Bu yüzden uygulama, bağlantı nesnesinin bu zamana kadar aktif kalmasını sağlamaktan sorumludur.

Ayrıntılar
Parametreler
[in] con
Mevcut Weave bağlantısına işaret eder.
İadeler
Bağlama nesnesine referans.

Transport_TCP

Configuration & Transport_TCP(
  void
)

Eşle iletişim kurmak için TCP'yi kullanın.

Ayrıntılar
İadeler
Bağlama nesnesine referans.

Transport_UDP

Configuration & Transport_UDP(
  void
)

Eşle iletişim kurmak için UDP'yi kullanın.

Ayrıntılar
İadeler
Bağlama nesnesine referans.

Transport_UDP_PathMTU

Configuration & Transport_UDP_PathMTU(
  uint32_t aPathMTU
)

Eşe giden UDP paketleri için beklenen MTU yolunu ayarlayın.

Bazı Weave protokollerinde bu, Weave mesaj yükü boyutunu dinamik olarak ayarlamak için kullanılır.

Ayrıntılar
Parametreler
[in] aPathMTU
Eşe giden UDP paketleri için beklenen MTU yolu.
İadeler
Bağlama nesnesine referans.

Transport_UDP_WRM

Configuration & Transport_UDP_WRM(
  void
)

Eşle iletişim kurarken Weave Reliable Messaging protokolünü kullanın.

Ayrıntılar
İadeler
Bağlama nesnesine referans.