nl:: örgü:: Profiller:: DataManagement_Legacy:: DMClient

#include <src/lib/profiles/data-management/Legacy/DMClient.h>

Uygulamaya özel WDM istemcileri için soyut temel sınıf.

özet

DMClient standart WDM istemcisidir. Uygulama isteğe bağlı olarak abonelik/bildirim içerir. Bu DM bir karışımı olan ProtocolEngine comms dönüm-krank ve tamamen soyut kolları sınıf, ClientDataManager böylece uygulanan abonelik ilgili yöntemlerin bazıları ile sınıf yüksek katmanlar onlar hakkında endişe zorunda kalmamasıdır.

Abonelik ilgili görevler için yükleyiciler esas olarak ince bir adaptör olarak hareket ClientNotifier nesne. Alt sınıf uygulayıcıları, abonelik yöneticisi krankını açmak için ilgili süper sınıf yöntemlerini çağırmaya özen göstermelidir.

DMClient istek yöntemleri genel olarak, 2 imzalar, açık bir hedef düğüm numarası ile bir ve belirli bir hedef, diğer sahiptir. Her iki durumda da, bir yayıncıya mesaj gönderme yeteneği, istemcide önceden var olan bir bağlamaya bağlıdır, ancak ilk durumda, hedef kimliğinin birden çok bağlı hedef arasında seçim yapması amaçlanır ve ikinci durumda, ilk bağlama tablosundaki öğe varsayılan olarak seçilir. Bu, örneğin, istemci yalnızca tek bir yayıncıya bağlı olacaksa kullanışlıdır.

miras

Şuradan devralır:
  nl::Weave::Profiles::DataManagement_Legacy::ProtocolEngine
  nl::Weave::Profiles::DataManagement_Legacy::ClientDataManager

Yapıcılar ve Yıkıcılar

DMClient (void)
İçin varsayılan yapıcı DMClient nesneleri.
~DMClient (void)
Yıkıcı DMClient nesneleri.
ViewRequest (const uint64_t & aDestinationId, ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout)
virtual WEAVE_ERROR
Yayınlanan verilerin bir görünümünü isteyin.
ViewRequest ( ReferencedTLVData & aPathList, uint16_t aTxnId, uint32_t aTimeout)
virtual WEAVE_ERROR
Varsayılan yayıncıya ilişkin verilerin bir görünümünü isteyin.
UpdateRequest (const uint64_t & aDestinationId, ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout)
virtual WEAVE_ERROR
Yayınlanan veriler için bir güncelleme isteyin.
UpdateRequest ( ReferencedTLVData & aDataList, uint16_t aTxnId, uint32_t aTimeout)
virtual WEAVE_ERROR
Varsayılan yayıncıdaki veriler için bir güncelleme isteyin.

Korunan özellikler

mUpdatePool [kUpdatePoolSize]
mViewPool [kViewPoolSize]

Kamu işlevleri

CancelTransactionRequest (uint16_t aTxnId, WEAVE_ERROR aError)
Yürütülen bir işlemin iptal edilmesini isteyin.
Clear (void)
virtual void
Bir ilişkili dahili durumunu temizleyin DMClient nesne.
Finalize (void)
virtual void
Bir işletim kapatın DMClient .
IncompleteIndication ( Binding *aBinding, StatusReport & aReport)
virtual void
İstemci tarafından kullanılan bir bağlamanın "tamamlanmamışlığını" ele alın.

Korumalı fonksiyonlar

NewUpdate (void)
NewView (void)
View *

GörüntüleTalebi

virtual WEAVE_ERROR ViewRequest(
  const uint64_t & aDestinationId,
  ReferencedTLVData & aPathList,
  uint16_t aTxnId,
  uint32_t aTimeout
)

Yayınlanan verilerin bir görünümünü isteyin.

Belirtilen bir uzak yayımcı tarafından yönetilen ve üzerinde bulunan verilerin bir görünümünü isteyin.

