Сообщение

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

Резюме

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

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

Typedefs

otBufferInfo typedef
struct otBufferInfo
Эта структура представляет информацию о буфере сообщений.
otMessage typedef
struct otMessage
Этот тип является непрозрачным представлением буфера сообщений OpenThread.
otMessagePriority typedef
Это перечисление определяет уровни приоритета сообщения OpenThread.
otMessageSettings typedef
Эта структура представляет собой настройки сообщения.

Функции

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

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

otMessageQueue

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

otMessageSettings

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

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

otMessagePriority

 otMessagePriority

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

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

Уровень высокого приоритета.

OT_MESSAGE_PRIORITY_LOW

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

OT_MESSAGE_PRIORITY_NORMAL

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

Typedefs

otBufferInfo

struct otBufferInfo otBufferInfo

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

otMessage

struct otMessage otMessage

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

otMessagePriority

enum otMessagePriority otMessagePriority

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

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