nl::Tessuto::TLV::TLVReader

Recupera il valore dell'elemento stringa UTF8 corrente.

Per determinare la dimensione del buffer di input richiesta, chiama il metodo GetLength() prima di chiamare GetBytes().

Restituisce il tipo del container all'interno del quale TLVReader sta leggendo.

Il metodo GetContainerType() restituisce il tipo di container TLV all'interno della quale TLVReader sta leggendo. Se TLVReader è posizionato al livello più esterno di una codifica TLV (ovvero prima, sopra o dopo l'elemento TLV più esterno), il metodo restituirà kTLVType_NotSpecificato.

Restituisce il byte di controllo associato all'elemento TLV corrente.

In teoria, nessuno deve mai sapere del byte di controllo e solo l'implementazione interna del TLV dovrebbe potervi accedere. Tuttavia, l'accesso al byte di controllo è utile ai fini del debug da parte delle utilità di debug TLV (che tentano di decodificare il byte di controllo del tag durante la stampa semplice dei contenuti del buffer TLV).

Recupera un puntatore sul byte codificato iniziale di un byte byte TLV o un elemento stringa UTF8.

Questo metodo restituisce un puntatore diretto al valore della stringa codificata all'interno del buffer di input sottostante. Per avere successo, il metodo richiede che l'intero valore della stringa sia presente in un singolo buffer. In caso contrario, il metodo restituisce WEAVE_ERROR_TLV_UNDERRUN. Questo rende il metodo di utilizzo limitato quando si leggono i dati da più buffer discontinui.

Restituisce la lunghezza dei dati associati all'elemento TLV corrente.

La lunghezza dei dati si applica solo agli elementi di tipo stringa UTF8 o stringa di byte. Per le stringhe UTF8, il valore restituito corrisponde al numero di byte nella stringa, non al numero di caratteri.

Restituisce il numero totale di byte letti da quando il lettore è stato inizializzato.

Visualizza il punto nel buffer di input sottostante che corrisponde alla posizione corrente del lettore.

Restituisce il numero totale di byte che possono essere letti fino a raggiungere la lunghezza massima di lettura.

Recupera il valore dell'elemento stringa UTF8 attuale come stringa terminata nullo.

Per determinare la dimensione del buffer di input richiesta, chiama il metodo GetLength() prima di chiamare GetBytes(). Il buffer di input deve avere almeno un byte in più rispetto alla lunghezza della stringa per contenere il carattere null.

Restituisce il tag associato all'elemento TLV corrente.

Il valore restituito da GetTag() può essere utilizzato con le funzioni di utilità dei tag (IsProfileTag(), IsContextTag(), ProfileIdFromTag() e così via) per determinare il tipo di tag ed estrarre i vari valori dei campi dei tag.

Restituisce il tipo dell'elemento TLV corrente.

Inizializza un oggetto TLVReader da un altro oggetto TLVReader.

Inizializza un oggetto TLVReader da leggere da un singolo buffer di input.

Inizializza un oggetto TLVReader da leggere da un singolo PacketBuffer.

L'analisi inizia dalla posizione iniziale del buffer (buf->DataStart()) e continua fino alla fine dei dati nel buffer (come indicato da buf->Datalen()) o sono stati analizzati maxLen byte.

Inizializza un oggetto TLVReader da leggere da uno o più PacketBuffers.

L'analisi viene avviata nella posizione iniziale del buffer (buf->DataStart()). Se allowDiscontiguousBuffers è true, il lettore avanzerà nella catena di buffer collegata dai relativi puntatori Next(). L'analisi continua finché non sono stati consumati tutti i dati nella catena di buffer (come indicato da buf->Datalen()) o vengono analizzati i byte maxLen.

Fa passare l'oggetto TLVReader all'elemento TLV successivo da leggere.

Il metodo Next() posiziona l'oggetto Reader sull'elemento successivo in una codifica TLV che si trova nello stesso contesto di contenimento. In particolare, se il lettore è posizionato al livello più esterno della codifica TLV, una chiamata a Next() lo farà passare all'elemento successivo più in alto. Se il lettore è posizionato all'interno di un elemento container TLV (una struttura, una matrice o un percorso), la chiamata a Next() avanzerà il lettore all'elemento membro successivo del container.

