Developer World
Spresense SDK Library v1.4.0-aa7f53a

Message Library Class. More...

#include <Message.h>

Static Public Member Functions

static err_t initFirst (uint32_t num_pools, uint32_t top_drm)
 
static err_t initPerCpu ()
 
static err_t finalize ()
 
static bool isInitFirstComplete ()
 
static err_t isInitComplete (MsgQueId id, bool &done)
 
static err_t referMsgQueBlock (MsgQueId id, MsgQueBlock **que)
 
static err_t send (MsgQueId dest, MsgPri pri, MsgType type, MsgQueId reply)
 
template<typename T >
static err_t send (MsgQueId dest, MsgPri pri, MsgType type, MsgQueId reply, const T &param)
 
static err_t send (MsgQueId dest, MsgPri pri, MsgType type, MsgQueId reply, const void *param, size_t param_size)
 
static err_t sendIsr (MsgQueId dest, MsgPri pri, MsgType type, MsgQueId reply)
 
template<typename T >
static err_t sendIsr (MsgQueId dest, MsgPri pri, MsgType type, MsgQueId reply, const T &param)
 
static err_t sendIsr (MsgQueId dest, MsgPri pri, MsgType type, MsgQueId reply, const void *param, size_t param_size)
 
static err_t notifyRecv (MsgQueId dest)
 
static void dump ()
 

Detailed Description

Message Library Class.

Member Function Documentation

◆ initFirst()

static err_t initFirst ( uint32_t  num_pools,
uint32_t  top_drm 
)
static

The 1st initialize method on boot. This method only called once on the system.(from system processor)

Returns
ERR_OK : success
ERR_STS : error, initFirst() is already executing

◆ initPerCpu()

static err_t initPerCpu ( )
static

The 2nd initialize method on boot. This method only called once on each processor.

Returns
ERR_OK : success
ERR_STS : error, initFirst() is not executed yet

◆ finalize()

static err_t finalize ( )
static

The finalize method on power-off. This method only called once on the system.(from system processor)

Returns
ERR_OK : success
ERR_STS : error, initFirst() is not executed yet

◆ send()

static err_t send ( MsgQueId  dest,
MsgPri  pri,
MsgType  type,
MsgQueId  reply,
const T &  param 
)
inlinestatic

Send a Object to another task. This method can send a object to dest(MsgQueId) with type(MsgType).

Parameters
[in]destDestination id
[in]priPriority
[in]typeMessage Type
[in]replyReply id
[in]paramObject to send
Returns
err_t error code.

The documentation for this class was generated from the following file: