messages.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2023 Swansea University
 *
 *  This file is part of the SELKIELogger suite of tools.
 *
 *  SELKIELogger is free software: you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by the Free
 *  Software Foundation, either version 3 of the License, or (at your option)
 *  any later version.
 *
 *  SELKIELogger is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 *  more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this SELKIELogger product.
 *  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef SELKIELoggerBase_Messages
#define SELKIELoggerBase_Messages
#include "strarray.h"
#include <stdint.h>
 
typedef union {
    float value;        
    uint32_t timestamp; 
    uint8_t *bytes;     
    string string;      
    strarray names;     
    float *farray;      
} msg_data_t;
 
typedef enum {
    MSG_ERROR = -1, 
    MSG_UNDEF = 0,  
    MSG_FLOAT,      
    MSG_TIMESTAMP,  
    MSG_BYTES,      
    MSG_STRING,     
    MSG_STRARRAY,   
    MSG_NUMARRAY,   
} msg_dtype_t;
 
 
typedef struct {
    uint8_t source;    
    uint8_t type;      
    size_t length;     
    msg_dtype_t dtype; 
    msg_data_t data;   
} msg_t;
 
msg_t *msg_new_float(const uint8_t source, const uint8_t type, const float val);
 
msg_t *msg_new_timestamp(const uint8_t source, const uint8_t type, const uint32_t ts);
 
msg_t *msg_new_string(const uint8_t source, const uint8_t type, const size_t len, const char *str);
 
msg_t *msg_new_string_array(const uint8_t source, const uint8_t type, const strarray *array);
 
msg_t *msg_new_bytes(const uint8_t source, const uint8_t type, const size_t len, const uint8_t *bytes);
 
msg_t *msg_new_float_array(const uint8_t source, const uint8_t type, const size_t entries, const float *array);
 
char *msg_to_string(const msg_t *msg);
 
char *msg_data_to_string(const msg_t *msg);
 
char *msg_data_narr_to_string(const msg_t *msg);
 
char *msg_data_sarr_to_string(const msg_t *msg);
 
void msg_destroy(msg_t *msg);
#endif