nl::Weave::TLV::TLVReader

Ottieni il valore dell'elemento della stringa UTF8 o byte corrente.

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 leggendo attualmente.

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 (ossia prima, sopra o dopo l'elemento TLV più esterno), il metodo restituirà kTLVType_Notcarichi.

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

Idealmente, nessuno deve mai essere a conoscenza del byte di controllo e solo l'implementazione interna di TLV dovrebbe potervi accedere. Tuttavia, tuttavia, l'accesso al byte di controllo è utile a fini di debug da parte di TLVDebugUtilities (che cercano di decodificare il byte di controllo tag quando si stampano piuttosto i contenuti del buffer TLV).

Ottieni un puntatore al byte codificato iniziale di un byte TLV o di un elemento stringa UTF8.

Questo metodo restituisce un puntatore diretto al valore della stringa codificato all'interno del buffer di input sottostante. Per avere esito positivo, 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. Ciò rende il metodo di utilizzo limitato durante la lettura di 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 tipo stringa 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 al raggiungimento della lunghezza massima di lettura.

Ottieni il valore dell'elemento della stringa UTF8 o byte corrente come stringa terminata con valore null.

Per determinare la dimensione del buffer di input richiesta, chiama il metodo GetLength() prima di chiamare GetBytes(). Il buffer di input deve essere superiore di almeno un byte 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à tag (IsProfileTag(), IsContextTag(), ProfileIdFromTag() e così via) per determinare il tipo di tag ed estrarre vari valori dei campi 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 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 fino all'analisi dei byte maxLen.

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

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

Consente di far avanzare 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, chiamando Next() il lettore passerà all'elemento più in alto successivo. Se il lettore è posizionato all'interno di un elemento contenitore TLV (una struttura, un array o un percorso), chiamando Next() il lettore verrà avanzato all'elemento membro successivo del container.

Poiché Next() vincola il movimento del lettore al contesto di contenimento corrente, chiamando Next() quando il lettore è posizionato su un elemento contenitore, avanzerà sopra il container, saltando i relativi elementi membro (e i membri di qualsiasi contenitore nidificato) fino a raggiungere il primo elemento dopo il container.

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

Sposta l'oggetto TLVReader sull'elemento TLV successivo da leggere, dichiarando il tipo e il tag del nuovo elemento.

Il metodo Next(TLVTypeexpectedType, uint64_texpectedTag) è un metodo di convenienza 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 contenitore TLV.

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

Quando viene restituito il metodo OpenContainer(), il lettore di container viene posizionato subito prima del primo membro del container. La chiamata a Next() nel lettore di container avanza tra i membri della raccolta fino al raggiungimento della fine, dopodiché 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. Quando un'applicazione ha finito di utilizzare il lettore di container, deve chiuderla chiamando CloseContainer() sul lettore padre, passando il lettore container come argomento. Le applicazioni possono chiudere il lettore di container in qualsiasi momento, con o senza la lettura di tutti gli elementi contenuti nel container sottostante. Dopo la chiusura del lettore di contenitori, le applicazioni possono continuare a utilizzare il lettore principale.

Il lettore di contenitori eredita varie proprietà di configurazione dal lettore principale. Le tre aree sono:

• ID profilo implicito (ImplicitProfileId)
• Il puntatore ai dati dell'applicazione (VPC)
• Puntatore della funzione GetNextBuffer

Sposta 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 Next(), se il lettore è posizionato su un elemento contenitore al momento della chiamata, i membri del contenitore verranno ignorati. Se il lettore non è posizionato su nessun 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 che equivale a chiamare Next() e a verificare il valore restituito da WEAVE_END_OF_TLV.

Cancella lo stato di 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 il tipo 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
)