message.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2016, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef OPENTHREAD_MESSAGE_H_
#define OPENTHREAD_MESSAGE_H_

#include <openthread/types.h>

#ifdef __cplusplus
extern "C" {
#endif

void otMessageFree(otMessage *aMessage);

uint16_t otMessageGetLength(otMessage *aMessage);

otError otMessageSetLength(otMessage *aMessage, uint16_t aLength);

uint16_t otMessageGetOffset(otMessage *aMessage);

otError otMessageSetOffset(otMessage *aMessage, uint16_t aOffset);

bool otMessageIsLinkSecurityEnabled(otMessage *aMessage);

void otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled);

int8_t otMessageGetRss(otMessage *aMessage);

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

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

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

typedef struct
{
    void *mData;            
} otMessageQueue;

void otMessageQueueInit(otMessageQueue *aQueue);

otError otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage);

otError otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage);

otError otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage);

otMessage *otMessageQueueGetHead(otMessageQueue *aQueue);

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

OTAPI void OTCALL otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo);

#ifdef __cplusplus
}  // extern "C"
#endif

#endif  // OPENTHREAD_MESSAGE_H_