The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
TARGET_ARM_BEETLE_SOC/TOOLCHAIN_GCC_ARM/wsf_msg.h
- Committer:
- AnnaBridge
- Date:
- 2019-02-20
- Revision:
- 172:65be27845400
- Parent:
- 171:3a7713b1edbc
File content as of revision 172:65be27845400:
/*************************************************************************************************/ /*! * \file wsf_msg.h * * \brief Message passing service. * * $Date: 2013-07-02 15:08:09 -0700 (Tue, 02 Jul 2013) $ * $Revision: 779 $ * * Copyright (c) 2009 Wicentric, Inc., all rights reserved. * Wicentric confidential and proprietary. * * IMPORTANT. Your use of this file is governed by a Software License Agreement * ("Agreement") that must be accepted in order to download or otherwise receive a * copy of this file. You may not use or copy this file for any purpose other than * as described in the Agreement. If you do not agree to all of the terms of the * Agreement do not use this file and delete all copies in your possession or control; * if you do not have a copy of the Agreement, you must contact Wicentric, Inc. prior * to any use, copying or further distribution of this software. */ /*************************************************************************************************/ #ifndef WSF_MSG_H #define WSF_MSG_H #include "wsf_queue.h" #include "wsf_os.h" #ifdef __cplusplus extern "C" { #endif /************************************************************************************************** Function Declarations **************************************************************************************************/ /*************************************************************************************************/ /*! * \fn WsfMsgAlloc * * \brief Allocate a message buffer to be sent with WsfMsgSend(). * * \param len Message length in bytes. * * \return Pointer to message buffer or NULL if allocation failed. */ /*************************************************************************************************/ void *WsfMsgAlloc(uint16_t len); /*************************************************************************************************/ /*! * \fn WsfMsgFree * * \brief Free a message buffer allocated with WsfMsgAlloc(). * * \param pMsg Pointer to message buffer. * * \return None. */ /*************************************************************************************************/ void WsfMsgFree(void *pMsg); /*************************************************************************************************/ /*! * \fn WsfMsgSend * * \brief Send a message to an event handler. * * \param handlerId Event handler ID. * \param pMsg Pointer to message buffer. * * \return None. */ /*************************************************************************************************/ void WsfMsgSend(wsfHandlerId_t handlerId, void *pMsg); /*************************************************************************************************/ /*! * \fn WsfMsgEnq * * \brief Enqueue a message. * * \param pQueue Pointer to queue. * \param handerId Set message handler ID to this value. * \param pElem Pointer to message buffer. * * \return None. */ /*************************************************************************************************/ void WsfMsgEnq(wsfQueue_t *pQueue, wsfHandlerId_t handlerId, void *pMsg); /*************************************************************************************************/ /*! * \fn WsfMsgDeq * * \brief Dequeue a message. * * \param pQueue Pointer to queue. * \param pHandlerId Handler ID of returned message; this is a return parameter. * * \return Pointer to message that has been dequeued or NULL if queue is empty. */ /*************************************************************************************************/ void *WsfMsgDeq(wsfQueue_t *pQueue, wsfHandlerId_t *pHandlerId); /*************************************************************************************************/ /*! * \fn WsfMsgPeek * * \brief Get the next message without removing it from the queue. * * \param pQueue Pointer to queue. * \param pHandlerId Handler ID of returned message; this is a return parameter. * * \return Pointer to the next message on the queue or NULL if queue is empty. */ /*************************************************************************************************/ void *WsfMsgPeek(wsfQueue_t *pQueue, wsfHandlerId_t *pHandlerId); #ifdef __cplusplus }; #endif #endif /* WSF_MSG_H */