Messaggio

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

Riepilogo

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.

Defdef
otBufferInfo tipodef
struct otBufferInfo
Questa struttura rappresenta le informazioni relative al buffer dei messaggi per le diverse code utilizzate dallo stack OpenThread.
otMessage tipodef
struct otMessage
Questo tipo è una rappresentazione opaca di un buffer di messaggio OpenThread.
otMessagePriority tipodef
Questa enumerazione definisce i livelli di priorità dei messaggi OpenThread.
otMessageQueueInfo tipodef
Questa struttura rappresenta le informazioni su una coda di messaggi.
otMessageSettings tipodef
Questa struttura rappresenta un'impostazione del messaggio.

Functions
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
Aggiungi byte a un messaggio.
otMessageFree(otMessage *aMessage)
void
Libera un buffer di messaggio assegnato.
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Ricevere le informazioni del buffer di messaggi.
otMessageGetLength(const otMessage *aMessage)
uint16_t
Recupera la lunghezza del messaggio in byte.
otMessageGetOffset(const otMessage *aMessage)
uint16_t
Recupera l'offset del messaggio in byte.
otMessageGetRss(const otMessage *aMessage)
int8_t
Questa funzione restituisce la media RSS (intensità del segnale ricevuta) associata al messaggio.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
Questa funzione indica se la sicurezza dei link è 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 messaggi.
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
void
Questa funzione consente di aggiungere un messaggio all'inizio o alla parte anteriore della coda di messaggi specificata.
otMessageQueueGetHead(otMessageQueue *aQueue)
Questa funzione restituisce un puntatore al messaggio nella parte superiore della coda.
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
Questa funzione restituisce un puntatore al messaggio successivo in coda ripetendo l'iterazione (da testa a coda).
otMessageQueueInit(otMessageQueue *aQueue)
void
Inizializzare la coda dei messaggi.
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Leggere 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 i byte in un messaggio.

Strutture
Info OtBuffer

Questa struttura rappresenta le informazioni relative al buffer dei messaggi per le diverse code utilizzate dallo stack OpenThread.

otMessageQueue

Questa struttura rappresenta una coda di messaggi OpenThread.

otMessageQueueInfo

Questa struttura rappresenta le informazioni su una coda di messaggi.

otMessageSettings

Questa struttura rappresenta un'impostazione del messaggio.

Enumerazioni

Priorità messaggio

 otMessagePriority

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

Proprietà
OT_MESSAGE_PRIORITY_HIGH

Livello di priorità alto.

OT_MESSAGE_PRIORITY_LOW

Livello di priorità basso.

OT_MESSAGE_PRIORITY_NORMAL

Livello di priorità normale.

Defdef

Informazioni otBuffer

struct otBufferInfo otBufferInfo

Questa struttura rappresenta le informazioni relative al buffer dei messaggi per le diverse code utilizzate dallo stack OpenThread.

Messaggio Ot

struct otMessage otMessage

Questo tipo è una rappresentazione opaca di un buffer di messaggio OpenThread.

Priorità messaggio

enum otMessagePriority otMessagePriority

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

Informazioni otMessageQueue

struct otMessageQueueInfo otMessageQueueInfo

Questa struttura rappresenta le informazioni su una coda di messaggi.

OtMessageSettings

struct otMessageSettings otMessageSettings

Questa struttura rappresenta un'impostazione del messaggio.

Functions

OtMessageAppend

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

Aggiungi byte a un messaggio.

Dettagli
Parametri
[in] aMessage
Un puntatore su un buffer di messaggio.
[in] aBuf
Un puntatore sui dati da aggiungere.
[in] aLength
Numero di byte da aggiungere.
Valori di ritorno
OT_ERROR_NONE
Aggiunto al messaggio
OT_ERROR_NO_BUFS
Nessun buffer disponibile per far crescere il messaggio.
Vedi anche:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

OtMessageFree

void otMessageFree(
  otMessage *aMessage
)

Libera un buffer di messaggio assegnato.

Dettagli
Parametri
[in] aMessage
Un puntatore su un buffer di messaggio.
Vedi anche:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Ricevere le informazioni del buffer di messaggi.

