nl::Weave::TLV::TLVReader

Recupera il valore dell'elemento corrente byte o stringa UTF8.

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

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

Il metodo GetContainerType() restituisce il tipo di container TLV all'interno del 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 restituisce kTLVType_NotSpecified.

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

Idealmente, nessuno ha bisogno di conoscere il byte di controllo e solo l'implementazione interna di TLV dovrebbe accedervi. Ciononostante, avere accesso al byte di controllo è utile per il debug da parte delle TLVDebugUtilities (che tentano di decodificare il byte di controllo del tag quando stampi abbastanza i contenuti del buffer TLV).

Recupera un puntatore al byte codificato iniziale di un byte TLV o di un elemento di 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 durante la lettura dei dati da più buffer non adiacenti.

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

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

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

Restituisce 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 corrente byte o stringa UTF8 come stringa con terminazione null.

Per determinare la dimensione del buffer di input richiesta, chiama il metodo GetLength() prima di chiamare GetBytes(). Il buffer di input deve essere almeno un byte più grande della 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à tag (IsProfileTag(), IsContextTag(), ProfileIdFromTag() e così via) per determinare il tipo di tag ed estrarre 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 per la lettura da un singolo buffer di input.

Inizializza un oggetto TLVReader per la lettura da un singolo PacketBuffer.

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

Inizializza un oggetto TLVReader per la lettura da uno o più PacketBuffers.

L'analisi inizia nella posizione iniziale del buffer (buf->DataStart()). Se allowDiscontiguousBuffers è true, il lettore avanza attraverso la catena di buffer collegati dai loro puntatori Next(). L'analisi continua finché non vengono consumati tutti i dati nella catena di buffer (come indicato da buf->Datalen()) o finché non sono stati analizzati i byte di maxLen.

Porta l'oggetto TLVReader all'elemento TLV successivo da leggere.

Il metodo Next() posiziona l'oggetto reader sull'elemento successivo in una codifica TLV che risiede nello stesso contesto di contenimento. In particolare, se il lettore è posizionato al livello più esterno di una codifica TLV, richiamando Next() il lettore passa all'elemento successivo più in alto. Se il lettore è posizionato all'interno di un elemento contenitore TLV (una struttura, un array o un percorso), la chiamata a Next() fa avanzare il lettore all'elemento membro successivo del contenitore.

Poiché Next() vincola il movimento del lettore al contesto di contenimento corrente, la chiamata a Next() quando il lettore è posizionato su un elemento contenitore avanza oltre il container, saltando i relativi elementi membri (e i membri di eventuali contenitori nidificati) fino a raggiungere il primo elemento dopo il contenitore.

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

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

Il metodo Next(TLVType expectedType, uint64_t expectedTag) è 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 membri di un container TLV (una struttura, un array o un percorso). Quando viene chiamato OpenContainer(), l'oggetto TLVReader corrente deve essere posizionato sull'elemento contenitore per poter essere letto. Il metodo prende come unico argomento un riferimento a un nuovo lettore che verrà inizializzato per leggere il container. Questo lettore è noto come lettore container, mentre il lettore su cui viene chiamata OpenContainer() è noto come lettore padre.

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

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

Il lettore contenitore eredita varie proprietà di configurazione dal lettore principale. Queste sono:

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

Consente di far avanzare l'oggetto TLVReader immediatamente 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() faccia avanzare il lettore all'elemento seguente. Come per 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 rimane invariata.

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

Il metodo VerifyEndOfContainer() verifica che non ci siano altri elementi TLV da leggere all'interno del container TLV corrente. Si tratta di un metodo pratico equivalente alla chiamata di Next() e al controllo del valore restituito WEAVE_END_OF_TLV.

Cancella lo stato di TLVReader.

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

Si tratta di un metodo privato che restituisce il valore 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
)