nl::Weave::Profiles::DataManagement_Current::NotificationEngine::NotifyRequestBuilder

#include <src/lib/profiles/data-management/Current/NotificationEngine.h>

Bu, mesaj oluşturma konusunda yardımcı sınıfa, mesajın yapısını ve yapısını tüketicilerinden bildirim ve soyutlama imkanı sunar.

Özet

Bu, MessageDef.cpp'de sağlanan ve cihazın flash ve RAM ihtiyaçlarına karşı hassas olmayı amaçlayan benzer bir sınıfın daha kompakt bir sürümüdür.

Herkese açık işlevler
Checkpoint(TLV::TLVWriter & aPoint)
İstek durumunu bir TLVWriter'a kontrol edin.
EndDataList()
Veri listesi dizisinin oluşturulmasını sonlandırın.
EndEventList()
Etkinlik listesi oluşturma işlemini sonlandırın.
EndNotifyRequest()
Bildirim oluşturma işlemini sonlandır.
GetWriter(void)
Init(PacketBuffer *aBuf, TLV::TLVWriter *aWriter, SubscriptionHandler *aSubHandler, uint32_t aMaxPayloadSize)
Derleyiciyi başlatır.
MoveToState(NotifyRequestBuilderState aDesiredState)
Ana durum geçiş işlevi.
Rollback(TLV::TLVWriter & aPoint)
İstek durumunu kontrol noktası olan TLVWriter'a geri al.
StartDataList(void)
Veri listesi dizisinin oluşturulmasına başlar.
StartEventList()
Etkinlik listesinin oluşturulmasını başlatır.
StartNotifyRequest()
Bildirimin oluşturulmasına başlayın.
WriteDataElement(TraitDataHandle aTraitDataHandle, PropertyPathHandle aPropertyPathHandle, SchemaVersion aSchemaVersion, PropertyPathHandle *aMergeDataHandleSet, uint32_t aNumMergeDataHandles, PropertyPathHandle *aDeleteHandleSet, uint32_t aNumDeleteHandles)
Bir özellik yolu belirterek bu yolla ilişkilendirilen veri öğesini yazın.

Herkese açık işlevler

Kontrol noktası

WEAVE_ERROR Checkpoint(
  TLV::TLVWriter & aPoint
)

İstek durumunu bir TLVWriter'a kontrol edin.

Ayrıntılar
Parametreler
[out] aPoint
TLV yazarının durumunu kontrol etmek için bir yazar.
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.

EndDataList

WEAVE_ERROR EndDataList()

Veri listesi dizisinin oluşturulmasını sonlandırın.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
WEAVE_ERROR_INCORRECT_STATE
İstek DataList kapsayıcısında değilse.
other
Veri listesinin sonu oluşturulamıyor.

EndEventList

WEAVE_ERROR EndEventList()

Etkinlik listesi oluşturma işlemini sonlandırın.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
WEAVE_ERROR_INCORRECT_STATE
İstek, EventList kapsayıcısında değilse.
other
Veri listesinin sonu oluşturulamıyor.

EndNotifyRequest

WEAVE_ERROR EndNotifyRequest()

Bildirim oluşturma işlemini sonlandır.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
WEAVE_ERROR_INCORRECT_STATE
İstek, Bildirim kapsayıcısında değilse.
other
Bildirimin sonu oluşturulamıyor.

GetWriter

TLV::TLVWriter * GetWriter(
  void
)

Init

WEAVE_ERROR Init(
  PacketBuffer *aBuf,
  TLV::TLVWriter *aWriter,
  SubscriptionHandler *aSubHandler,
  uint32_t aMaxPayloadSize
)

Derleyiciyi başlatır.

Yalnızca bir kez çağrılmalıdır.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
other
Oluşturucu başlatılamadı.

MoveToState

WEAVE_ERROR MoveToState(
  NotifyRequestBuilderState aDesiredState
)

Ana durum geçiş işlevi.

İşlev, istenen durumu (yani, ulaşmak istediğimiz bildirim isteği oluşturucunun aşamasını) alır ve isteği bu duruma geçirir. İstenen durum geçerli durumla aynıysa işlev hiçbir şey yapmaz. Aksi takdirde, bir PacketBuffer ayrılır (gerekirse); işlev önce bu isteği üst düzey bildirim isteğine geçirir (bildirim isteği TLV yapısını açabilir veya mevcut TLV veri kapsayıcısını gerektiğinde kapatarak) ve ardından uygun TLV veri kapsayıcısını açarak ya da kapsayıcı Bildirim isteğini kapatarak Bildirim isteğini geçirir.

Ayrıntılar
Parametreler
aDesiredState
İsteğin geçişinin yapılması gereken istenen durum
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
WEAVE_ERROR_NO_MEMORY
Yetersiz bellek nedeniyle duruma geçiş yapılamadı.
WEAVE_ERROR_INCORRECT_STATE
Dahili durum makinesinin bozulması.
other
Durum makinesi, durumu arabelleğinde kaydedemediğinde bu durum büyük olasılıkla çalışma zamanı sorunundan ziyade bir tasarım hatasına işaret eder.

Geri al

WEAVE_ERROR Rollback(
  TLV::TLVWriter & aPoint
)

İstek durumunu kontrol noktası olan TLVWriter'a geri al.

Ayrıntılar
Parametreler
[in] aPoint
Geçmişte bu eyaleti ele alan bir yazar
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.

StartDataList

WEAVE_ERROR StartDataList(
  void
)

Veri listesi dizisinin oluşturulmasına başlar.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
WEAVE_ERROR_INCORRECT_STATE
İstek, Bildirim kapsayıcısında değilse.
other
Veri listesinin başlangıcı oluşturulamıyor.

StartEventList

WEAVE_ERROR StartEventList()

Etkinlik listesinin oluşturulmasını başlatır.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
WEAVE_ERROR_INCORRECT_STATE
İstek, Bildirim kapsayıcısında değilse.
other
Veri listesinin başlangıcı oluşturulamıyor.

StartNotifyRequest

WEAVE_ERROR StartNotifyRequest()

Bildirimin oluşturulmasına başlayın.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
WEAVE_ERROR_INCORRECT_STATE
İstek, arabelleğin en üst düzeyinde değilse.
other
Bildirimin sonu oluşturulamıyor.

WriteDataElement

WEAVE_ERROR WriteDataElement(
  TraitDataHandle aTraitDataHandle,
  PropertyPathHandle aPropertyPathHandle,
  SchemaVersion aSchemaVersion,
  PropertyPathHandle *aMergeDataHandleSet,
  uint32_t aNumMergeDataHandles,
  PropertyPathHandle *aDeleteHandleSet,
  uint32_t aNumDeleteHandles
)

Bir özellik yolu belirterek bu yolla ilişkilendirilen veri öğesini yazın.

Çağrıyı yapan, isteğe bağlı olarak bir herkese açık kullanıcı adı grubunu da iletebilir. Böylece, birleştirme işleminin üst mülk yolu tutma yerinin daha dar kapsamlı bir doğrudan alt düğüm grubuyla kullanılmasına olanak tanır.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
Başarıya merhaba.
other
Veri öğesi alınamıyor ve yazılamadı.