nl:: örgü:: Örgü Bağlantısı
#include <src/lib/core/WeaveMessageLayer.h>
Weave Connection sınıfının tanımı.
özet
Başka bir Weave düğümüne bir TCP veya BLE bağlantısını temsil eder.
Genel türler | |
---|---|
@58 { | Sıralama |
ConnectionClosedFunct )(WeaveConnection *con, WEAVE_ERROR conErr) | typedefvoid(* Bu işlev, bir bağlantı kapatıldığında çağrılan uygulama geri çağrısıdır. |
ConnectionCompleteFunct )(WeaveConnection *con, WEAVE_ERROR conErr) | typedefvoid(* Bu işlev, bir bağlantı kurulumu tamamlandığında çağrılan uygulama geri çağrısıdır. |
MessageReceiveFunct )(WeaveConnection *con, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | typedefvoid(* Bu işlev, bir Weave bağlantısı üzerinden bir mesaj alındığında çağrılan uygulama geri çağrısıdır. |
NetworkType { | Sıralama Örgü bağlantı nesnesinin ağ türü. |
ReceiveErrorFunct )(WeaveConnection *con, WEAVE_ERROR err) | typedefvoid(* Bu işlev, bir Weave mesajı alınırken bir hatayla karşılaşıldığında çağrılan uygulama geri çağrısıdır. |
State { | Sıralama Örgü bağlantı nesnesinin durumu. |
TunneledMsgReceiveFunct )(WeaveConnection *con, const WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | typedefvoid(* Bu işlev, Weave bağlantısı üzerinden Tünellenmiş bir veri paketinin alınması üzerine çağrılan uygulama geri çağrısıdır. |
Genel özellikler | |
---|---|
AppState | void * Uygulamaya özel durum nesnesine yönelik bir işaretçi. |
AuthMode | WeaveAuthMode [SADECE OKUYUN] Bağlantı için varsayılan şifreleme anahtarlarını oluşturmak için kullanılan kimlik doğrulama modu. |
DefaultEncryptionType | uint8_t Mesajlar için varsayılan şifreleme türü. |
DefaultKeyId | uint16_t Mesaj gönderirken kullanılacak varsayılan şifreleme anahtarı. |
MessageLayer | [SALT] ilişkili WeaveMessageLayer nesnesi. |
NetworkType | uint8_t [SADECE OKUYUN] İlişkili bitiş noktasının ağ türü. |
OnConnectionClosed | |
OnConnectionComplete | |
OnMessageReceived | |
OnReceiveError | |
OnTunneledMessageReceived | |
PeerAddr | IPAddress [SADECE OKUYUN] Eş düğümün IP adresi. |
PeerNodeId | uint64_t [SADECE OKUYUN] Eşin düğüm tanımlayıcısı. |
PeerPort | uint16_t [SADECE OKUYUN] Eş düğümün bağlantı noktası numarası. |
ReceiveEnabled | bool [SADECE OKUYUN] Alma etkinse doğru, değilse yanlış. |
SendDestNodeId | bool Bu bağlantı aracılığıyla gönderilen tüm iletilerin açıkça kodlanmış bir hedef düğüm tanımlayıcısı içermesi gerekiyorsa doğru, aksi takdirde yanlış. |
SendSourceNodeId | bool Bu bağlantı aracılığıyla gönderilen tüm iletilerin açıkça kodlanmış bir kaynak düğüm tanımlayıcısı içermesi gerekiyorsa doğru, aksi takdirde yanlış. |
State | uint8_t [Salt okunur] Durum WeaveConnection nesne. |
Kamu işlevleri | |
---|---|
Abort (void) | void Gerçekleştirir TCP- veya BLE tabanlı bir un-zarif yakın WeaveConnection veya emsalden uçuşta olabilecek herhangi bir veri atma. |
AddRef (void) | void Bir referans rezerve WeaveConnection nesne. |
Close (void) | Gerçekleştirir TCP- veya BLE tabanlı olmayan bir engelleme zarif yakın WeaveConnection önce kibarca biz bağlantıyı sıfırlamak olduğunu uzak ana bildiren kalan giden veriyi teslim. |
Close (bool suppressCloseLog) | Gerçekleştirir TCP- veya BLE tabanlı olmayan bir engelleme zarif yakın WeaveConnection önce kibarca biz bağlantıyı sıfırlamak olduğunu uzak ana bildiren kalan giden veriyi teslim. |
Connect (uint64_t peerNodeId) | Belirtilen düğüm tanımlayıcısından türetilen bir yapı IP adresi kullanarak bir Örgü düğümüne bağlanın. |
Connect (uint64_t peerNodeId, const IPAddress & peerAddr, uint16_t peerPort) | Bir düğüm tanımlayıcısı ve/veya bir IP adresi kullanarak bir Örgü düğümüne bağlanın. |
Connect (uint64_t peerNodeId, WeaveAuthMode authMode, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId intf) | Belirli bir arabirimde bir düğüm tanımlayıcısı ve/veya bir IP adresi kullanarak bir Örgü düğümüne bağlanın. |
Connect (uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t defaultPort) | Bir düğüm tanımlayıcısı ve/veya bir dizi ana bilgisayar adı kullanarak bir Örgü düğümüne bağlanın. |
Connect (uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint16_t defaultPort) | Bir düğüm tanımlayıcısı ve/veya bir dize eş adresi kullanarak bir Örgü düğümüne bağlanın. |
Connect (uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint8_t dnsOptions, uint16_t defaultPort) | Bir düğüm tanımlayıcısı ve/veya bir dize eş adresi kullanarak bir Örgü düğümüne bağlanın. |
Connect (uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, InterfaceId intf) | Bir düğüm tanımlayıcısı ve/veya bir ana bilgisayar adı ve bağlantı noktası listesi kullanarak bir Örgü düğümüne bağlanın. |
Connect (uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, uint8_t dnsOptions, InterfaceId intf) | Bir düğüm tanımlayıcısı ve/veya bir ana bilgisayar adı ve bağlantı noktası listesi kullanarak bir Örgü düğümüne bağlanın. |
DisableKeepAlive (void) | |
DisableReceive (void) | void Bu aşkın devre dışı bırak alıcı WeaveConnection . |
EnableKeepAlive (uint16_t interval, uint16_t timeoutCount) | |
EnableReceive (void) | void Bu aşkın aldıktan etkinleştirme WeaveConnection . |
GetPeerAddressInfo (IPPacketInfo & addrInfo) | Eşin IP adresi bilgilerini alın. |
GetPeerDescription (char *buf, size_t bufSize) const | void Bağlantıyla ilişkili eş düğümü açıklayan bir dize oluşturur. |
GetTCPEndPoint (void) const | TCPEndPoint * |
IsIncoming (void) const | bool |
LogId (void) const | uint16_t |
Release (void) | void Referans sayısı azaltma WeaveConnection nesne. |
ResetUserTimeout (void) | |
SendMessage ( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | Kurulan bir bağlantı üzerinden bir Örgü mesajı gönderin. |
SendTunneledMessage ( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) | Bir Örgü bağlantısı üzerinden Tünelli paket gönderme işlevi. |
SetConnectTimeout (const uint32_t connTimeoutMsecs) | void Connect'in başarılı olması veya bir hata döndürmesi için zaman aşımını ayarlayın. |
SetIdleTimeout (uint32_t timeoutMS) | Temel ağ katmanı bağlantısında boşta kalma zaman aşımını ayarlayın. |
SetIncoming (bool val) | void |
SetUserTimeout (uint32_t userTimeoutMillis) | |
Shutdown (void) | Tüm giden verilerin eşin TCP yığını tarafından gönderilip alınmasını sağlayarak zarif bir TCP gönderme kapatması gerçekleştirir. |
Genel türler
@58
@58
Özellikleri | |
---|---|
kGetPeerDescription_MaxLength | Tarafından döndürülen (boş karakter dahil) dize maksimum uzunluğu GetPeerDescription () . |
BağlantıKapalıFonksiyon
void(* ConnectionClosedFunct)(WeaveConnection *con, WEAVE_ERROR conErr)
Bu işlev, bir bağlantı kapatıldığında çağrılan uygulama geri çağrısıdır.
Ayrıntılar | |||||
---|---|---|---|---|---|
parametreler |
|
BağlantıTamamlandıİşlev
void(* ConnectionCompleteFunct)(WeaveConnection *con, WEAVE_ERROR conErr)
Bu işlev, bir bağlantı kurulumu tamamlandığında çağrılan uygulama geri çağrısıdır.
Ayrıntılar | |||||
---|---|---|---|---|---|
parametreler |
|
MesajAlmaFonksiyonu
void(* MessageReceiveFunct)(WeaveConnection *con, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Bu işlev, bir Weave bağlantısı üzerinden bir mesaj alındığında çağrılan uygulama geri çağrısıdır.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
parametreler |
|
Ağ tipi
NetworkType
ReceiveErrorFunct
void(* ReceiveErrorFunct)(WeaveConnection *con, WEAVE_ERROR err)
Bu işlev, bir Weave mesajı alınırken bir hatayla karşılaşıldığında çağrılan uygulama geri çağrısıdır.
Ayrıntılar | |||||
---|---|---|---|---|---|
parametreler |
|
Durum
State
Örgü bağlantı nesnesinin durumu.
TünelliMsgReceiveFunct
void(* TunneledMsgReceiveFunct)(WeaveConnection *con, const WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Bu işlev, Weave bağlantısı üzerinden Tünellenmiş bir veri paketinin alınması üzerine çağrılan uygulama geri çağrısıdır.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
parametreler |
|
Genel özellikler
Uygulama Durumu
void * AppState
Uygulamaya özel durum nesnesine yönelik bir işaretçi.
Yetkilendirme Modu
WeaveAuthMode AuthMode
[SADECE OKUYUN] Bağlantı için varsayılan şifreleme anahtarlarını oluşturmak için kullanılan kimlik doğrulama modu.
Varsayılan Şifreleme Türü
uint8_t DefaultEncryptionType
Mesajlar için varsayılan şifreleme türü.
VarsayılanAnahtarKimliği
uint16_t DefaultKeyId
Mesaj gönderirken kullanılacak varsayılan şifreleme anahtarı.
Ağ tipi
uint8_t NetworkType
[SADECE OKUYUN] İlişkili bitiş noktasının ağ türü.
OnConnectionKapalı
ConnectionClosedFunct OnConnectionClosed
OnConnectionComplete
ConnectionCompleteFunct OnConnectionComplete
Mesaj Alındığında
MessageReceiveFunct OnMessageReceived
OnReceiveError
ReceiveErrorFunct OnReceiveError
OnTunneledMesaj Alındı
TunneledMsgReceiveFunct OnTunneledMessageReceived
PeerAddr
IPAddress PeerAddr
[SADECE OKUYUN] Eş düğümün IP adresi.
PeerNodeId
uint64_t PeerNodeId
[SADECE OKUYUN] Eşin düğüm tanımlayıcısı.
PeerPort
uint16_t PeerPort
[SADECE OKUYUN] Eş düğümün bağlantı noktası numarası.
Alma Etkin
bool ReceiveEnabled
[SADECE OKUYUN] Alma etkinse doğru, değilse yanlış.
SendDestNodeId
bool SendDestNodeId
Bu bağlantı aracılığıyla gönderilen tüm iletilerin açıkça kodlanmış bir hedef düğüm tanımlayıcısı içermesi gerekiyorsa doğru, aksi takdirde yanlış.
SendSourceNodeId
bool SendSourceNodeId
Bu bağlantı aracılığıyla gönderilen tüm iletilerin açıkça kodlanmış bir kaynak düğüm tanımlayıcısı içermesi gerekiyorsa doğru, aksi takdirde yanlış.
Kamu işlevleri
iptal
void Abort( void )
Gerçekleştirir TCP- veya BLE tabanlı bir un-zarif yakın WeaveConnection veya emsalden uçuşta olabilecek herhangi bir veri atma.
Bir çağrı Abort () hemen altında yatan bağlantıyı sonlandırır. Bu noktadan sonra, WeaveConnection nesne artık daha fazla iletişim için kullanılabilir.
Arayan Abort () ile bağlantılı başvuru sayısı azaltır WeaveConnection bağlantı açık / etken yöntemi denir zamanda olup olmadığını, bir nesne. Bu, referans sayısının sıfıra ulaşmasıyla sonuçlanırsa, bağlantı nesnesiyle ilişkili kaynaklar serbest bırakılır. Bu olduğunda, uygulamanın nesneyle başka bir etkileşimi olmamalıdır.
Ayrıca bakınız:Kapatma () , İptal () , AddRef () ve Release () .
Referans Ekle
void AddRef( void )
Bir referans rezerve WeaveConnection nesne.
AddRef () metodu artışlarla ilişkili başvuru sayısı WeaveConnection nesne. Her çağrı için AddRef () , uygulama birine karşılık gelen bir arama yapmadan sorumludur Yayın () , Kapat () veya İptal () .
Kapat
WEAVE_ERROR Close( void )
Gerçekleştirir TCP- veya BLE tabanlı olmayan bir engelleme zarif yakın WeaveConnection önce kibarca biz bağlantıyı sıfırlamak olduğunu uzak ana bildiren kalan giden veriyi teslim.
Bu yöntem, uygulama protokolü düzeyinde onaylanmayan herhangi bir giden mesajın uzak eş tarafından alındığına dair güçlü bir garanti sağlamaz. Hem TCP hem de BLE için, temel protokol yığını, bağlantıyı sıfırlamadan önce bekleyen giden verileri teslim etmek için en iyi çabayı gösterecektir. TCP için, Kapatma () önce kullanılmalıdır Close () bir nakil katmanlı mesajı alındı teyit bağlantıyı kapatmadan önce gerekiyorsa. BLE bağlantılar bir sağlamak Kapatma () eşdeğeri.
BLE tabanlı bağlantıları için, yakın () kapatır WeaveConnection anında ve döner, ancak tüm giden veri gönderilene kadar Linger altta yatan BLEEndPoint nesnesi neden olabilir. Bu, Weave BleLayer'da bulunan Weave over BLE taşıma protokolü uygulamasının bir yan etkisidir.
Bir kez yakın () olarak adlandırılmıştır, WeaveConnection nesne artık daha fazla iletişim için kullanılabilir.
Arayan ) (yakın ilişkili başvuru sayısı azaltır WeaveConnection bağlantı açık / etken yöntemi denir zamanda olup olmadığını, bir nesne. Bu, referans sayısının sıfıra ulaşmasıyla sonuçlanırsa, bağlantı nesnesiyle ilişkili kaynaklar serbest bırakılır. Bu olduğunda, uygulamanın nesneyle başka bir etkileşimi olmamalıdır.
Ayrıntılar | |
---|---|
İadeler | WEAVE_NO_ERROR koşulsuz. |
Kapatma () , İptal () , AddRef () ve Release () .
Kapat
WEAVE_ERROR Close( bool suppressCloseLog )
Gerçekleştirir TCP- veya BLE tabanlı olmayan bir engelleme zarif yakın WeaveConnection önce kibarca biz bağlantıyı sıfırlamak olduğunu uzak ana bildiren kalan giden veriyi teslim.
Bu yöntem, uygulama protokolü düzeyinde onaylanmayan herhangi bir giden mesajın uzak eş tarafından alındığına dair güçlü bir garanti sağlamaz. Hem TCP hem de BLE için, temel protokol yığını, bağlantıyı sıfırlamadan önce bekleyen giden verileri teslim etmek için en iyi çabayı gösterecektir. TCP için, Kapatma () önce kullanılmalıdır Close () bir nakil katmanlı mesajı alındı teyit bağlantıyı kapatmadan önce gerekiyorsa. BLE bağlantılar bir sağlamak Kapatma () eşdeğeri.
BLE tabanlı bağlantıları için, yakın () kapatır WeaveConnection anında ve döner, ancak tüm giden veri gönderilene kadar Linger altta yatan BLEEndPoint nesnesi neden olabilir. Bu, Weave BleLayer'da bulunan Weave over BLE taşıma protokolü uygulamasının bir yan etkisidir.
Bir kez yakın () olarak adlandırılmıştır, WeaveConnection nesne artık daha fazla iletişim için kullanılabilir.
Arayan ) (yakın ilişkili başvuru sayısı azaltır WeaveConnection bağlantı açık / etken yöntemi denir zamanda olup olmadığını, bir nesne. Bu, referans sayısının sıfıra ulaşmasıyla sonuçlanırsa, bağlantı nesnesiyle ilişkili kaynaklar serbest bırakılır. Bu olduğunda, uygulamanın nesneyle başka bir etkileşimi olmamalıdır.
Ayrıntılar | |||
---|---|---|---|
parametreler |
| ||
İadeler | WEAVE_NO_ERROR koşulsuz. |
Kapatma () , İptal () , AddRef () ve Release () .
Bağlan
WEAVE_ERROR Connect( uint64_t peerNodeId )
Belirtilen düğüm tanımlayıcısından türetilen bir yapı IP adresi kullanarak bir Örgü düğümüne bağlanın.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
parametreler |
| ||||||||||
Dönüş Değerleri |
|
Bağlan
WEAVE_ERROR Connect( uint64_t peerNodeId, const IPAddress & peerAddr, uint16_t peerPort )
Bir düğüm tanımlayıcısı ve/veya bir IP adresi kullanarak bir Örgü düğümüne bağlanın.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
parametreler |
| ||||||||||
Dönüş Değerleri |
|
Bağlan
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId intf )
Belirli bir arabirimde bir düğüm tanımlayıcısı ve/veya bir IP adresi kullanarak bir Örgü düğümüne bağlanın.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
parametreler |
| ||||||||||
Dönüş Değerleri |
|
Bağlan
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t defaultPort )
Bir düğüm tanımlayıcısı ve/veya bir dizi ana bilgisayar adı kullanarak bir Örgü düğümüne bağlanın.
: Tedarik edilirse, peerAddr herhangi biri olabilir
: : [ ]:
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
parametreler |
| ||||||||||
Dönüş Değerleri |
|
Bağlan
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint16_t defaultPort )
Bir düğüm tanımlayıcısı ve/veya bir dize eş adresi kullanarak bir Örgü düğümüne bağlanın.
: Tedarik edilirse, peerAddr herhangi biri olabilir
: : [ ]:
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
parametreler |
| ||||||||||
Dönüş Değerleri |
|
Bağlan
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint8_t dnsOptions, uint16_t defaultPort )
Bir düğüm tanımlayıcısı ve/veya bir dize eş adresi kullanarak bir Örgü düğümüne bağlanın.
: Tedarik edilirse, peerAddr herhangi biri olabilir
: : [ ]:
Ayrıntılar | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
parametreler |
| ||||||||||||
Dönüş Değerleri |
|
Bağlan
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, InterfaceId intf )
Bir düğüm tanımlayıcısı ve/veya bir ana bilgisayar adı ve bağlantı noktası listesi kullanarak bir Örgü düğümüne bağlanın.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
parametreler |
| ||||||||||
Dönüş Değerleri |
|
Bağlan
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, uint8_t dnsOptions, InterfaceId intf )
Bir düğüm tanımlayıcısı ve/veya bir ana bilgisayar adı ve bağlantı noktası listesi kullanarak bir Örgü düğümüne bağlanın.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
parametreler |
| ||||||||||
Dönüş Değerleri |
|
Canlı Tutmayı Devre Dışı Bırak
WEAVE_ERROR DisableKeepAlive( void )
WeaveConnection :: DisableKeepAlive .
Temeldeki TCP bağlantısında TCP canlı tutma araştırmalarını devre dışı bırakın.
Not: Bu yöntem yalnızca TCP bağlantısı tarafından desteklenen Dokuma bağlantıda çağrılabilir. Bu yöntem, yalnızca bağlantı göndermeye izin veren bir durumdayken çağrılabilir.
Bu yöntem, bağlantıda canlı tutma etkinleştirilmemişse hiçbir şey yapmaz.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Dönüş Değerleri |
|
Devre Dışı Al
void DisableReceive( void )
Bu aşkın devre dışı bırak alıcı WeaveConnection .
Bu yöntem, uygulama tarafından TCP bağlantısı üzerinden gelen herhangi bir veriyi almaya hazır olmadığını belirtmek için kullanılır. Aramak için yeniden etkinleştirmek için alıcı, uygulama gereksinimlerine amacıyla EnableReceive () izin vermek için WeaveConnection approrpiate geri aramalar çağırarak, alınan herhangi bir veri bağlantısı üzerinden el.
Ayrıca bakınız:EnableReceive()
Canlı Tutmayı Etkinleştir
WEAVE_ERROR EnableKeepAlive( uint16_t interval, uint16_t timeoutCount )
WeaveConnection :: EnableKeepAlive .
Temeldeki TCP bağlantısında TCP canlı tutma araştırmalarını etkinleştirin.
Not: -Bu yöntem yalnızca TCP bağlantısı tarafından desteklenen Dokuma bağlantıda çağrılabilir. -Bu yöntem sadece bağlantı gönderime izin veren bir durumdayken çağrılabilir.
Ayrıntılar | |||||
---|---|---|---|---|---|
parametreler |
|
-Bu yöntem, canlı tutma aralığını veya zaman aşımı sayısını ayarlamak için birden çok kez çağrılabilir.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Dönüş Değerleri |
|
EtkinleştirAl
void EnableReceive( void )
Bu aşkın aldıktan etkinleştirme WeaveConnection .
Bu yöntem göstermek için uygulama tarafından kullanılan WeaveConnection TCP bağlantısı üzerinden ulaşan herhangi bir veri almaya hazır olduğunu nesne.
Ayrıca bakınız:Devre Dışı Bırak()
GetPeerAddressInfo
WEAVE_ERROR GetPeerAddressInfo( IPPacketInfo & addrInfo )
Eşin IP adresi bilgilerini alın.
Ayrıntılar | |||||
---|---|---|---|---|---|
parametreler |
| ||||
Dönüş Değerleri |
|
GetPeerDescription
void GetPeerDescription( char *buf, size_t bufSize ) const
Bağlantıyla ilişkili eş düğümü açıklayan bir dize oluşturur.
Ayrıntılar | |||||
---|---|---|---|---|---|
parametreler |
|
GetTCPEndPoint
TCPEndPoint * GetTCPEndPoint( void ) const
Gelen
bool IsIncoming( void ) const
LogId
uint16_t LogId( void ) const
Serbest bırakmak
void Release( void )
Referans sayısı azaltma WeaveConnection nesne.
Yayın () metodu ile ilişkili referans sayısı azaltır WeaveConnection nesne. Bu, referans sayısının sıfıra ulaşmasıyla sonuçlanırsa, bağlantı kapatılır ve bağlantı nesnesi serbest bırakılır. Bu olduğunda, uygulamanın nesneyle başka bir etkileşimi olmamalıdır.
SıfırlaKullanıcıZaman Aşımı
WEAVE_ERROR ResetUserTimeout( void )
WeaveConnection :: ResetUserTimeout .
TCP kullanıcı zaman aşımı soketi seçeneğini sistem varsayılanına sıfırlayın.
Not: -Bu yöntem yalnızca TCP bağlantısı tarafından desteklenen Dokuma bağlantıda çağrılabilir. -Bu yöntem sadece bağlantı gönderime izin veren bir durumdayken çağrılabilir.
-Bu yöntem, bağlantıda kullanıcı zaman aşımı ayarlanmamışsa hiçbir şey yapmaz.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Dönüş Değerleri |
|
Mesaj gönder
WEAVE_ERROR SendMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Kurulan bir bağlantı üzerinden bir Örgü mesajı gönderin.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
parametreler |
| ||||||||||
Dönüş Değerleri |
|
SendTünelliMesaj
WEAVE_ERROR SendTunneledMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Bir Örgü bağlantısı üzerinden Tünelli paket gönderme işlevi.
Kurulan bir bağlantı üzerinden tünellenmiş bir Örgü mesajı gönderin.
Ayrıntılar | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
parametreler |
| ||||||||||
Dönüş Değerleri |
|
Bağlantı Zaman Aşımı Ayarla
void SetConnectTimeout( const uint32_t connTimeoutMsecs )
Connect'in başarılı olması veya bir hata döndürmesi için zaman aşımını ayarlayın.
Ayrıntılar | |||
---|---|---|---|
parametreler |
|
SetIdleTimeout
WEAVE_ERROR SetIdleTimeout( uint32_t timeoutMS )
Temel ağ katmanı bağlantısında boşta kalma zaman aşımını ayarlayın.
Ayrıntılar | |||||
---|---|---|---|---|---|
parametreler |
| ||||
Dönüş Değerleri |
|
SetGelen
void SetIncoming( bool val )
SetUserTimeout
WEAVE_ERROR SetUserTimeout( uint32_t userTimeoutMillis )
WeaveConnection :: SetUserTimeout .
TCP kullanıcı zaman aşımı soketi seçeneğini ayarlayın.
Değer 0'dan büyük olduğunda, TCP ilgili bağlantıyı zorla kapatmadan önce iletilen verilerin onaylanmadan kalabileceği maksimum süreyi milisaniye cinsinden belirtir. Seçenek değeri 0 olarak belirtilirse, TCP sistem varsayılanını kullanır. Daha fazla ayrıntı için RFC 5482'ye bakın.
Ayrıntılar | |||
---|---|---|---|
parametreler |
|
Not: -Bu yöntem yalnızca TCP bağlantısı tarafından desteklenen Dokuma bağlantıda çağrılabilir. -Bu yöntem sadece bağlantı gönderime izin veren bir durumdayken çağrılabilir.
-Bu yöntem, TCP kullanıcı zaman aşımını ayarlamak için birden çok kez çağrılabilir.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Dönüş Değerleri |
|
Kapat
WEAVE_ERROR Shutdown( void )
Tüm giden verilerin eşin TCP yığını tarafından gönderildiğinden ve alındığından emin olarak zarif bir TCP gönderme kapatması gerçekleştirir.
Çoğu (ancak tümü değil) TCP uygulamasında, bir gönderme kapatmanın alınması, uzaktaki ana bilgisayarın bağlantının kendi tarafını da kapatmasına neden olarak bağlantının kapanmasına neden olur. BIR sonraki çağrı Close () sona olurdu WeaveConnection .
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Dönüş Değerleri |
|
Yakın () ve İptal () .