Ayrıntılar
parametreler
[in] aDestinationId
Uzak yayıncının 64 bit düğüm kimliğine bir başvuru.
[in] aPathList
Bir bir başvuru ReferencedTLVData istenen verileri gösteren bir TLV kodlu yol listesini içeren bir nesne.
[in] aTxnId
Bu görüntüleme işlemini yönetmek için ayarlanmış WDM işlemi için bir tanımlayıcı.
[in] aTimeout
Görüntüleme yanıtını beklemek için milisaniye cinsinden maksimum süre.
Dönüş Değerleri
WEAVE_NO_ERROR
Başarı üzerine.
WEAVE_ERROR_NO_MEMORY
Bir işlem tahsis edilemediyse.
İadeler
Aksi takdirde, bir WEAVE_ERROR başlatmak veya hareketi başlatmak için başarısızlık yansıtmaktadır.

GörüntüleTalebi

virtual WEAVE_ERROR ViewRequest(
  ReferencedTLVData & aPathList,
  uint16_t aTxnId,
  uint32_t aTimeout
)

Varsayılan yayıncıya ilişkin verilerin bir görünümünü isteyin.

"Varsayılan" yayıncıda, yani müşterinin bağlama tablosundaki ilk (veya tek) yayıncıda bulunan ve yönetilen verilerin bir görünümünü isteyin.

Ayrıntılar
parametreler
[in] aPathList
Bir bir başvuru ReferencedTLVData istenen verileri gösteren bir TLV kodlu yol listesini içeren bir nesne.
[in] aTxnId
Bu görüntüleme işlemini yönetmek için ayarlanmış WDM işlemi için bir tanımlayıcı.
[in] aTimeout
Görüntüleme yanıtını beklemek için milisaniye cinsinden maksimum süre.
Dönüş Değerleri
WEAVE_NO_ERROR
Başarı üzerine.
WEAVE_ERROR_NO_MEMORY
Bir işlem tahsis edilemediyse.
İadeler
Aksi takdirde, bir WEAVE_ERROR başlatmak veya hareketi başlatmak için başarısızlık yansıtmaktadır.

GüncellemeTalebi

virtual WEAVE_ERROR UpdateRequest(
  const uint64_t & aDestinationId,
  ReferencedTLVData & aDataList,
  uint16_t aTxnId,
  uint32_t aTimeout
)

Yayınlanan veriler için bir güncelleme isteyin.

Bir uzak yayıncının yönetim altındaki verileri güncellemesini isteyin.

Ayrıntılar
parametreler
[in] aDestinationId
İsteğin gönderildiği uzak yayıncının 64 bit düğüm kimliğine bir başvuru.
[in] aDataList
Bir bir başvuru ReferencedTLVData güncelleme uygulanacak olan bir yollar da dahil olmak üzere güncelleme bir gösterimini içeren bir TLV kodlu veri listesini içeren bir nesne.
[in] aTxnId
Güncelleme talebini yönetmek için ayarlanan işlem için bir tanımlayıcı.
[in] aTimeout
İlgili durum raporunu beklemek için milisaniye cinsinden maksimum süre.
İadeler
WEAVE_NO_ERROR başarı veya üzerinde WEAVE_ERROR_NO_MEMORY bir güncelleştirme işleminin tahsis edilemedi eğer. Aksi takdirde, bir dönüş WEAVE_ERROR bir güncelleme hatası yansıtmaktadır.

GüncellemeTalebi

virtual WEAVE_ERROR UpdateRequest(
  ReferencedTLVData & aDataList,
  uint16_t aTxnId,
  uint32_t aTimeout
)

Varsayılan yayıncıdaki veriler için bir güncelleme isteyin.

Bir uzak yayıncının yönetim altındaki verileri güncellemesini isteyin. Bu sürüm, isteği, istemcinin varsayılan bağlamasının hedefi olan yayımcıya yönlendirir.

