Google is committed to advancing racial equity for Black communities. See how.
Questa pagina è stata tradotta dall'API Cloud Translation.
Switch to English

Messaggio

Questo modulo include funzioni che manipolano i buffer dei messaggi OpenThread.

Sommario

Enumerazioni

otMessagePriority {
OT_MESSAGE_PRIORITY_LOW = 0,
OT_MESSAGE_PRIORITY_NORMAL = 1,
OT_MESSAGE_PRIORITY_HIGH = 2
}
enum
Questa enumerazione definisce i livelli di priorità dei messaggi OpenThread.

Typedef

otBufferInfo typedef
struct otBufferInfo
Questa struttura rappresenta le informazioni del buffer dei messaggi.
otMessage typedef
struct otMessage
Questa struttura punta a un buffer dei messaggi OpenThread.
otMessagePriority typedef
Questa enumerazione definisce i livelli di priorità dei messaggi OpenThread.
otMessageSettings typedef
Questa struttura rappresenta le impostazioni del messaggio.

Funzioni

otMessageAppend ( otMessage *aMessage, const void *aBuf, uint16_t aLength)
Aggiungi byte a un messaggio.
otMessageFree ( otMessage *aMessage)
void
Liberare un buffer dei messaggi allocato.
otMessageGetBufferInfo ( otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Ottieni le informazioni sul buffer dei messaggi.
otMessageGetLength (const otMessage *aMessage)
uint16_t
Ottieni la lunghezza del messaggio in byte.
otMessageGetOffset (const otMessage *aMessage)
uint16_t
Ottieni l'offset del messaggio in byte.
otMessageGetRss (const otMessage *aMessage)
int8_t
Questa funzione restituisce l'RSS medio (potenza del segnale ricevuto) associato al messaggio.
otMessageIsLinkSecurityEnabled (const otMessage *aMessage)
bool
Questa funzione indica se la protezione del collegamento è abilitata o meno per il messaggio.
otMessageQueueDequeue ( otMessageQueue *aQueue, otMessage *aMessage)
void
Questa funzione rimuove un messaggio dalla coda di messaggi specificata.
otMessageQueueEnqueue ( otMessageQueue *aQueue, otMessage *aMessage)
void
Questa funzione aggiunge un messaggio alla fine della coda di messaggi specificata.
otMessageQueueEnqueueAtHead ( otMessageQueue *aQueue, otMessage *aMessage)
void
Questa funzione aggiunge un messaggio all'inizio / all'inizio della coda di messaggi specificata.
otMessageQueueGetHead ( otMessageQueue *aQueue)
Questa funzione restituisce un puntatore al messaggio all'inizio della coda.
otMessageQueueGetNext ( otMessageQueue *aQueue, const otMessage *aMessage)
Questa funzione restituisce un puntatore al messaggio successivo nella coda iterando in avanti (dalla testa alla coda).
otMessageQueueInit ( otMessageQueue *aQueue)
void
Inizializza la coda dei messaggi.
otMessageRead (const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Legge i byte da un messaggio.
otMessageSetDirectTransmission ( otMessage *aMessage, bool aEnabled)
void
Questa funzione imposta / forza l'inoltro del messaggio utilizzando la trasmissione diretta.
otMessageSetLength ( otMessage *aMessage, uint16_t aLength)
Imposta la lunghezza del messaggio in byte.
otMessageSetOffset ( otMessage *aMessage, uint16_t aOffset)
void
Imposta l'offset del messaggio in byte.
otMessageWrite ( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Scrivi byte in un messaggio.

Structs

otBufferInfo

Questa struttura rappresenta le informazioni del buffer dei messaggi.

otMessage

Questa struttura punta a un buffer dei messaggi OpenThread.

otMessageQueue

Questa struttura rappresenta una coda di messaggi OpenThread.

otMessageSettings

Questa struttura rappresenta le impostazioni del messaggio.

Enumerazioni

otMessagePriority

 otMessagePriority

Questa enumerazione definisce i livelli di priorità dei messaggi OpenThread.

Proprietà
OT_MESSAGE_PRIORITY_HIGH

Livello di priorità alta.

OT_MESSAGE_PRIORITY_LOW

Livello di priorità bassa.

OT_MESSAGE_PRIORITY_NORMAL

Livello di priorità normale.

Typedef

otBufferInfo

struct otBufferInfo otBufferInfo

Questa struttura rappresenta le informazioni del buffer dei messaggi.

otMessage

struct otMessage otMessage

Questa struttura punta a un buffer dei messaggi OpenThread.

otMessagePriority

enum otMessagePriority otMessagePriority

Questa enumerazione definisce i livelli di priorità dei messaggi OpenThread.

otMessageSettings

struct otMessageSettings otMessageSettings

Questa struttura rappresenta le impostazioni del messaggio.

Funzioni

otMessageAppend

otError otMessageAppend(
  otMessage *aMessage,
  const void *aBuf,
  uint16_t aLength
)

Aggiungi byte a un messaggio.

Dettagli
Parametri
[in] aMessage
Puntatore a un buffer dei messaggi.
[in] aBuf
Un puntatore ai dati da aggiungere.
[in] aLength
Numero di byte da aggiungere.
Valori restituiti
OT_ERROR_NONE
Aggiunto con successo al messaggio
OT_ERROR_NO_BUFS
Nessun buffer disponibile per far crescere il messaggio.
Guarda anche:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

Liberare un buffer dei messaggi allocato.

Dettagli
Parametri
[in] aMessage
Puntatore a un buffer dei messaggi.
Guarda anche:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Ottieni le informazioni sul buffer dei messaggi.

Dettagli
Parametri
[in] aInstance
Un puntatore all'istanza OpenThread.
[out] aBufferInfo
Puntatore in cui vengono scritte le informazioni sul buffer del messaggio.

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Ottieni la lunghezza del messaggio in byte.

Dettagli
Parametri
[in] aMessage
Puntatore a un buffer dei messaggi.
ritorna
La lunghezza del messaggio in byte.
Guarda anche:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Ottieni l'offset del messaggio in byte.

Dettagli
Parametri
[in] aMessage
Puntatore a un buffer dei messaggi.
ritorna
Il valore di offset del messaggio.
Guarda anche:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Questa funzione restituisce l'RSS medio (intensità del segnale ricevuto) associato al messaggio.

Dettagli
ritorna
Il valore RSS medio (in dBm) o OT_RADIO_RSSI_INVALID se non è disponibile alcun RSS medio.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Questa funzione indica se la protezione del collegamento è abilitata o meno per il messaggio.

Dettagli
Parametri
[in] aMessage
Puntatore a un buffer dei messaggi.
Valori restituiti
TRUE
Se la sicurezza del collegamento è abilitata.
FALSE
Se la sicurezza del collegamento non è abilitata.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Questa funzione rimuove un messaggio dalla coda di messaggi specificata.

Dettagli
Parametri
[in] aQueue
Un puntatore alla coda dei messaggi.
[in] aMessage
Il messaggio da rimuovere.

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Questa funzione aggiunge un messaggio alla fine della coda di messaggi specificata.

Dettagli
Parametri
[in] aQueue
Un puntatore alla coda dei messaggi.
[in] aMessage
Il messaggio da aggiungere.

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Questa funzione aggiunge un messaggio all'inizio / all'inizio della coda di messaggi specificata.

Dettagli
Parametri
[in] aQueue
Un puntatore alla coda dei messaggi.
[in] aMessage
Il messaggio da aggiungere.

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Questa funzione restituisce un puntatore al messaggio all'inizio della coda.

Dettagli
Parametri
[in] aQueue
Un puntatore a una coda di messaggi.
ritorna
Un puntatore al messaggio all'inizio della coda o NULL se la coda è vuota.

otMessageQueueGetNext

otMessage * otMessageQueueGetNext(
  otMessageQueue *aQueue,
  const otMessage *aMessage
)

Questa funzione restituisce un puntatore al messaggio successivo nella coda iterando in avanti (dalla testa alla coda).

Dettagli
Parametri
[in] aQueue
Un puntatore a una coda di messaggi.
[in] aMessage
Un puntatore al buffer dei messaggi corrente.
ritorna
Un puntatore al messaggio successivo nella coda dopo aMessage o NULL se aMessage is the tail of queue. NULL is returned if aMessage is not in the queue aQueue`.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Inizializza la coda dei messaggi.

Questa funzione DEVE essere chiamata una sola volta per un'istanza otMessageQueue prima di qualsiasi altra funzione otMessageQueue . Il comportamento non è definito se altre API della coda vengono utilizzate con un otMessageQueue prima che venga inizializzato o se viene inizializzato più di una volta.

Dettagli
Parametri
[in] aQueue
Un puntatore a una coda di messaggi.

otMessageRead

uint16_t otMessageRead(
  const otMessage *aMessage,
  uint16_t aOffset,
  void *aBuf,
  uint16_t aLength
)

Legge i byte da un messaggio.

Dettagli
Parametri
[in] aMessage
Puntatore a un buffer dei messaggi.
[in] aOffset
Un offset in byte.
[in] aBuf
Puntatore a un buffer in cui vengono letti i byte del messaggio.
[in] aLength
Numero di byte da leggere.
ritorna
Il numero di byte letti.
Guarda anche:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Questa funzione imposta / forza l'inoltro del messaggio utilizzando la trasmissione diretta.

L'impostazione predefinita per un nuovo messaggio è false .

Dettagli
Parametri
[in] aMessage
Puntatore a un buffer dei messaggi.
[in] aEnabled
Se true , il messaggio è costretto a utilizzare la trasmissione diretta. Se false , il messaggio segue la normale procedura.

otMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Imposta la lunghezza del messaggio in byte.

Dettagli
Parametri
[in] aMessage
Puntatore a un buffer dei messaggi.
[in] aLength
Una lunghezza in byte.
Valori restituiti
OT_ERROR_NONE
Impostare correttamente la lunghezza del messaggio.
OT_ERROR_NO_BUFS
Nessun buffer disponibile per far crescere il messaggio.
Guarda anche:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Imposta l'offset del messaggio in byte.

Dettagli
Parametri
[in] aMessage
Puntatore a un buffer dei messaggi.
[in] aOffset
Un offset in byte.
Guarda anche:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

otMessageWrite

int otMessageWrite(
  otMessage *aMessage,
  uint16_t aOffset,
  const void *aBuf,
  uint16_t aLength
)

Scrivi byte in un messaggio.

Dettagli
Parametri
[in] aMessage
Puntatore a un buffer dei messaggi.
[in] aOffset
Un offset in byte.
[in] aBuf
Puntatore a un buffer da cui vengono scritti i byte del messaggio.
[in] aLength
Numero di byte da scrivere.
ritorna
Il numero di byte scritti.
Guarda anche:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead