Messaggio
Questo modulo include funzioni che manipolano i buffer dei messaggi OpenThread.
Riepilogo
Enumerazioni |
|
---|---|
otMessagePriority{
|
enum Questa enumerazione definisce i livelli di priorità dei messaggi OpenThread. |
Defdef |
|
---|---|
otBufferInfo
|
tipodefstruct otBufferInfo
Questa struttura rappresenta le informazioni relative al buffer dei messaggi per le diverse code utilizzate dallo stack OpenThread. |
otMessage
|
tipodefstruct otMessage
Questo tipo è una rappresentazione opaca di un buffer di messaggio OpenThread. |
otMessagePriority
|
tipodefenum otMessagePriority
Questa enumerazione definisce i livelli di priorità dei messaggi OpenThread. |
otMessageQueueInfo
|
tipodefstruct otMessageQueueInfo
Questa struttura rappresenta le informazioni su una coda di messaggi. |
otMessageSettings
|
tipodefstruct otMessageSettings
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 |
|
||||||
Valori di ritorno |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
OtMessageFree
void otMessageFree( otMessage *aMessage )
Libera un buffer di messaggio assegnato.
Dettagli | |||
---|---|---|---|
Parametri |
|
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
Ricevere le informazioni del buffer di messaggi.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
OtMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
Recupera la lunghezza del messaggio in byte.
Dettagli | |||
---|---|---|---|
Parametri |
|
||
Restituisce |
La lunghezza del messaggio in byte.
|
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
Recupera l'offset del messaggio in byte.
Dettagli | |||
---|---|---|---|
Parametri |
|
||
Restituisce |
Il valore di offset messaggio.
|
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 |
|
||||
Valori di ritorno |
|
OtMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
Questa funzione rimuove un messaggio dalla coda di messaggi specificata.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
otMessageQueueEnqueue
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
Questa funzione aggiunge un messaggio alla fine della coda messaggi.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
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 |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
Questa funzione restituisce un puntatore al messaggio nella parte superiore della coda.
Dettagli | |||
---|---|---|---|
Parametri |
|
||
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 |
|
||||
Restituisce |
Un puntatore al messaggio successivo in coda dopo
aMessage o NULL se aMessage is the tail of queue. NULL is returned if aMessageis not in the queue aQueue`. |
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 |
|
OtMessageRead
uint16_t otMessageRead( const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength )
Leggere i byte da un messaggio.
Dettagli | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametri |
|
||||||||
Restituisce |
Il numero di byte letti.
|
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 |
|
OtMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
Imposta la lunghezza del messaggio in byte.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
||||
Valori di ritorno |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
OtMessageSetOffset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
Imposta l'offset del messaggio in byte.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
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 |
|
||||||||
Restituisce |
Il numero di byte scritti.
|
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.