nl::Weave::Binding::Configuration

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

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

Özet

Bir Bağlama'yı yapılandırırken uygulamaların şu yapılandırma gruplarının her birinden en az bir yöntem çağırması gerekir: Hedef, Aktarım ve Güvenlik. Varsayılan davranışı geçersiz kılmak için gerektiğinde başka yöntemler çağrılabilir.

Ayrışık yapılandırmalar çağrılırsa (ör. Transport_TCP() ve ardından Transport_UDP()) ifade edilir.

Herkese açık işlevler

ConfigureFromMessage(const WeaveMessageInfo *aMsgInfo, const Inet::IPPacketInfo *aPacketInfo)
Alınan iletinin göndereniyle iletişime izin vermek için bağlamayı 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ğlama'yı yapılandırırken oluşan hataları döndürün.
PrepareBinding(void)
İş ortağı ile iletişim için Bağlama'yı hazırlama süreci.
Security_AppGroupKey(uint32_t aAppGroupGlobalId, uint32_t aRootKeyId, bool aUseRotatingKey)
Eşle iletişim kurarken belirli bir Weave Uygulama Grubu için şifrelenmiş iletiler gönderip alın.
Security_AuthenticationMode(WeaveAuthMode aAuthMode)
Eşin kimliğini doğrulamak için kullanılacak istenen kimlik doğrulama modunu ayarlayın.
Security_CASESession(void)
Eşle iletişim kurarken eş düğümle oluşturulan bir CASE oturum anahtarını kullanarak şifrelenmiş iletiler gönderip alın.
Security_EncryptionType(uint8_t aEncType)
Eşle iletişim kurarken belirtilen ileti şifreleme türü kullanılarak şifrelenmiş iletiler gönderip alın.
Security_Key(uint32_t aKeyId)
Eşle iletişim kurarken belirli bir anahtar kullanılarak şifrelenmiş mesajlar gönderip alın.
Security_None(void)
İş arkadaşınızla iletişim kurarken şifrelenmemiş olarak (ö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önderip alın.
Security_SharedCASESession(void)
Eşle iletişim kurarken Nest çekirdek yönlendiricide oluşturulan paylaşılan bir CASE oturum anahtarını kullanarak şifrelenmiş mesajlar gönderip alın.
Security_SharedCASESession(uint64_t aRouterNodeId)
Eşle iletişim kurarken belirli bir yönlendirici düğümüyle oluşturulmuş paylaşılan bir CASE oturum anahtarı kullanılarak şifrelenmiş iletiler gönderip alın.
Security_TAKESession()
Eşle iletişim kurarken eş düğümle oluşturulan bir TAKE oturum anahtarını kullanarak şifrelenmiş iletiler gönderip 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 ilgili 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 ilgili 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 bir alt ağdan türetilen bir Weave kumaş adresi kullanın.
TargetAddress_WeaveService(void)
Eşle iletişim kurarken eşin düğüm kimliğinden türetilen bir Weave hizmeti yapı adresini kullanın.
Target_NodeId(uint64_t aPeerNodeId)
Bağlamayı belirli bir Weave düğüm kimliğiyle iletişim kuracak şekilde yapılandırın.
Target_ServiceEndpoint(uint64_t aPeerNodeId)
Belirli bir Weave hizmeti uç noktasıyla iletişim kurmak için bağlamayı 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)
İş arkadaşınızla iletişim kurarken Weave Reliable Messaging protokolünü kullanın.

Herkese açık işlevler

ConfigureFromMessage

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

Alınan iletinin göndereniyle iletişime izin vermek için bağlamayı yapılandırın.

Ayrıntılar
Parametreler
[in] aMsgInfo
Alınan iletiyle ilişkili ileti 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ğeri. 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
Varsayılan yanıt süresi (ms).
İadeler
Bağlama nesnesine referans.

GetError

WEAVE_ERROR GetError(
  void
) const 

