przekaz,

Ten moduł zawiera funkcje modyfikujące bufory wiadomości OpenThread.

Podsumowanie

Wyliczenia
otMessageOrigin{
  OT_MESSAGE_ORIGIN_THREAD_NETIF = 0,
  OT_MESSAGE_ORIGIN_HOST_TRUSTED = 1,
  OT_MESSAGE_ORIGIN_HOST_UNTRUSTED = 2
} 		enum | typ wyliczeniowy
Definiuje źródła wiadomości OpenThread.
otMessagePriority{
  OT_MESSAGE_PRIORITY_LOW = 0,
  OT_MESSAGE_PRIORITY_NORMAL = 1,
  OT_MESSAGE_PRIORITY_HIGH = 2
} 		enum | typ wyliczeniowy
Określa poziomy priorytetu wiadomości w OpenThread.

Definicje typów
otBufferInfo typedef
struct otBufferInfo
Reprezentuje informacje o buforze wiadomości dla różnych kolejek używanych przez stos OpenThread.
otMessage typedef
struct otMessage
Nieprzejrzyste przedstawienie bufora wiadomości OpenThread.
otMessageOrigin typedef
Definiuje źródła wiadomości OpenThread.
otMessagePriority typedef
Określa poziomy priorytetu wiadomości w OpenThread.
otMessageQueueInfo typedef
Reprezentuje informacje o kolejce wiadomości.
otMessageSettings typedef
Reprezentuje ustawienia wiadomości.

Funkcje
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
Dołącz bajty do wiadomości.
otMessageFree(otMessage *aMessage)
void
Zwalnianie przydzielonego bufora wiadomości.
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
void
Uzyskiwanie informacji Bufor wiadomości.
otMessageGetLength(const otMessage *aMessage)
uint16_t
Uzyskaj długość wiadomości w bajtach.
otMessageGetOffset(const otMessage *aMessage)
uint16_t
Obliczanie przesunięcia wiadomości w bajtach.
otMessageGetOrigin(const otMessage *aMessage)
Pobiera źródło wiadomości.
otMessageGetRss(const otMessage *aMessage)
int8_t
Zwraca średnią wartość RSS (siłę odbieranego sygnału) powiązaną z wiadomością.
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
bool
Wskazuje, czy zabezpieczenia połączenia są włączone dla wiadomości.
otMessageIsLoopbackToHostAllowed(const otMessage *aMessage)
bool
Wskazuje, czy można zapętlić wiadomość z powrotem do hosta.
otMessageIsMulticastLoopEnabled(otMessage *aMessage)
bool
Wskazuje, czy komunikat może zostać zapętlony w przypadku adresu miejsca docelowego multiemisji.
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
void
Usuwa wiadomość z danej kolejki wiadomości.
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
void
Dodaje wiadomość na końcu danej kolejki wiadomości.
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
void
Dodaje wiadomość na początku/na początku danej kolejki wiadomości.
otMessageQueueGetHead(otMessageQueue *aQueue)
Zwraca wskaźnik do wiadomości w nagłówku kolejki.
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
Zwraca wskaźnik do następnej wiadomości w kolejce przez powtarzanie kodu w przód (od głowy do ogona).
otMessageQueueInit(otMessageQueue *aQueue)
void
Inicjowanie kolejki wiadomości.
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
uint16_t
Przeczytane bajty z wiadomości.
otMessageResetBufferInfo(otInstance *aInstance)
void
Zresetuj licznik informacji Bufor wiadomości śledzący maksymalną liczbę buforów używanych jednocześnie.
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
void
Powoduje lub wymusza przekazanie wiadomości w sposób bezpośredni.
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
Ustaw długość wiadomości w bajtach.
otMessageSetLoopbackToHostAllowed(otMessage *aMessage, bool aAllowLoopbackToHost)
void
Określa, czy wiadomość może być zapętlona z powrotem do hosta.
otMessageSetMulticastLoopEnabled(otMessage *aMessage, bool aEnabled)
void
Określa, czy dana wiadomość może być zapętlona w przypadku adresu miejsca docelowego multiemisji.
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
void
Ustaw przesunięcie wiadomości w bajtach.
otMessageSetOrigin(otMessage *aMessage, otMessageOrigin aOrigin)
void
Ustawia źródło wiadomości.
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
int
Zapisuj bajty w wiadomości.

