Сообщение

Этот модуль включает функции, управляющие буферами сообщений OpenThread.

Резюме

Перечисления

otMessagePriority {
OT_MESSAGE_PRIORITY_LOW = 0,
OT_MESSAGE_PRIORITY_NORMAL = 1,
OT_MESSAGE_PRIORITY_HIGH = 2
}		 перечисление
Это перечисление определяет уровни приоритета сообщений OpenThread.

Определения типов

otBufferInfo определение типа
struct otBufferInfo
Эта структура представляет информацию о буфере сообщений для различных очередей, используемых стеком OpenThread.
otMessage определение типа
struct otMessage
Этот тип является непрозрачным представлением буфера сообщений OpenThread.
otMessagePriority определение типа
Это перечисление определяет уровни приоритета сообщений OpenThread.
otMessageQueueInfo определение типа
Эта структура представляет информацию об очереди сообщений.
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

Это перечисление определяет уровни приоритета сообщений OpenThread.

Характеристики
OT_MESSAGE_PRIORITY_HIGH

Высокий уровень приоритета.

OT_MESSAGE_PRIORITY_LOW

Низкий уровень приоритета.

OT_MESSAGE_PRIORITY_NORMAL

Нормальный уровень приоритета.

Определения типов

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
)

Добавить байты к сообщению.

Подробности
Параметры
[in] aMessage
Указатель на буфер сообщений.
[in] aBuf
Указатель на данные для добавления.
[in] aLength
Количество байтов для добавления.
Возвращаемые значения
OT_ERROR_NONE
Успешно добавлено к сообщению
OT_ERROR_NO_BUFS
Нет доступных буферов для увеличения сообщения.
Смотрите также:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

Освободить выделенный буфер сообщений.

Подробности
Параметры
[in] aMessage
Указатель на буфер сообщений.
Смотрите также:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Получите информацию о буфере сообщений.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aBufferInfo
Указатель, куда записывается информация о буфере сообщения.

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Получить длину сообщения в байтах.

Подробности
Параметры
[in] aMessage
Указатель на буфер сообщений.
Возвращает
Длина сообщения в байтах.
Смотрите также:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Получите смещение сообщения в байтах.

Подробности
Параметры
[in] 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
)

Эта функция указывает, включена ли защита канала для сообщения.

Подробности
Параметры
[in] aMessage
Указатель на буфер сообщений.
Возвращаемые значения
TRUE
Если безопасность ссылки включена.
FALSE
Если безопасность ссылки не включена.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Эта функция удаляет сообщение из заданной очереди сообщений.

Подробности
Параметры
[in] aQueue
Указатель на очередь сообщений.
[in] aMessage
Сообщение для удаления.

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Эта функция добавляет сообщение в конец заданной очереди сообщений.

Подробности
Параметры
[in] aQueue
Указатель на очередь сообщений.
[in] aMessage
Сообщение для добавления.

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Эта функция добавляет сообщение в начало/перед заданной очереди сообщений.

Подробности
Параметры
[in] aQueue
Указатель на очередь сообщений.
[in] aMessage
Сообщение для добавления.

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Эта функция возвращает указатель на сообщение в начале очереди.

Подробности
Параметры
[in] aQueue
Указатель на очередь сообщений.
Возвращает
Указатель на сообщение в начале очереди или NULL, если очередь пуста.

otMessageQueueGetNext

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

Эта функция возвращает указатель на следующее сообщение в очереди путем итерации вперед (от головы к хвосту).

Подробности
Параметры
[in] aQueue
Указатель на очередь сообщений.
[in] 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 до его инициализации или если он инициализируется более одного раза.

Подробности
Параметры
[in] aQueue
Указатель на очередь сообщений.

otMessageRead

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

Чтение байтов из сообщения.

Подробности
Параметры
[in] aMessage
Указатель на буфер сообщений.
[in] aOffset
Смещение в байтах.
[in] aBuf
Указатель на буфер, в который считываются байты сообщения.
[in] aLength
Количество байтов для чтения.
Возвращает
Количество прочитанных байтов.
Смотрите также:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Эта функция устанавливает/заставляет сообщение пересылаться с использованием прямой передачи.

Значение по умолчанию для нового сообщения — false .

Подробности
Параметры
[in] aMessage
Указатель на буфер сообщений.
[in] aEnabled
Если true , сообщение принудительно использует прямую передачу. Если false , сообщение следует обычной процедуре.

otMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Установите длину сообщения в байтах.

Подробности
Параметры
[in] aMessage
Указатель на буфер сообщений.
[in] aLength
Длина в байтах.
Возвращаемые значения
OT_ERROR_NONE
Длина сообщения установлена ​​успешно.
OT_ERROR_NO_BUFS
Нет доступных буферов для увеличения сообщения.
Смотрите также:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Установите смещение сообщения в байтах.

Подробности
Параметры
[in] aMessage
Указатель на буфер сообщений.
[in] aOffset
Смещение в байтах.
Смотрите также:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

otMessageWrite

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

Запись байтов в сообщение.

Подробности
Параметры
[in] aMessage
Указатель на буфер сообщений.
[in] aOffset
Смещение в байтах.
[in] aBuf
Указатель на буфер, из которого записываются байты сообщения.
[in] aLength
Количество байтов для записи.
Возвращает
Количество записанных байтов.
Смотрите также:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

Ресурсы

Разделы справочника по API OpenThread взяты из исходного кода, доступного на GitHub . Чтобы получить дополнительную информацию или внести свой вклад в нашу документацию, обратитесь к разделу Ресурсы .