Poiché Next() limita il movimento del lettore al contesto di contenimento corrente, chiamando Next() quando il lettore è posizionato su un elemento container avanzerà oltre al container, ignorando gli elementi membro (e i membri di tutti i container nidificati) fino a raggiungere il primo elemento dopo il container.

Quando non sono presenti ulteriori elementi in un determinato contesto di contenimento, il metodo Next() restituirà un errore WEAVE_END_OF_TLV e la posizione del lettore rimarrà invariata.

Fa passare l'oggetto TLVReader all'elemento TLV successivo da leggere, rivendicando il tipo e il tag del nuovo elemento.

Il metodo Next(TLVType expectedType, uint64_tatteTag) è un metodo pratico che ha lo stesso comportamento di Next(), ma verifica anche che il tipo e il tag del nuovo elemento TLV corrispondano agli argomenti forniti.

Inizializza un nuovo oggetto TLVReader per la lettura dei membri di un elemento container TLV.

Il metodo OpenContainer() inizializza un nuovo oggetto TLVReader per la lettura degli elementi membro di un container TLV (una struttura, una matrice o un percorso). Quando viene richiamato OpenContainer(), l'oggetto TLVReader corrente deve essere posizionato sull'elemento container per essere letto. Il metodo considera come unico argomento un riferimento a un nuovo lettore che verrà inizializzato per leggere il container. Questo lettore è noto come Lettore del contenitore, mentre il lettore su cui viene chiamato OpenContainer() è noto come Lettore principale.

Quando viene restituito il metodo OpenContainer(), il lettore viene posizionato immediatamente prima del primo membro del contenitore. La chiamata a Next() sul lettore di container avanzerà tra i membri della raccolta fino al raggiungimento della fine, a quel punto il lettore restituirà WEAVE_END_OF_TLV.

Quando il lettore container è aperto, le applicazioni non devono effettuare chiamate su o modificare lo stato del lettore principale. Quando un'applicazione ha finito di utilizzare il lettore di container, deve chiuderla chiamando CloseContainer() sul lettore principale e trasmettendo il lettore come argomento. Le applicazioni possono chiudere il lettore di container in qualsiasi momento, con o senza leggere tutti gli elementi contenuti nel container sottostante. Dopo la chiusura del lettore di container, le applicazioni possono continuare a utilizzare il lettore principale.

Il lettore di container eredita varie proprietà di configurazione dal lettore principale. Questi sono:

• L'ID profilo implicito (ImplicitProfileId)
• Il puntatore dei dati dell'applicazione (AppData)
• Il puntatore della funzione GetNextBuffer

Avanza all'oggetto TLVReader subito dopo l'elemento TLV corrente.

Il metodo Skip() posiziona l'oggetto Reader immediatamente dopo l'elemento TLV corrente, in modo che una chiamata successiva a Next() avanzi il lettore all'elemento seguente. Come nel caso di Next(), se il lettore è posizionato su un elemento container al momento della chiamata, i membri del container verranno ignorati. Se il lettore non è posizionato su alcun elemento, la sua posizione resta invariata.

Verifica che l'oggetto TVLReader si trovi alla fine di un container TLV.

Il metodo VerifyEndOfContainer() verifica che non siano presenti altri elementi TLV da leggere all'interno dell'attuale container TLV. Questo è un metodo pratico che equivale a chiamare Next() e verificare la presenza di un valore restituito di WEAVE_END_OF_TLV.

Cancella lo stato del TLVReader.

Questo metodo viene utilizzato per posizionare il lettore prima del primo TLV, tra i TLV o dopo l'ultimo TLV.

Questo è un metodo privato che restituisce TLVElementType da mControlByte.

GetElementHeadLength

WEAVE_ERROR GetElementHeadLength(
  uint8_t & elemHeadBytes
) const 

IsContainerOpen

bool IsContainerOpen(
  void
) const 

WEAVE_ERROR ReadData(
  uint8_t *buf,
  uint32_t len
)

WEAVE_ERROR ReadElement(
  void
)

uint64_t ReadTag(
  TLVTagControl tagControl,
  const uint8_t *& p
)

void SetContainerOpen(
  bool aContainerOpen
)

WEAVE_ERROR SkipData(
  void
)

WEAVE_ERROR SkipToEndOfContainer(
  void
)

WEAVE_ERROR VerifyElement(
  void
)

WEAVE_ERROR FailGetNextBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)

WEAVE_ERROR GetNextPacketBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)