Konstrukcja
otBufferInfo

Reprezentuje informacje o buforze wiadomości dla różnych kolejek używanych przez stos OpenThread.

otMessageQueue

Reprezentuje kolejkę wiadomości OpenThread.

otMessageQueueInfo

Reprezentuje informacje o kolejce wiadomości.

otMessageSettings

Reprezentuje ustawienia wiadomości.

Wyliczenia

otMessageOrigin

 otMessageOrigin

Definiuje źródła wiadomości OpenThread.

Właściwości
OT_MESSAGE_ORIGIN_HOST_TRUSTED

Wiadomość z zaufanego źródła na hoście.

OT_MESSAGE_ORIGIN_HOST_UNTRUSTED

Wiadomość z niezaufanego źródła na hoście.

OT_MESSAGE_ORIGIN_THREAD_NETIF

Wiadomość od Thread Netif.

otMessagePriority

 otMessagePriority

Określa poziomy priorytetu wiadomości w OpenThread.

Właściwości
OT_MESSAGE_PRIORITY_HIGH

Wysoki priorytet.

OT_MESSAGE_PRIORITY_LOW

Niski priorytet.

OT_MESSAGE_PRIORITY_NORMAL

Zwykły priorytet.

Definicje typów

otBufferInfo

struct otBufferInfo otBufferInfo

Reprezentuje informacje o buforze wiadomości dla różnych kolejek używanych przez stos OpenThread.

otMessage

struct otMessage otMessage

Nieprzejrzyste przedstawienie bufora wiadomości OpenThread.

otMessageOrigin

enum otMessageOrigin otMessageOrigin

Definiuje źródła wiadomości OpenThread.

otMessagePriority

enum otMessagePriority otMessagePriority

Określa poziomy priorytetu wiadomości w OpenThread.

otMessageQueueInfo

struct otMessageQueueInfo otMessageQueueInfo

Reprezentuje informacje o kolejce wiadomości.

otMessageSettings

struct otMessageSettings otMessageSettings

Reprezentuje ustawienia wiadomości.

Funkcje

otMessageAppend

otError otMessageAppend(
  otMessage *aMessage,
  const void *aBuf,
  uint16_t aLength
)

Dołącz bajty do wiadomości.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
[in] aBuf
Wskaźnik danych, które mają zostać dołączone.
[in] aLength
Liczba bajtów do dołączenia.
Zwracane wartości
OT_ERROR_NONE
Dołączono do wiadomości
OT_ERROR_NO_BUFS
Brak dostępnych buforów, w których można rozwijać wiadomość.
Zobacz też:
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageFree

void otMessageFree(
  otMessage *aMessage
)

Zwalnianie przydzielonego bufora wiadomości.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
Zobacz też:
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetBufferInfo

void otMessageGetBufferInfo(
  otInstance *aInstance,
  otBufferInfo *aBufferInfo
)

Uzyskiwanie informacji Bufor wiadomości.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.
[out] aBufferInfo
Wskaźnik, w którym zapisywane są informacje o buforze wiadomości.

otMessageGetLength

uint16_t otMessageGetLength(
  const otMessage *aMessage
)

Uzyskaj długość wiadomości w bajtach.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
Zwroty
Długość wiadomości w bajtach.
Zobacz też:
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetLength

otMessageGetOffset

uint16_t otMessageGetOffset(
  const otMessage *aMessage
)

Obliczanie przesunięcia wiadomości w bajtach.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
Zwroty
Wartość opóźnienia wiadomości.
Zobacz też:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageGetOrigin

otMessageOrigin otMessageGetOrigin(
  const otMessage *aMessage
)