Bağlama'yı yapılandırırken oluşan hataları döndürün.

PrepareBinding

WEAVE_ERROR PrepareBinding(
  void
)

İş ortağı ile iletişim için Bağlama'yı hazırlama süreci.

Security_AppGroupKey

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

Eşle iletişim kurarken belirli bir Weave Uygulama Grubu için şifrelenmiş iletiler gönderip 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ı türetmek amacıyla kullanılan kök anahtar.
[in] aUseRotatingKey
Weave Application Group dönen mesaj anahtarları 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 istenen 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 bir CASE oturum anahtarını kullanarak şifrelenmiş iletiler gönderip alın.

Gerekli oturum mevcut değilse bağlama hazırlama işleminin 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ü kullanılarak şifrelenmiş iletiler gönderip alın.

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

Security_Key

Configuration & Security_Key(
  uint32_t aKeyId
)

Eşle iletişim kurarken belirli bir anahtar kullanılarak şifrelenmiş mesajlar gönderip alın.

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

Security_None

Configuration & Security_None(
  void
)

İş arkadaşınızla iletişim kurarken şifrelenmemiş olarak (ör.

güvenli olmayan) iletileri için geçerlidir.

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önderip alın.

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

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

Security_SharedCASESession

Configuration & Security_SharedCASESession(
  void
)

Eşle iletişim kurarken Nest çekirdek yönlendiricide oluşturulan paylaşılan bir CASE oturum anahtarını kullanarak şifrelenmiş mesajlar gönderip alın.

Gerekli oturum mevcut değilse bağlama hazırlama işleminin 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 belirli bir yönlendirici düğümüyle oluşturulmuş paylaşılan bir CASE oturum anahtarı kullanılarak şifrelenmiş iletiler gönderip alın.

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

Ayrıntılar
Parametreler
[in] aRouterNodeId
Paylaşılan CASE oturumunun oluşturulması 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 bir TAKE oturum anahtarını kullanarak şifrelenmiş iletiler gönderip alın.

Gerekli oturum mevcut değilse bağlama hazırlama işleminin 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 ilgili ana makine adını, bağlantı noktasını ve ağ arayüzünü kullanın.

NOT: Çağrıyı yapan, bağlama hazırlama aşaması tamamlanana kadar, sağlanan ana makine adı dizesinin geçerli kalmasını sağlamalıdır.

Ayrıntılar
Parametreler
[in] aHostName
Eşin ana makine adını içeren NULL sonlu 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 ilgili ana makine adını, bağlantı noktasını ve ağ arayüzünü kullanın.

NOT: Çağrıyı yapan, bağlama hazırlama aşaması tamamlanana kadar, sağlanan ana makine adı dizesinin geçerli kalmasını sağlamalıdır.

Ayrıntılar
Parametreler
[in] aHostName
Eşin ana makine adını içeren bir dize. Bu dizenin NULL sonlu olması gerekmez.
[in] aHostNameLen
aHostName tarafından gösterilen 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 bir alt ağdan türetilen bir Weave kumaş adresi kullanın.

Ayrıntılar
Parametreler
[in] aSubnetId
Eşin Weave kumaş adresini oluştururken 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 hizmeti yapı adresini kullanın.

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

Target_NodeId

Configuration & Target_NodeId(
  uint64_t aPeerNodeId
)

Bağlamayı 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
)

Belirli bir Weave hizmeti uç noktasıyla iletişim kurmak için bağlamayı yapılandırın.

Aksi takdirde eş adresi, hizmet uç noktasının Weave yapısı 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 işlemi başarılı olduğunda bağlantı nesnesindeki referans sayısı artar. Dolayısıyla, bağlantı nesnesinin o zamana kadar aktif kalmasını sağlamaktan uygulama 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
)

İş arkadaşınızla iletişim kurarken Weave Reliable Messaging protokolünü kullanın.

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