log_buffer_reader.h

浏览该文件的文档.

/*
 * Copyright (c) HiSilicon (Shanghai) Technologies Co., Ltd. 2018-2020. All rights reserved.
 * Description: LOG BUFFER READER MODULE INTERFACE.
 */
 
#ifndef NON_OS_LOG_BUFFER_READER_H
#define NON_OS_LOG_BUFFER_READER_H
 
#include "log_memory_definitions.h"
#include "log_buffer_common.h"
 
typedef enum {
    LOG_READER_RET_OK,
    LOG_READER_RET_BUSY,
    LOG_READER_RET_ERROR,
    LOG_READER_RET_TIMEDOUT,
    LOG_READER_RET_ERROR_OVERFLOW_ON_DISCARDING,
    LOG_READER_RET_THERE_IS_NO_NEXT_MESSAGE,
    LOG_READER_RET_ERROR_IN_PARAMS,
    LOG_READER_RET_ERROR_TRYING_TO_DISCARD_WHEN_EMPTY,
    LOG_READER_RET_ERROR_CORRUPT_SHARED_MEMORY,
} log_reader_ret_t;
 
log_reader_ret_t log_buffer_reader_init(void);
 
log_reader_ret_t log_buffer_reader_lock_next(log_memory_region_section_t *lmsec, const log_buffer_header_t *lb_header);
 
log_reader_ret_t log_buffer_reader_claim_next(log_memory_region_section_t lmsec, uint8_t **r1,
                                              uint32_t *len1, uint8_t **r2, uint32_t *len2);
 
log_reader_ret_t log_buffer_reader_discard(log_memory_region_section_t lmsec);
 
log_reader_ret_t log_buffer_get_used_space(log_memory_region_section_t lmsec, uint32_t *used_space);
 
void log_buffer_reader_error_recovery(log_memory_region_section_t lmsec);
 
#endif