Pobiera źródło wiadomości.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
Zwroty
Źródło wiadomości.

otMessageGetRss

int8_t otMessageGetRss(
  const otMessage *aMessage
)

Zwraca średnią wartość RSS (siłę odbieranego sygnału) powiązaną z wiadomością.

Szczegóły
Zwroty
Średnia wartość RSS (w dBm) lub OT_RADIO_RSSI_Nieprawidłowe, jeśli nie jest dostępny średni kanał RSS.

otMessageIsLinkSecurityEnabled

bool otMessageIsLinkSecurityEnabled(
  const otMessage *aMessage
)

Wskazuje, czy zabezpieczenia połączenia są włączone dla wiadomości.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
Zwracane wartości
TRUE
Jeśli zabezpieczenia połączenia są włączone.
FALSE
Jeśli zabezpieczenia połączeń nie są włączone.

otMessageIsLoopbackToHostAllowed

bool otMessageIsLoopbackToHostAllowed(
  const otMessage *aMessage
)

Wskazuje, czy można zapętlić wiadomość z powrotem do hosta.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
Zwracane wartości
TRUE
Czy istnieje możliwość zapętlenia wiadomości?
FALSE
Jeśli nie można zapętlić wiadomości z powrotem do hosta,

otMessageIsMulticastLoopEnabled

bool otMessageIsMulticastLoopEnabled(
  otMessage *aMessage
)

Wskazuje, czy komunikat może zostać zapętlony w przypadku adresu miejsca docelowego multiemisji.

Jeśli pole aMessage jest używane razem z polem otMessageInfo, pole mMulticastLoop ze struktury otMessageInfo ma pierwszeństwo i będzie używane zamiast wartości ustawionej w zasadzie aMessage.

Ten interfejs API jest przeznaczony do użycia głównie z interfejsem otIp6Send(), który wymaga gotowego komunikatu IPv6.

Szczegóły
Parametry
[in] aMessage
Wskaźnik wiadomości.

otMessageQueueDequeue

void otMessageQueueDequeue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Usuwa wiadomość z danej kolejki wiadomości.

Szczegóły
Parametry
[in] aQueue
Wskaźnik do kolejki wiadomości.
[in] aMessage
Wiadomość do usunięcia.

otMessageQueueEnqueue

