msg_queue.h File Reference

#include <zrtos/types.h>
#include <zrtos/cbuffer.h>

Include dependency graph for msg_queue.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_zrtos_msg_queue_header_t
struct	_zrtos_msg_queue_t
struct	_zrtos_msg_queue_write_transaction_t

Typedefs
typedef struct _zrtos_msg_queue_header_t	zrtos_msg_queue_header_t
typedef struct _zrtos_msg_queue_t	zrtos_msg_queue_t
typedef struct _zrtos_msg_queue_write_transaction_t	zrtos_msg_queue_write_transaction_t

Functions
void	zrtos_msg_queue__start_write_transaction (zrtos_msg_queue_t *thiz, zrtos_msg_queue_write_transaction_t *txn)
void	zrtos_msg_queue__rollback_write_transaction (zrtos_msg_queue_t *thiz, zrtos_msg_queue_write_transaction_t *txn)
bool	zrtos_msg_queue__is_empty (zrtos_msg_queue_t *thiz)
zrtos_error_t	zrtos_msg_queue__put_length (zrtos_msg_queue_t *thiz, size_t len)
zrtos_error_t	zrtos_msg_queue__put_data (zrtos_msg_queue_t *thiz, void *data, size_t len)
zrtos_error_t	zrtos_msg_queue__put_end (zrtos_msg_queue_t *thiz)
zrtos_error_t	zrtos_msg_queue__put_cbuffer_data (zrtos_msg_queue_t *thiz, zrtos_cbuffer_t *data, size_t length)
zrtos_error_t	zrtos_msg_queue__put (zrtos_msg_queue_t *thiz, void *data, size_t len)
zrtos_error_t	zrtos_msg_queue__get (zrtos_msg_queue_t *thiz, void *data, size_t len, size_t *outlen)
zrtos_error_t	zrtos_msg_queue__pipe_next_message_to_cbuffer (zrtos_msg_queue_t *thiz, zrtos_cbuffer_t *dest, size_t len, size_t *outlen)

Typedef Documentation

zrtos_msg_queue_header_t

typedef struct _zrtos_msg_queue_header_t zrtos_msg_queue_header_t

zrtos_msg_queue_t

typedef struct _zrtos_msg_queue_t zrtos_msg_queue_t

zrtos_msg_queue_write_transaction_t

typedef struct _zrtos_msg_queue_write_transaction_t zrtos_msg_queue_write_transaction_t

Function Documentation

zrtos_msg_queue__get()

zrtos_error_t zrtos_msg_queue__get	(	zrtos_msg_queue_t *	thiz,
		void *	data,
		size_t	len,
		size_t *	outlen
	)

