Messaggio
Questo modulo include funzioni che manipolano i buffer di messaggio OpenThread.
Riepilogo
Enumerazioni |
|
---|---|
otMessagePriority{
|
enum Definisce i livelli di priorità dei messaggi OpenThread. |
Definizione di tipo |
|
---|---|
otBufferInfo
|
typedefstruct otBufferInfo
Rappresenta le informazioni del buffer del messaggio per le diverse code utilizzate dallo stack OpenThread. |
otMessage
|
typedefstruct otMessage
Rappresentazione opaca di un buffer di messaggio OpenThread. |
otMessagePriority
|
typedefenum otMessagePriority
Definisce i livelli di priorità dei messaggi OpenThread. |
otMessageQueueInfo
|
typedefstruct otMessageQueueInfo
Rappresenta le informazioni su una coda di messaggi. |
otMessageSettings
|
typedefstruct otMessageSettings
Rappresenta le impostazioni di un messaggio. |
Funzioni |
|
---|---|
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
|
Aggiungi byte a un messaggio.
|
otMessageFree(otMessage *aMessage)
|
void
Buffer di messaggio assegnato.
|
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
|
void
Recupera le informazioni sul buffer di messaggio.
|
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
Restituisce il valore RSS medio (intensità del segnale ricevuto) associato al messaggio.
|
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
|
bool
Indica se la sicurezza dei link è attivata o meno per il messaggio.
|
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
Rimuove un messaggio dalla coda di messaggi specificata.
|
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
Aggiunge un messaggio alla fine della coda di messaggi specificata.
|
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
|
void
Aggiunge un messaggio all'inizio/prima della coda di messaggi specificata.
|
otMessageQueueGetHead(otMessageQueue *aQueue)
|
Restituisce un puntatore al messaggio nella parte superiore della coda.
|
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
|
Restituisce un puntatore al messaggio successivo in coda ripetendo l'iterazione (da una riga all'altra).
|
otMessageQueueInit(otMessageQueue *aQueue)
|
void
Inizializzare la coda di messaggi.
|
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
|
uint16_t
Leggere i byte da un messaggio.
|
otMessageResetBufferInfo(otInstance *aInstance)
|
void
Reimposta il contatore delle informazioni del buffer di messaggio per il monitoraggio del numero massimo di buffer in uso contemporaneamente.
|
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
|
void
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 su Buffer |
Rappresenta le informazioni del buffer del messaggio per le diverse code utilizzate dallo stack OpenThread. |
otMessageQueue |
Rappresenta una coda di messaggi OpenThread. |
otMessageQueueInfo |
Rappresenta le informazioni su una coda di messaggi. |
Impostazioni Messaggi |
Rappresenta le impostazioni di un messaggio. |
Enumerazioni
Priorità messaggio ot
otMessagePriority
Definisce i livelli di priorità dei messaggi OpenThread.
Proprietà | |
---|---|
OT_MESSAGE_PRIORITY_HIGH
|
Livello di priorità elevato. |
OT_MESSAGE_PRIORITY_LOW
|
Livello di priorità basso. |
OT_MESSAGE_PRIORITY_NORMAL
|
Livello di priorità normale. |
Definizione di tipo
OtBufferInfo
struct otBufferInfo otBufferInfo
Rappresenta le informazioni del buffer del messaggio per le diverse code utilizzate dallo stack OpenThread.
messaggio Ot
struct otMessage otMessage
Rappresentazione opaca di un buffer di messaggio OpenThread.
Priorità messaggio ot
enum otMessagePriority otMessagePriority
Definisce i livelli di priorità dei messaggi OpenThread.
Informazioni otMessageQueue
struct otMessageQueueInfo otMessageQueueInfo
Rappresenta le informazioni su una coda di messaggi.
Impostazioni messaggio ot
struct otMessageSettings otMessageSettings
Rappresenta le impostazioni di un messaggio.
Funzioni
Aggiungi otMessaggio
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
Aggiungi byte a un messaggio.
Dettagli | |||||||
---|---|---|---|---|---|---|---|
Parametri |
|
||||||
Valori restituiti |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
OtMessageFree
void otMessageFree( otMessage *aMessage )
Buffer di messaggio assegnato.
Dettagli | |||
---|---|---|---|
Parametri |
|
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
OtMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
Recupera le informazioni sul buffer di messaggio.
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
otMessageSetOffset
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWritet
{
OtMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
Recupera l'offset del messaggio in byte.
Dettagli | |||
---|---|---|---|
Parametri |
|
||
Restituisce |
Il valore di offset del messaggio.
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
OtMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
Restituisce il valore RSS medio (intensità del segnale ricevuto) associato al messaggio.
Dettagli | |
---|---|
Restituisce |
Il valore RSS medio (in dBm) o OT_RADIO_RSSI_INVALID se non è disponibile alcun RSS medio.
|
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
Indica se la sicurezza dei link è attivata o meno per il messaggio.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
||||
Valori restituiti |
|
OdeMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
Rimuove un messaggio dalla coda di messaggi specificata.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
Sequenza di messaggi
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
Aggiunge un messaggio alla fine della coda di messaggi specificata.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
otMessageQueueEnqueueAtHead
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
Aggiunge un messaggio all'inizio/prima della coda di messaggi specificata.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
OtMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
Restituisce un puntatore al messaggio nella parte superiore della coda.
Dettagli | |||
---|---|---|---|
Parametri |
|
||
Restituisce |
Un puntatore al messaggio in cima alla coda o NULL se la coda è vuota.
|
OtMessageQueueGetNext
otMessage * otMessageQueueGetNext( otMessageQueue *aQueue, const otMessage *aMessage )
Restituisce un puntatore al messaggio successivo in coda ripetendo l'iterazione (da una riga all'altra).
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 di messaggi.
DEVE essere chiamato una volta e una sola volta per un'istanza otMessageQueue
prima di qualsiasi altra funzione di otMessageQueue
. Il comportamento non è definito se vengono utilizzate altre API di coda con otMessageQueue
prima dell'inizializzazione o se vengono inizializzate 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
OtMessageResetBufferInfo
void otMessageResetBufferInfo( otInstance *aInstance )
Reimposta il contatore delle informazioni del buffer di messaggio per il monitoraggio del numero massimo di buffer in uso contemporaneamente.
Questa azione reimposta mMaxUsedBuffers
in otBufferInfo
.
Dettagli | |||
---|---|---|---|
Parametri |
|
OtMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
Imposta/forza l'inoltro del messaggio utilizzando la trasmissione diretta.
L'impostazione predefinita per un nuovo messaggio è false
.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
Lunghezza set messaggi
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
Imposta la lunghezza del messaggio in byte.
Dettagli | |||||
---|---|---|---|---|---|
Parametri |
|
||||
Valori restituiti |
|
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
Scrittura messaggio
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 maggiori informazioni o per contribuire alla nostra documentazione, consulta Risorse.