Сообщение
Этот модуль включает функции, управляющие буферами сообщений OpenThread.
Резюме
Перечисления | |
---|---|
otMessagePriority { | перечисление Это перечисление определяет уровни приоритета сообщений OpenThread. |
Определения типов | |
---|---|
otBufferInfo | определение типаstruct otBufferInfo Эта структура представляет информацию о буфере сообщений для различных очередей, используемых стеком OpenThread. |
otMessage | определение типаstruct otMessage Этот тип является непрозрачным представлением буфера сообщений OpenThread. |
otMessagePriority | определение типаenum otMessagePriority Это перечисление определяет уровни приоритета сообщений OpenThread. |
otMessageQueueInfo | определение типаstruct otMessageQueueInfo Эта структура представляет информацию об очереди сообщений. |
otMessageSettings | определение типаstruct otMessageSettings Эта структура представляет собой настройки сообщения. |
Функции | |
---|---|
otMessageAppend ( otMessage *aMessage, const void *aBuf, uint16_t aLength) | Добавить байты к сообщению. |
otMessageFree ( otMessage *aMessage) | void Освободить выделенный буфер сообщений. |
otMessageGetBufferInfo ( otInstance *aInstance, otBufferInfo *aBufferInfo) | void Получите информацию о буфере сообщений. |
otMessageGetLength (const otMessage *aMessage) | uint16_t Получить длину сообщения в байтах. |
otMessageGetOffset (const otMessage *aMessage) | uint16_t Получите смещение сообщения в байтах. |
otMessageGetRss (const otMessage *aMessage) | int8_t Эта функция возвращает средний RSS (мощность принятого сигнала), связанный с сообщением. |
otMessageIsLinkSecurityEnabled (const otMessage *aMessage) | bool Эта функция указывает, включена ли защита канала для сообщения. |
otMessageQueueDequeue ( otMessageQueue *aQueue, otMessage *aMessage) | void Эта функция удаляет сообщение из заданной очереди сообщений. |
otMessageQueueEnqueue ( otMessageQueue *aQueue, otMessage *aMessage) | void Эта функция добавляет сообщение в конец заданной очереди сообщений. |
otMessageQueueEnqueueAtHead ( otMessageQueue *aQueue, otMessage *aMessage) | void Эта функция добавляет сообщение в начало/перед заданной очереди сообщений. |
otMessageQueueGetHead ( otMessageQueue *aQueue) | Эта функция возвращает указатель на сообщение в начале очереди. |
otMessageQueueGetNext ( otMessageQueue *aQueue, const otMessage *aMessage) | Эта функция возвращает указатель на следующее сообщение в очереди путем итерации вперед (от головы к хвосту). |
otMessageQueueInit ( otMessageQueue *aQueue) | void Инициализировать очередь сообщений. |
otMessageRead (const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength) | uint16_t Чтение байтов из сообщения. |
otMessageSetDirectTransmission ( otMessage *aMessage, bool aEnabled) | void Эта функция устанавливает/заставляет сообщение пересылаться с использованием прямой передачи. |
otMessageSetLength ( otMessage *aMessage, uint16_t aLength) | Установите длину сообщения в байтах. |
otMessageSetOffset ( otMessage *aMessage, uint16_t aOffset) | void Установите смещение сообщения в байтах. |
otMessageWrite ( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength) | int Запись байтов в сообщение. |
Структуры | |
---|---|
otBufferInfo | Эта структура представляет информацию о буфере сообщений для различных очередей, используемых стеком OpenThread. |
otMessageQueue | Эта структура представляет собой очередь сообщений OpenThread. |
otMessageQueueInfo | Эта структура представляет информацию об очереди сообщений. |
otMessageSettings | Эта структура представляет собой настройки сообщения. |
Перечисления
otMessagePriority
otMessagePriority
Определения типов
otBufferInfo
struct otBufferInfo otBufferInfo
Эта структура представляет информацию о буфере сообщений для различных очередей, используемых стеком OpenThread.
сообщение
struct otMessage otMessage
Этот тип является непрозрачным представлением буфера сообщений OpenThread.
otMessagePriority
enum otMessagePriority otMessagePriority
Это перечисление определяет уровни приоритета сообщений OpenThread.
otMessageQueueInfo
struct otMessageQueueInfo otMessageQueueInfo
Эта структура представляет информацию об очереди сообщений.
otMessageSettings
struct otMessageSettings otMessageSettings
Эта структура представляет собой настройки сообщения.
Функции
otMessageAppend
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
Добавить байты к сообщению.
Подробности | |||||||
---|---|---|---|---|---|---|---|
Параметры |
| ||||||
Возвращаемые значения |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageFree
void otMessageFree( otMessage *aMessage )
Освободить выделенный буфер сообщений.
Подробности | |||
---|---|---|---|
Параметры |
|
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
Получите информацию о буфере сообщений.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
|
otMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
Получить длину сообщения в байтах.
Подробности | |||
---|---|---|---|
Параметры |
| ||
Возвращает | Длина сообщения в байтах. |
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
Получите смещение сообщения в байтах.
Подробности | |||
---|---|---|---|
Параметры |
| ||
Возвращает | Значение смещения сообщения. |
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
Эта функция возвращает средний RSS (мощность принятого сигнала), связанный с сообщением.
Подробности | |
---|---|
Возвращает | Среднее значение RSS (в дБм) или OT_RADIO_RSSI_INVALID, если среднее значение RSS отсутствует. |
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
Эта функция указывает, включена ли защита канала для сообщения.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
otMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
Эта функция удаляет сообщение из заданной очереди сообщений.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
|
otMessageQueueEnqueue
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
Эта функция добавляет сообщение в конец заданной очереди сообщений.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
|
otMessageQueueEnqueueAtHead
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
Эта функция добавляет сообщение в начало/перед заданной очереди сообщений.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
Эта функция возвращает указатель на сообщение в начале очереди.
Подробности | |||
---|---|---|---|
Параметры |
| ||
Возвращает | Указатель на сообщение в начале очереди или NULL, если очередь пуста. |
otMessageQueueGetNext
otMessage * otMessageQueueGetNext( otMessageQueue *aQueue, const otMessage *aMessage )
Эта функция возвращает указатель на следующее сообщение в очереди путем итерации вперед (от головы к хвосту).
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращает | Указатель на следующее сообщение в очереди после aMessage или NULL, если aMessage is the tail of queue. NULL is returned if aMessage is not in the queue aQueue`. |
otMessageQueueInit
void otMessageQueueInit( otMessageQueue *aQueue )
Инициализировать очередь сообщений.
Эта функция ДОЛЖНА вызываться один и только один раз для экземпляра otMessageQueue
перед любыми другими функциями otMessageQueue
. Поведение не определено, если другие API-интерфейсы очередей используются с otMessageQueue
до его инициализации или если он инициализируется более одного раза.
Подробности | |||
---|---|---|---|
Параметры |
|
otMessageRead
uint16_t otMessageRead( const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength )
Чтение байтов из сообщения.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||
Возвращает | Количество прочитанных байтов. |
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
otMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
Эта функция устанавливает/заставляет сообщение пересылаться с использованием прямой передачи.
Значение по умолчанию для нового сообщения — false
.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
Установите длину сообщения в байтах.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
| ||||
Возвращаемые значения |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetOffset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
Установите смещение сообщения в байтах.
Подробности | |||||
---|---|---|---|---|---|
Параметры |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite
otMessageWrite
int otMessageWrite( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength )
Запись байтов в сообщение.
Подробности | |||||||||
---|---|---|---|---|---|---|---|---|---|
Параметры |
| ||||||||
Возвращает | Количество записанных байтов. |
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
Ресурсы
Разделы справочника по API OpenThread взяты из исходного кода, доступного на GitHub . Чтобы получить дополнительную информацию или внести свой вклад в нашу документацию, обратитесь к разделу Ресурсы .