32#ifndef __STATEOS_MSG_H
33#define __STATEOS_MSG_H
58#define MSG_SIZE( size ) \
59 ( (size_t)( size ) + sizeof(msh_t) )
65typedef struct __msg msg_t;
80typedef struct __msg msg_id [];
99#define _MSG_INIT( _limit, _size, _data ) \
100 { _OBJ_INIT(), 0, _limit * MSG_SIZE(_size), MSG_SIZE(_size), 0, 0, _data }
119#define _MSG_DATA( _limit, _size ) (char[_limit * MSG_SIZE(_size)]){ 0 }
130#define OS_MSG_BUFFER( buf, limit, size ) \
131 char buf[limit * MSG_SIZE(size)]
141#define OS_MSG( msg, limit, size ) \
142 static char msg##__buf[limit * MSG_SIZE(size)]; \
143 msg_t msg[] = { _MSG_INIT( limit, size, msg##__buf ) }
146#define static_MSG( msg, limit, size ) \
147 static char msg##__buf[limit * MSG_SIZE(size)]; \
148 static msg_t msg[] = { _MSG_INIT( limit, size, msg##__buf ) }
162#define MSG_INIT( limit, size ) \
163 _MSG_INIT( limit, size, _MSG_DATA( limit, size ) )
178#define MSG_CREATE( limit, size ) \
179 { MSG_INIT ( limit, size ) }
200void msg_init( msg_t *msg,
size_t size,
void *
data,
size_t bufsize );
214msg_t *
msg_create(
unsigned limit,
size_t size );
266int msg_take( msg_t *msg,
void *
data,
size_t size,
size_t *read );
302int msg_waitFor( msg_t *msg,
void *
data,
size_t size,
size_t *read, cnt_t delay );
323int msg_waitUntil( msg_t *msg,
void *
data,
size_t size,
size_t *read, cnt_t time );
370int msg_give( msg_t *msg,
const void *
data,
size_t size );
401int msg_sendFor( msg_t *msg,
const void *
data,
size_t size, cnt_t delay );
465int msg_push( msg_t *msg,
const void *
data,
size_t size );
534size_t msg_size( msg_t *msg ) {
return msg->size -
sizeof(size_t); }
546#if defined(__cplusplus) && (__cplusplus >= 201103L) && !defined(__STATEOS_STDCXX)
557template<
unsigned limit_,
size_t size_>
569 assert(_src.__msg::count == 0 && _src.obj.queue ==
nullptr);
580 int take (
void *_data,
size_t _size,
size_t *_read =
nullptr ) {
return msg_take (
this, _data, _size, _read); }
581 int tryWait (
void *_data,
size_t _size,
size_t *_read =
nullptr ) {
return msg_tryWait (
this, _data, _size, _read); }
582 int takeISR (
void *_data,
size_t _size,
size_t *_read =
nullptr ) {
return msg_takeISR (
this, _data, _size, _read); }
584 int waitFor (
void *_data,
size_t _size,
size_t *_read,
const T& _delay ) {
return msg_waitFor (
this, _data, _size, _read,
Clock::count(_delay)); }
587 int wait (
void *_data,
size_t _size,
size_t *_read =
nullptr ) {
return msg_wait (
this, _data, _size, _read); }
588 int give (
const void *_data,
size_t _size ) {
return msg_give (
this, _data, _size); }
589 int giveISR (
const void *_data,
size_t _size ) {
return msg_giveISR (
this, _data, _size); }
594 int send (
const void *_data,
size_t _size ) {
return msg_send (
this, _data, _size); }
595 int push (
const void *_data,
size_t _size ) {
return msg_push (
this, _data, _size); }
612#if __cplusplus >= 201402L
613 using Ptr = std::unique_ptr<MessageQueueT<limit_, size_>>;
634 msg->__msg::obj.res = msg;
639 char data_[limit_ * MSG_SIZE(size_)];
650template<
unsigned limit_,
class C>
657 int take ( C *_data,
size_t *_read =
nullptr ) {
return msg_take (
this, _data,
sizeof(C), _read); }
658 int tryWait ( C *_data,
size_t *_read =
nullptr ) {
return msg_tryWait (
this, _data,
sizeof(C), _read); }
659 int takeISR ( C *_data,
size_t *_read =
nullptr ) {
return msg_takeISR (
this, _data,
sizeof(C), _read); }
664 int wait ( C *_data,
size_t *_read =
nullptr ) {
return msg_wait (
this, _data,
sizeof(C), _read); }
665 int give (
const C *_data ) {
return msg_give (
this, _data,
sizeof(C)); }
671 int send (
const C *_data ) {
return msg_send (
this, _data,
sizeof(C)); }
672 int push (
const C *_data ) {
return msg_push (
this, _data,
sizeof(C)); }
681#if __cplusplus >= 201402L
682 using Ptr = std::unique_ptr<MessageQueueTT<limit_, C>>;
704 msg->__msg::obj.res = msg;
#define INFINITE
infinite waiting
Definition osbase.h:261
int msg_sendAsync(msg_t *msg, const void *data, size_t size)
Async alias of msg_send().
int msg_push(msg_t *msg, const void *data, size_t size)
try to transfer data to the message queue object, remove the oldest data if the message queue object ...
void msg_destroy(msg_t *msg)
reset the message queue object, wake up all waiting tasks with 'E_DELETED' event value and free alloc...
void msg_delete(msg_t *msg)
alias of msg_destroy()
Definition osmessagequeue.h:245
int msg_sendUntil(msg_t *msg, const void *data, size_t size, cnt_t time)
try to transfer data to the message queue object, wait until given timepoint while the message queue ...
int msg_wait(msg_t *msg, void *data, size_t size, size_t *read)
try to transfer data from the message queue object, wait indefinitely while the message queue object ...
Definition osmessagequeue.h:345
size_t msg_count(msg_t *msg)
return the amount of data contained in the message queue
void msg_kill(msg_t *msg)
alias of msg_reset()
Definition osmessagequeue.h:231
size_t msg_countISR(msg_t *msg)
ISR alias of msg_count().
Definition osmessagequeue.h:485
int msg_give(msg_t *msg, const void *data, size_t size)
try to transfer data to the message queue object, don't wait if the message queue object is full
size_t msg_limitISR(msg_t *msg)
ISR alias of msg_limit().
Definition osmessagequeue.h:519
int msg_pushISR(msg_t *msg, const void *data, size_t size)
ISR alias of msg_push().
Definition osmessagequeue.h:468
char data[]
message data
Definition osmessagequeue.h:54
size_t msg_sizeISR(msg_t *msg)
ISR alias of msg_size().
Definition osmessagequeue.h:537
size_t msg_limit(msg_t *msg)
return the size of the message queue
int msg_waitFor(msg_t *msg, void *data, size_t size, size_t *read, cnt_t delay)
try to transfer data from the message queue object, wait for given duration of time while the message...
size_t msg_space(msg_t *msg)
return the amount of free space in the message queue
int msg_take(msg_t *msg, void *data, size_t size, size_t *read)
try to transfer data from the message queue object, don't wait if the message queue object is empty
int msg_send(msg_t *msg, const void *data, size_t size)
try to transfer data to the message queue object, wait indefinitely while the message queue object is...
Definition osmessagequeue.h:442
int msg_sendFor(msg_t *msg, const void *data, size_t size, cnt_t delay)
try to transfer data to the message queue object, wait for given duration of time while the message q...
msg_t * msg_create(unsigned limit, size_t size)
create and initialize a new message queue object
msg_t * msg_new(unsigned limit, size_t size)
alias of msg_create()
Definition osmessagequeue.h:217
void msg_reset(msg_t *msg)
reset the message queue object and wake up all waiting tasks with 'E_STOPPED' event value
int msg_tryWait(msg_t *msg, void *data, size_t size, size_t *read)
alias of msg_take()
Definition osmessagequeue.h:269
void msg_init(msg_t *msg, size_t size, void *data, size_t bufsize)
initialize a message queue object
int msg_giveAsync(msg_t *msg, const void *data, size_t size)
Async alias of msg_give().
size_t msg_spaceISR(msg_t *msg)
ISR alias of msg_space().
Definition osmessagequeue.h:502
struct __msh msh_t
message header
Definition osmessagequeue.h:48
int msg_giveISR(msg_t *msg, const void *data, size_t size)
ISR alias of msg_give().
Definition osmessagequeue.h:373
size_t msg_size(msg_t *msg)
return max size of a message in the message queue
Definition osmessagequeue.h:533
int msg_waitAsync(msg_t *msg, void *data, size_t size, size_t *read)
Async alias of msg_wait().
int msg_takeISR(msg_t *msg, void *data, size_t size, size_t *read)
ISR alias of msg_take().
Definition osmessagequeue.h:273
int msg_takeAsync(msg_t *msg, void *data, size_t size, size_t *read)
Async alias of msg_take().
int msg_waitUntil(msg_t *msg, void *data, size_t size, size_t *read, cnt_t time)
try to transfer data from the message queue object, wait until given timepoint while the message queu...
static constexpr rep count(const std::chrono::duration< _Rep, _Period > &_delay)
delay in ticks, rounded up to whole ticks; negative delay: IMMEDIATE, delay out of range: INFINITE
Definition osclock.h:109
static constexpr rep until(const std::chrono::time_point< Clock, _Duration > &_time)
time point in ticks, rounded up to whole ticks (only a time point of this clock)
Definition osclock.h:116
int sendFor(const C *_data, const T &_delay)
msg_sendFor()
Definition osmessagequeue.h:667
int sendUntil(const C *_data, const T &_time)
msg_sendUntil()
Definition osmessagequeue.h:669
int sendAsync(const C *_data)
msg_sendAsync()
Definition osmessagequeue.h:677
int giveISR(const C *_data)
msg_giveISR()
Definition osmessagequeue.h:665
int takeAsync(C *_data, size_t *_read=nullptr)
msg_takeAsync()
Definition osmessagequeue.h:674
int waitUntil(C *_data, size_t *_read, const T &_time)
msg_waitUntil()
Definition osmessagequeue.h:662
int pushISR(const C *_data)
msg_pushISR()
Definition osmessagequeue.h:672
constexpr MessageQueueTT()
constructor, see the constructor parameters of the class
Definition osmessagequeue.h:654
int send(const C *_data)
msg_send()
Definition osmessagequeue.h:670
int tryWait(C *_data, size_t *_read=nullptr)
msg_tryWait()
Definition osmessagequeue.h:657
static Ptr Create()
create dynamic object with manageable resources
Definition osmessagequeue.h:699
int takeISR(C *_data, size_t *_read=nullptr)
msg_takeISR()
Definition osmessagequeue.h:658
int push(const C *_data)
msg_push()
Definition osmessagequeue.h:671
int giveAsync(const C *_data)
msg_giveAsync()
Definition osmessagequeue.h:676
int waitAsync(C *_data, size_t *_read=nullptr)
msg_waitAsync()
Definition osmessagequeue.h:675
int take(C *_data, size_t *_read=nullptr)
msg_take()
Definition osmessagequeue.h:656
int wait(C *_data, size_t *_read=nullptr)
msg_wait()
Definition osmessagequeue.h:663
int give(const C *_data)
msg_give()
Definition osmessagequeue.h:664
int waitFor(C *_data, size_t *_read, const T &_delay)
msg_waitFor()
Definition osmessagequeue.h:660
std::unique_ptr< MessageQueueTT< limit_, C > > Ptr
result type of Create()
Definition osmessagequeue.h:681
create and initialize a message queue object
Definition osmessagequeue.h:558
size_t count()
msg_count()
Definition osmessagequeue.h:596
int waitFor(void *_data, size_t _size, size_t *_read, const T &_delay)
msg_waitFor()
Definition osmessagequeue.h:583
int sendUntil(const void *_data, size_t _size, const T &_time)
msg_sendUntil()
Definition osmessagequeue.h:592
size_t space()
msg_space()
Definition osmessagequeue.h:598
int sendAsync(const void *_data, size_t _size)
msg_sendAsync()
Definition osmessagequeue.h:608
size_t spaceISR()
msg_spaceISR()
Definition osmessagequeue.h:599
int push(const void *_data, size_t _size)
msg_push()
Definition osmessagequeue.h:594
int giveAsync(const void *_data, size_t _size)
msg_giveAsync()
Definition osmessagequeue.h:607
void destroy()
msg_destroy()
Definition osmessagequeue.h:578
size_t size()
msg_size()
Definition osmessagequeue.h:602
constexpr MessageQueueT()
constructor, see the constructor parameters of the class
Definition osmessagequeue.h:561
int takeAsync(void *_data, size_t _size, size_t *_read=nullptr)
msg_takeAsync()
Definition osmessagequeue.h:605
int giveISR(const void *_data, size_t _size)
msg_giveISR()
Definition osmessagequeue.h:588
int waitAsync(void *_data, size_t _size, size_t *_read=nullptr)
msg_waitAsync()
Definition osmessagequeue.h:606
size_t countISR()
msg_countISR()
Definition osmessagequeue.h:597
int pushISR(const void *_data, size_t _size)
msg_pushISR()
Definition osmessagequeue.h:595
void kill()
msg_kill()
Definition osmessagequeue.h:577
int send(const void *_data, size_t _size)
msg_send()
Definition osmessagequeue.h:593
int take(void *_data, size_t _size, size_t *_read=nullptr)
msg_take()
Definition osmessagequeue.h:579
size_t limitISR()
msg_limitISR()
Definition osmessagequeue.h:601
size_t sizeISR()
msg_sizeISR()
Definition osmessagequeue.h:603
int tryWait(void *_data, size_t _size, size_t *_read=nullptr)
msg_tryWait()
Definition osmessagequeue.h:580
int give(const void *_data, size_t _size)
msg_give()
Definition osmessagequeue.h:587
static Ptr Create()
create dynamic object with manageable resources
Definition osmessagequeue.h:629
void reset()
msg_reset()
Definition osmessagequeue.h:576
int sendFor(const void *_data, size_t _size, const T &_delay)
msg_sendFor()
Definition osmessagequeue.h:590
int wait(void *_data, size_t _size, size_t *_read=nullptr)
msg_wait()
Definition osmessagequeue.h:586
int takeISR(void *_data, size_t _size, size_t *_read=nullptr)
msg_takeISR()
Definition osmessagequeue.h:581
int waitUntil(void *_data, size_t _size, size_t *_read, const T &_time)
msg_waitUntil()
Definition osmessagequeue.h:585
std::unique_ptr< MessageQueueT< limit_, size_ > > Ptr
result type of Create()
Definition osmessagequeue.h:612
size_t limit()
msg_limit()
Definition osmessagequeue.h:600