void otMessageQueueEnqueue(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Dodaje wiadomość na końcu danej kolejki wiadomości.

Szczegóły
Parametry
[in] aQueue
Wskaźnik do kolejki wiadomości.
[in] aMessage
Wiadomość do dodania.

otMessageQueueEnqueueAtHead

void otMessageQueueEnqueueAtHead(
  otMessageQueue *aQueue,
  otMessage *aMessage
)

Dodaje wiadomość na początku/na początku danej kolejki wiadomości.

Szczegóły
Parametry
[in] aQueue
Wskaźnik do kolejki wiadomości.
[in] aMessage
Wiadomość do dodania.

otMessageQueueGetHead

otMessage * otMessageQueueGetHead(
  otMessageQueue *aQueue
)

Zwraca wskaźnik do wiadomości w nagłówku kolejki.

Szczegóły
Parametry
[in] aQueue
Wskaźnik do kolejki wiadomości.
Zwroty
Wskaźnik do wiadomości w nagłówku kolejki lub wartość NULL, jeśli kolejka jest pusta.

otMessageQueueGetNext

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

Zwraca wskaźnik do następnej wiadomości w kolejce przez powtarzanie kodu w przód (od głowy do ogona).

Szczegóły
Parametry
[in] aQueue
Wskaźnik do kolejki wiadomości.
[in] aMessage
Wskaźnik do aktualnego bufora wiadomości.
Zwroty
Wskaźnik do następnej wiadomości w kolejce po aMessage lub wartość NULL, jeśli aMessage is the tail of queue. NULL is returned ifaMessageis not in the queueaQueue`.

otMessageQueueInit

void otMessageQueueInit(
  otMessageQueue *aQueue
)

Inicjowanie kolejki wiadomości.

MUSI być wywoływana raz i tylko raz w przypadku instancji otMessageQueue przed innymi funkcjami otMessageQueue. Jeśli przed zainicjowaniem otMessageQueue użyto innych interfejsów API kolejki, to zachowanie jest nieokreślone lub jeśli zostanie on zainicjowany więcej niż raz.

Szczegóły
Parametry
[in] aQueue
Wskaźnik do kolejki wiadomości.

otMessageRead

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

Przeczytane bajty z wiadomości.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
[in] aOffset
Przesunięcie w bajtach.
[in] aBuf
Wskaźnik do bufora, do którego są odczytywane bajty wiadomości.
[in] aLength
Liczba bajtów do odczytania.
Zwroty
Liczba odczytanych bajtów.
Zobacz też:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite

otMessageResetBufferInfo

void otMessageResetBufferInfo(
  otInstance *aInstance
)

Zresetuj licznik informacji Bufor wiadomości śledzący maksymalną liczbę buforów używanych jednocześnie.

Spowoduje to zresetowanie przeglądarki mMaxUsedBuffers w zasobie otBufferInfo.

Szczegóły
Parametry
[in] aInstance
Wskaźnik do instancji OpenThread.

otMessageSetDirectTransmission

void otMessageSetDirectTransmission(
  otMessage *aMessage,
  bool aEnabled
)

Powoduje lub wymusza przekazanie wiadomości w sposób bezpośredni.

Domyślne ustawienie nowej wiadomości to false.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
[in] aEnabled
Jeśli ma wartość true, wiadomość jest wymuszana przez transmisję bezpośrednią. Jeśli false, wiadomość jest wyświetlana zgodnie z zwykłą procedurą.

otMessageSetLength

otError otMessageSetLength(
  otMessage *aMessage,
  uint16_t aLength
)

Ustaw długość wiadomości w bajtach.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
[in] aLength
Długość w bajtach.
Zwracane wartości
OT_ERROR_NONE
Długość wiadomości została ustawiona.
OT_ERROR_NO_BUFS
Brak dostępnych buforów, w których można rozwijać wiadomość.
Zobacz też:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite

otMessageSetLoopbackToHostAllowed

void otMessageSetLoopbackToHostAllowed(
  otMessage *aMessage,
  bool aAllowLoopbackToHost
)

Określa, czy wiadomość może być zapętlona z powrotem do hosta.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
[in] aAllowLoopbackToHost
Określa, czy zezwolić na zapętlenie wiadomości z powrotem do hosta.

otMessageSetMulticastLoopEnabled

void otMessageSetMulticastLoopEnabled(
  otMessage *aMessage,
  bool aEnabled
)

Określa, czy dana wiadomość może być zapętlona w przypadku adresu miejsca docelowego multiemisji.

Szczegóły
Parametry
[in] aMessage
Wskaźnik wiadomości.
[in] aEnabled
Wartość konfiguracji.

otMessageSetOffset

void otMessageSetOffset(
  otMessage *aMessage,
  uint16_t aOffset
)

Ustaw przesunięcie wiadomości w bajtach.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
[in] aOffset
Przesunięcie w bajtach.
Zobacz też:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite

otMessageSetOrigin

void otMessageSetOrigin(
  otMessage *aMessage,
  otMessageOrigin aOrigin
)

Ustawia źródło wiadomości.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
[in] aOrigin
Źródło wiadomości.

otMessageWrite

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

Zapisuj bajty w wiadomości.

Szczegóły
Parametry
[in] aMessage
Wskaźnik do bufora wiadomości.
[in] aOffset
Przesunięcie w bajtach.
[in] aBuf
Wskaźnik do bufora, z którego zapisywane są bajty wiadomości.
[in] aLength
Liczba bajtów do zapisania.
Zwroty
Liczba zapisanych bajtów.
Zobacz też:
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead

Zasoby

Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, skorzystaj z sekcji Zasoby.