espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-09-08 10:10:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Message API cleanup.

Browse Source
This commit is contained in:
Jonathan Hui
2017-03-02 10:24:55 -08:00
parent 77bc491c56
commit 1455b612f9
27 changed files with 323 additions and 304 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/Makefile.am
-1
View File
@@ -69,7 +69,6 @@ include_HEADERS = \
openthread-icmp6.h \
openthread-ip6.h \
openthread-jam-detection.h \
openthread-message.h \
openthread-types.h \
$(NULL)
include/openthread-icmp6.h
+1 -1
View File
@@ -36,7 +36,7 @@
#define OPENTHREAD_ICMP6_H_
#include <openthread-types.h>
#include <openthread-message.h>
#include <openthread/message.h>
#ifdef __cplusplus
extern "C" {
include/openthread-ip6.h
+1 -1
View File
@@ -35,7 +35,7 @@
#ifndef OPENTHREAD_IP6_H_
#define OPENTHREAD_IP6_H_
#include <openthread-message.h>
#include "openthread/message.h"
#include <platform/radio.h>
#ifdef __cplusplus
include/openthread-types.h
+5 -28
View File
@@ -344,6 +344,11 @@ typedef struct otMessageInfo
const void *mLinkInfo; ///< A pointer to link-specific information.
} otMessageInfo;
/**
* This type points to an OpenThread message buffer.
*/
typedef void *otMessage;
/**
* @addtogroup commands Commands
*
@@ -974,34 +979,6 @@ typedef struct
uint16_t mSecretKeyLength; ///< Secret key length in bytes. Should be at least 16 bytes == 128 bits.
} otSemanticallyOpaqueIidGeneratorData;
/**
* @addtogroup messages Message Buffers
*
* @brief
* This module includes functions that manipulate OpenThread message buffers
*
* @{
*
*/
/**
* This type points to an OpenThread message buffer.
*/
typedef void *otMessage;
/**
* This structure represents an OpenThread message queue.
*/
typedef struct
{
void *mData; ///< Opaque data used by the implementation.
} otMessageQueue;
/**
* @}
*
*/
/**
* @addtogroup icmp6 ICMPv6
*
include/openthread.h
+1 -9
View File
@@ -37,6 +37,7 @@
#include <openthread-types.h>
#include "openthread/message.h"
#include "openthread/tasklet.h"
#ifdef __cplusplus
@@ -2004,15 +2005,6 @@ OTAPI ThreadError OTCALL otSendDiagnosticReset(otInstance *aInstance, const otIp
*/
OTAPI const otMacCounters *OTCALL otGetMacCounters(otInstance *aInstance);
/**
* Get the Message Buffer information.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[out] aBufferInfo A pointer where the message buffer information is written.
*
*/
OTAPI void OTCALL otGetMessageBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo);
/**
* @}
*
include/openthread/Makefile.am
+1
View File
@@ -30,6 +30,7 @@ include $(abs_top_nlbuild_autotools_dir)/automake/pre.am
openthread_headers = \
coap.h \
message.h \
tasklet.h \
udp.h \
$(NULL)
include/openthread/coap.h
+1
View File
@@ -44,6 +44,7 @@
#include <stdint.h>
#include "openthread-types.h"
#include "openthread/message.h"
#ifdef __cplusplus
extern "C" {
include/openthread-message.h → include/openthread/message.h
+84 -95
View File
@@ -35,32 +35,12 @@
#ifndef OPENTHREAD_MESSAGE_H_
#define OPENTHREAD_MESSAGE_H_
#include <openthread-types.h>
#include "openthread-types.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup api API
* @brief
* This module includes the application programming interface to the OpenThread stack.
*
* @{
*
* @defgroup execution Execution
* @defgroup commands Commands
* @defgroup config Configuration
* @defgroup diags Diagnostics
* @defgroup messages Message Buffers
* @defgroup ip6 IPv6
* @defgroup udp UDP
* @defgroup coap CoAP
*
* @}
*
*/
/**
* @addtogroup messages Message Buffers
*
@@ -78,16 +58,15 @@ extern "C" {
*
* @retval kThreadErrorNone Successfully freed the message buffer.
*
* @sa otNewUdpMessage
* @sa otAppendMessage
* @sa otGetMessageLength
* @sa otSetMessageLength
* @sa otGetMessageOffset
* @sa otSetMessageOffset
* @sa otReadMessage
* @sa otWriteMessage
* @sa otMessageAppend
* @sa otMessageGetLength
* @sa otMessageSetLength
* @sa otMessageGetOffset
* @sa otMessageSetOffset
* @sa otMessageRead
* @sa otMessageWrite
*/
ThreadError otFreeMessage(otMessage aMessage);
ThreadError otMessageFree(otMessage aMessage);
/**
* Get the message length in bytes.
@@ -96,17 +75,16 @@ ThreadError otFreeMessage(otMessage aMessage);
*
* @returns The message length in bytes.
*
* @sa otNewUdpMessage
* @sa otFreeMessage
* @sa otAppendMessage
* @sa otSetMessageLength
* @sa otGetMessageOffset
* @sa otSetMessageOffset
* @sa otReadMessage
* @sa otWriteMessage
* @sa otSetMessageLength
* @sa otMessageFree
* @sa otMessageAppend
* @sa otMessageSetLength
* @sa otMessageGetOffset
* @sa otMessageSetOffset
* @sa otMessageRead
* @sa otMessageWrite
* @sa otMessageSetLength
*/
uint16_t otGetMessageLength(otMessage aMessage);
uint16_t otMessageGetLength(otMessage aMessage);
/**
* Set the message length in bytes.
@@ -117,16 +95,15 @@ uint16_t otGetMessageLength(otMessage aMessage);
* @retval kThreadErrorNone Successfully set the message length.
* @retval kThreadErrorNoBufs No available buffers to grow the message.
*
* @sa otNewUdpMessage
* @sa otFreeMessage
* @sa otAppendMessage
* @sa otGetMessageLength
* @sa otGetMessageOffset
* @sa otSetMessageOffset
* @sa otReadMessage
* @sa otWriteMessage
* @sa otMessageFree
* @sa otMessageAppend
* @sa otMessageGetLength
* @sa otMessageGetOffset
* @sa otMessageSetOffset
* @sa otMessageRead
* @sa otMessageWrite
*/
ThreadError otSetMessageLength(otMessage aMessage, uint16_t aLength);
ThreadError otMessageSetLength(otMessage aMessage, uint16_t aLength);
/**
* Get the message offset in bytes.
@@ -135,16 +112,15 @@ ThreadError otSetMessageLength(otMessage aMessage, uint16_t aLength);
*
* @returns The message offset value.
*
* @sa otNewUdpMessage
* @sa otFreeMessage
* @sa otAppendMessage
* @sa otGetMessageLength
* @sa otSetMessageLength
* @sa otSetMessageOffset
* @sa otReadMessage
* @sa otWriteMessage
* @sa otMessageFree
* @sa otMessageAppend
* @sa otMessageGetLength
* @sa otMessageSetLength
* @sa otMessageSetOffset
* @sa otMessageRead
* @sa otMessageWrite
*/
uint16_t otGetMessageOffset(otMessage aMessage);
uint16_t otMessageGetOffset(otMessage aMessage);
/**
* Set the message offset in bytes.
@@ -155,16 +131,15 @@ uint16_t otGetMessageOffset(otMessage aMessage);
* @retval kThreadErrorNone Successfully set the message offset.
* @retval kThreadErrorInvalidArg The offset is beyond the message length.
*
* @sa otNewUdpMessage
* @sa otFreeMessage
* @sa otAppendMessage
* @sa otGetMessageLength
* @sa otSetMessageLength
* @sa otGetMessageOffset
* @sa otReadMessage
* @sa otWriteMessage
* @sa otMessageFree
* @sa otMessageAppend
* @sa otMessageGetLength
* @sa otMessageSetLength
* @sa otMessageGetOffset
* @sa otMessageRead
* @sa otMessageWrite
*/
ThreadError otSetMessageOffset(otMessage aMessage, uint16_t aOffset);
ThreadError otMessageSetOffset(otMessage aMessage, uint16_t aOffset);
/**
* This function indicates whether or not link security is enabled for the message.
@@ -175,7 +150,7 @@ ThreadError otSetMessageOffset(otMessage aMessage, uint16_t aOffset);
* @retval FALSE If link security is not enabled.
*
*/
bool otIsMessageLinkSecurityEnabled(otMessage aMessage);
bool otMessageIsLinkSecurityEnabled(otMessage aMessage);
/**
* This function sets/forces the message to be forwarded using direct transmission.
@@ -198,16 +173,15 @@ void otMessageSetDirectTransmission(otMessage aMessage, bool aEnabled);
* @retval kThreadErrorNone Successfully appended to the message
* @retval kThreadErrorNoBufs No available buffers to grow the message.
*
* @sa otNewUdpMessage
* @sa otFreeMessage
* @sa otGetMessageLength
* @sa otSetMessageLength
* @sa otGetMessageOffset
* @sa otSetMessageOffset
* @sa otReadMessage
* @sa otWriteMessage
* @sa otMessageFree
* @sa otMessageGetLength
* @sa otMessageSetLength
* @sa otMessageGetOffset
* @sa otMessageSetOffset
* @sa otMessageRead
* @sa otMessageWrite
*/
ThreadError otAppendMessage(otMessage aMessage, const void *aBuf, uint16_t aLength);
ThreadError otMessageAppend(otMessage aMessage, const void *aBuf, uint16_t aLength);
/**
* Read bytes from a message.
@@ -219,16 +193,15 @@ ThreadError otAppendMessage(otMessage aMessage, const void *aBuf, uint16_t aLeng
*
* @returns The number of bytes read.
*
* @sa otNewUdpMessage
* @sa otFreeMessage
* @sa otAppendMessage
* @sa otGetMessageLength
* @sa otSetMessageLength
* @sa otGetMessageOffset
* @sa otSetMessageOffset
* @sa otWriteMessage
* @sa otMessageFree
* @sa otMessageAppend
* @sa otMessageGetLength
* @sa otMessageSetLength
* @sa otMessageGetOffset
* @sa otMessageSetOffset
* @sa otMessageWrite
*/
int otReadMessage(otMessage aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength);
int otMessageRead(otMessage aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength);
/**
* Write bytes to a message.
@@ -240,16 +213,23 @@ int otReadMessage(otMessage aMessage, uint16_t aOffset, void *aBuf, uint16_t aLe
*
* @returns The number of bytes written.
*
* @sa otNewUdpMessage
* @sa otFreeMessage
* @sa otAppendMessage
* @sa otGetMessageLength
* @sa otSetMessageLength
* @sa otGetMessageOffset
* @sa otSetMessageOffset
* @sa otReadMessage
* @sa otMessageFree
* @sa otMessageAppend
* @sa otMessageGetLength
* @sa otMessageSetLength
* @sa otMessageGetOffset
* @sa otMessageSetOffset
* @sa otMessageRead
*/
int otWriteMessage(otMessage aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength);
int otMessageWrite(otMessage aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength);
/**
* This structure represents an OpenThread message queue.
*/
typedef struct
{
void *mData; ///< Opaque data used by the implementation.
} otMessageQueue;
/**
*
@@ -310,6 +290,15 @@ otMessage otMessageQueueGetHead(otMessageQueue *aQueue);
*/
otMessage otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage aMessage);
/**
* Get the Message Buffer information.
*
* @param[in] aInstance A pointer to the OpenThread instance.
* @param[out] aBufferInfo A pointer where the message buffer information is written.
*
*/
OTAPI void OTCALL otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo);
/**
* @}
*
include/openthread/udp.h
+1 -1
View File
@@ -36,7 +36,7 @@
#define OPENTHREAD_UDP_H_
#include "openthread-types.h"
#include "openthread-message.h"
#include "openthread/message.h"
#ifdef __cplusplus
extern "C" {