Ayrıntılar
parametreler
[in] aDataList
Bir bir başvuru ReferencedTLVData güncelleme uygulanacak olan bir yollar da dahil olmak üzere güncelleme bir gösterimini içeren bir TLV kodlu veri listesini içeren bir nesne.
[in] aTxnId
Güncelleme talebini yönetmek için ayarlanan işlem için bir tanımlayıcı.
[in] aTimeout
İlgili durum raporunu beklemek için milisaniye cinsinden maksimum süre.
İadeler
WEAVE_NO_ERROR başarı veya üzerinde WEAVE_ERROR_NO_MEMORY bir güncelleştirme işleminin tahsis edilemedi eğer. Aksi takdirde, bir dönüş WEAVE_ERROR bir güncelleme hatası yansıtmaktadır.

Korunan özellikler

mGüncelleme Havuzu

Update mUpdatePool[kUpdatePoolSize]

mViewPool

View mViewPool[kViewPoolSize]

Kamu işlevleri

İptalİşlemTalebi

WEAVE_ERROR CancelTransactionRequest(
  uint16_t aTxnId,
  WEAVE_ERROR aError
)

Yürütülen bir işlemin iptal edilmesini isteyin.

Bu yöntem ağ trafiği oluşturmaz, yalnızca belirtilen işlem(ler) için ayrılan kaynakları serbest bırakır.

Ayrıntılar
parametreler
[in] aTxnId
İptal edilecek işlemin numarası. kTransactionIdNotSpecified sağlanırsa, tüm işlemler iptal edilir.
[in] aError
WEAVE_ERROR işlem iptal edildiğinde rapor etmek.
İadeler
WEAVE_NO_ERROR başarı veya bir üzerinde WEAVE_ERROR işlemi iptal etmek bir hata yansıtmaktadır.

Açık

virtual void Clear(
  void
)

Bir ilişkili dahili durumunu temizleyin DMClient nesne.

Özellikle, bu yöntem tüm istemci işlem havuzlarını temizler. Kullanılmakta olan müşteriler için ) (sonuçlandırmak da abonelikleri iptal eder ve işlem ve bağlayıcı tabloları temizler uygulama yolu tercih edilir.

Ayrıca bakınız:
Sonuçlandırmak()

DMClient

 DMClient(
  void
)

İçin varsayılan yapıcı DMClient nesneleri.

Tüm dahili durumu temizler. Bir DMClient kullanımdan önce Init ile (daha fazla başlatma) gerektirir.

Sonuçlandırmak

virtual void Finalize(
  void
)

Bir işletim kapatın DMClient .

İstemciyle ilişkili tüm çalışma durumunu temizler ve ilgili tüm abonelikleri bildirimden kaldırır. Bir çağrı sonrasında Finalize () Bir DMClient Init arayarak basitçe () reinitialized olabilir. Finalize () tarafından çağrılır DMClient destructor ama durumda çağrılabilir DMClient başarısızlık veya geçici kapatma durumunda temizleme, örneğin gerektirir, ancak daha sonraki bir zamanda yeniden gerekebilir.

Eksik Gösterge

virtual void IncompleteIndication(
  Binding *aBinding,
  StatusReport & aReport
)

İstemci tarafından kullanılan bir bağlamanın "tamamlanmamışlığını" ele alın.

Bir bağlama beklenmedik bir şekilde başarısız olduğunda, örneğin bağlamaya dahil olan bağlantı kapalıysa, bu yöntem çağrılır.

Ayrıntılar
parametreler
[in] aBinding
Bir işaretçi bağlama eksik olmuştur.
[in] aReport
Başarısızlığın nedenini belirten bir durum raporuna referans.

~DMClient

virtual  ~DMClient(
  void
)

Yıkıcı DMClient nesneleri.

Tüm dahili durumu temizler ve gerekirse bekleyen abonelikleri iptal eder.

Korumalı fonksiyonlar

Yeni güncelleme

Update * NewUpdate(
  void
)

Yeni görüntülenme

View * NewView(
  void
)