Dettagli
Parametri
[in] aInstance
Un puntatore sull'istanza di OpenThread.
[out] aBufferInfo
Un puntatore in cui sono scritte le informazioni relative al buffer del messaggio.

OtMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Recupera la lunghezza del messaggio in byte.

Dettagli
Parametri
[in] aMessage
Un puntatore su un buffer di messaggio.
Restituisce
La lunghezza del messaggio in byte.
Vedi anche:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Recupera l'offset del messaggio in byte.

Dettagli
Parametri
[in] aMessage
Un puntatore su un buffer di messaggio.
Restituisce
Il valore di offset messaggio.
Vedi anche:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

OtMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Questa funzione restituisce la media RSS (intensità del segnale ricevuta) associata al messaggio.

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

OtMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Questa funzione indica se la sicurezza dei link è abilitata o meno per il messaggio.

Dettagli
Parametri
[in] aMessage
Un puntatore su un buffer di messaggio.
Valori di ritorno
TRUE
Se la sicurezza dei link è attivata.
FALSE
Se la sicurezza dei link non è attiva.

OtMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Questa funzione rimuove un messaggio dalla coda di messaggi specificata.

Dettagli
Parametri
[in] aQueue
Un puntatore sulla 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 messaggi.

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

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Questa funzione consente di aggiungere un messaggio all'inizio o alla parte anteriore della coda di messaggi specificata.

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

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Questa funzione restituisce un puntatore al messaggio nella parte superiore della coda.

Dettagli
Parametri
[in] aQueue
Un puntatore sulla coda di un messaggio.
Restituisce
Un puntatore al messaggio in cima alla coda o a NULL, se la coda è vuota.

otMessageQueueGetNext

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

Questa funzione restituisce un puntatore al messaggio successivo in coda ripetendo l'iterazione (da testa a coda).

Dettagli
Parametri
[in] aQueue
Un puntatore sulla coda di un messaggio.
[in] aMessage
Un puntatore al buffer del messaggio corrente.
Restituisce
Un puntatore al messaggio successivo in coda dopo aMessage o NULL se aMessage is the tail of queue. NULL is returned ifaMessageis not in the queueaQueue`.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Inizializzare la coda dei messaggi.

Questa funzione DEVE essere richiamata una sola volta per un'istanza otMessageQueue prima di qualsiasi altra funzione otMessageQueue. Il comportamento non è definito se vengono usate altre API in coda con un otMessageQueue prima dell'inizializzazione o se viene inizializzato più di una volta.

Dettagli
Parametri
[in] aQueue
Un puntatore sulla coda di un messaggio.

OtMessageRead

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

Leggere i byte da un messaggio.

Dettagli
Parametri
[in] aMessage
Un puntatore su un buffer di messaggio.
[in] aOffset
Un offset in byte.
[in] aBuf
Un puntatore a un buffer a cui vengono letti i byte del messaggio.
[in] aLength
Numero di byte da leggere.
Restituisce
Il numero di byte letti.
Vedi 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
Un puntatore su un buffer di messaggio.
[in] aEnabled
In caso di true, il messaggio è stato forzato a utilizzare la trasmissione diretta. Se false, il messaggio segue la procedura normale.

OtMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Imposta la lunghezza del messaggio in byte.

Dettagli
Parametri
[in] aMessage
Un puntatore su un buffer di messaggio.
[in] aLength
Lunghezza in byte.
Valori di ritorno
OT_ERROR_NONE
Impostazione della lunghezza del messaggio riuscita.
OT_ERROR_NO_BUFS
Nessun buffer disponibile per far crescere il messaggio.
Vedi 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
Un puntatore su un buffer di messaggio.
[in] aOffset
Un offset in byte.
Vedi anche:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

OtMessageWrite

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

Scrivi i byte in un messaggio.

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

Risorse

Gli argomenti di riferimento per l'API OpenThread provengono dal codice sorgente, disponibile su GitHub. Per ulteriori informazioni o per contribuire alla nostra documentazione, consulta la sezione Risorse.