Definition at line 140 of file msg_queue.h.

 {
    zrtos_error_t ret;
    if(thiz->header.length){
L_READ_MESSAGE_BODY:
        ret = zrtos_cbuffer__get_ex(
             &thiz->cbuffer
            ,data
            ,ZRTOS_TYPES__MIN(len,thiz->header.length)
            ,outlen
        );
        thiz->header.length -= *outlen;
        if(thiz->header.length == 0){
            thiz->msg_count--;
        }else{
            ret = ZRTOS_ERROR__AGAIN;
        }
    }else if(thiz->msg_count && zrtos_cbuffer__can_read_length(
         &thiz->cbuffer
        ,sizeof(thiz->header)
    )){
        ret = zrtos_cbuffer__get_ex(
             &thiz->cbuffer
            ,&thiz->header
            ,sizeof(thiz->header)
            ,outlen
        );
        if(zrtos_error__is_success(ret)){
            goto L_READ_MESSAGE_BODY;
        }
    }else{
        ret = ZRTOS_ERROR__NODATA;
    }
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_msg_queue__is_empty()

bool zrtos_msg_queue__is_empty

(

zrtos_msg_queue_t *

thiz

)

Definition at line 55 of file msg_queue.h.

                                                       {
    return thiz->msg_count == 0 && thiz->header.length == 0;
}

Here is the caller graph for this function:

zrtos_msg_queue__pipe_next_message_to_cbuffer()

zrtos_error_t zrtos_msg_queue__pipe_next_message_to_cbuffer	(	zrtos_msg_queue_t *	thiz,
		zrtos_cbuffer_t *	dest,
		size_t	len,
		size_t *	outlen
	)

Definition at line 180 of file msg_queue.h.

 {
    zrtos_error_t ret;
    if(thiz->header.length){
L_READ_MESSAGE_BODY:
        ret = zrtos_cbuffer__pipe(
             &thiz->cbuffer
            ,dest
            ,ZRTOS_TYPES__MIN(len,thiz->header.length)
            ,outlen
        );
        thiz->header.length -= *outlen;
        if(thiz->header.length == 0){
            thiz->msg_count--;
        }else{
            ret = ZRTOS_ERROR__AGAIN;
        }
    }else if(thiz->msg_count && zrtos_cbuffer__can_read_length(
         &thiz->cbuffer
        ,sizeof(thiz->header)
    )){
        ret = zrtos_cbuffer__get_ex(
             &thiz->cbuffer
            ,&thiz->header
            ,sizeof(thiz->header)
            ,outlen
        );
        if(zrtos_error__is_success(ret)){
            goto L_READ_MESSAGE_BODY;
        }
    }else{
        ret = ZRTOS_ERROR__NODATA;
    }
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_msg_queue__put()

zrtos_error_t zrtos_msg_queue__put	(	zrtos_msg_queue_t *	thiz,
		void *	data,
		size_t	len
	)

Definition at line 116 of file msg_queue.h.

 {
    zrtos_msg_queue_header_t header = {
        .length = len
    };
    size_t outlen;
    zrtos_error_t ret = zrtos_cbuffer__put_ex(
         &thiz->cbuffer
        ,2
        ,&outlen
        ,&header
        ,sizeof(header)
        ,data
        ,len
    );
    if(zrtos_error__is_success(ret)){
        thiz->msg_count++;
    }
    return ret;
}

Here is the call graph for this function:

zrtos_msg_queue__put_cbuffer_data()

zrtos_error_t zrtos_msg_queue__put_cbuffer_data	(	zrtos_msg_queue_t *	thiz,
		zrtos_cbuffer_t *	data,
		size_t	length
	)

Definition at line 100 of file msg_queue.h.

 {
    zrtos_error_t ret = zrtos_cbuffer__pipe(
         &thiz->cbuffer
        ,data
        ,length
    );
    if(zrtos_error__is_success(ret)){
        thiz->msg_count++;
    }
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_msg_queue__put_data()

zrtos_error_t zrtos_msg_queue__put_data	(	zrtos_msg_queue_t *	thiz,
		void *	data,
		size_t	len
	)

Definition at line 77 of file msg_queue.h.

 {
    size_t outlen;
    zrtos_error_t ret = zrtos_cbuffer__put_ex(
         &thiz->cbuffer
        ,1
        ,&outlen
        ,data
        ,len
    );
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_msg_queue__put_end()

zrtos_error_t zrtos_msg_queue__put_end

(

zrtos_msg_queue_t *

thiz

)

Definition at line 93 of file msg_queue.h.

 {
    thiz->msg_count++;
    return ZRTOS_ERROR__SUCCESS;
}

Here is the caller graph for this function:

zrtos_msg_queue__put_length()

zrtos_error_t zrtos_msg_queue__put_length	(	zrtos_msg_queue_t *	thiz,
		size_t	len
	)

Definition at line 59 of file msg_queue.h.

 {
    zrtos_msg_queue_header_t header = {
        .length = len
    };
    size_t outlen;
    zrtos_error_t ret = zrtos_cbuffer__put_ex(
         &thiz->cbuffer
        ,1
        ,&outlen
        ,&header
        ,sizeof(header)
    );
    return zrtos_error__is_success(ret);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_msg_queue__rollback_write_transaction()

void zrtos_msg_queue__rollback_write_transaction	(	zrtos_msg_queue_t *	thiz,
		zrtos_msg_queue_write_transaction_t *	txn
	)

Definition at line 44 of file msg_queue.h.

 {
    zrtos_cbuffer__rollback_write_transaction(
         &thiz->cbuffer
        ,&txn->txn
    );
    thiz->msg_count = txn->msg_count;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_msg_queue__start_write_transaction()

void zrtos_msg_queue__start_write_transaction	(	zrtos_msg_queue_t *	thiz,
		zrtos_msg_queue_write_transaction_t *	txn
	)

Definition at line 33 of file msg_queue.h.

 {
    zrtos_cbuffer__start_write_transaction(
         &thiz->cbuffer
        ,&txn->txn
    );
    txn->msg_count = thiz->msg_count;
}

Here is the call graph for this function:

Here is the caller graph for this function: