log_protocol.h

Go to the documentation of this file.

 
#ifndef __TBOX_LOG_PROTOCOL_H__
#define __TBOX_LOG_PROTOCOL_H__
 
#include <stddef.h>
#include <stdint.h>
 
#define TBOX_LOG_PROTOCOL_MAGIC   0x544C4F47u
#define TBOX_LOG_PROTOCOL_VERSION 2u
#define TBOX_LOG_MAX_TEXT_LEN     1023u
#define TBOX_LOG_MAX_PACKET_SIZE  1200u
 
typedef enum
{
    TBOX_LOG_MSG_WRITE       = 1,
    TBOX_LOG_MSG_SET_LEVEL   = 2,
    TBOX_LOG_MSG_GET_LEVEL   = 3,
    TBOX_LOG_MSG_PING        = 4,
    TBOX_LOG_MSG_ACK         = 5,
    TBOX_LOG_MSG_HEX         = 6,
    TBOX_LOG_MSG_SET_ENCRYPT = 7,
} tbox_log_msg_type_t;
 
typedef struct
{
    uint32_t magic;
    uint16_t version;
    uint16_t type;
    uint32_t length;
    uint32_t flags;
} tbox_log_msg_header_t;
 
typedef struct
{
    uint64_t ts_ms;
    uint32_t pid;
    uint32_t tid;
    uint16_t id;
    uint8_t  level;
    uint8_t  reserved;
    uint16_t text_len;
} tbox_log_write_body_t;
 
typedef struct
{
    uint64_t ts_ms;
    uint32_t pid;
    uint32_t tid;
    uint16_t id;
    uint8_t  level;
    uint8_t  reserved;
    uint16_t text_len;
    uint16_t data_len;
} tbox_log_hex_body_t;
 
typedef struct
{
    uint16_t id;
    uint8_t  level;
    uint8_t  reserved;
    uint32_t status;
} tbox_log_level_body_t;
 
typedef struct
{
    uint8_t enabled;
    uint8_t reserved[3];
} tbox_log_encrypt_body_t;
 
typedef struct
{
    uint32_t status;
    uint32_t value;
} tbox_log_ack_body_t;
 
typedef struct
{
    tbox_log_write_body_t body;
    const char*           text;
} tbox_log_write_view_t;
 
typedef struct
{
    tbox_log_hex_body_t body;
    const char*         text;
    const uint8_t*      data;
} tbox_log_hex_view_t;
 
typedef struct
{
    const tbox_log_msg_header_t* header;
    const void*                  body;
    size_t                       body_len;
} tbox_log_message_view_t;

int tbox_log_protocol_pack_write(void* buffer, size_t buffer_size, uint16_t id, uint8_t level, uint64_t ts_ms,
                                 uint32_t pid, uint32_t tid, const char* text, size_t* packed_size);

int tbox_log_protocol_pack_hex(void* buffer, size_t buffer_size, uint16_t id, uint8_t level, uint64_t ts_ms,
                               uint32_t pid, uint32_t tid, const char* text, const void* data, size_t data_len,
                               size_t* packed_size);

int tbox_log_protocol_pack_set_level(void* buffer, size_t buffer_size, uint16_t id, uint8_t level, size_t* packed_size);

int tbox_log_protocol_pack_get_level(void* buffer, size_t buffer_size, uint16_t id, size_t* packed_size);

int tbox_log_protocol_pack_set_encrypt(void* buffer, size_t buffer_size, uint8_t enabled, size_t* packed_size);

int tbox_log_protocol_pack_ack(void* buffer, size_t buffer_size, uint32_t status, uint32_t value, size_t* packed_size);

int tbox_log_protocol_validate(const void* buffer, size_t buffer_size, tbox_log_message_view_t* view);

int tbox_log_protocol_read_write(const tbox_log_message_view_t* view, tbox_log_write_view_t* write_view);

int tbox_log_protocol_read_hex(const tbox_log_message_view_t* view, tbox_log_hex_view_t* hex_view);
 
#endif /* __TBOX_LOG_PROTOCOL_H__ */