sopc_circular_log_file.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_CIRCULAR_LOG_FILE_H_
#define SOPC_CIRCULAR_LOG_FILE_H_
 
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
 
typedef struct SOPC_CircularLogFile SOPC_CircularLogFile;
 
typedef struct SOPC_CircularLogFile_Configuration
{
    const char* logDirPath;  
    const char* logFileName; 
    uint32_t logMaxBytes;    
    uint16_t logMaxFiles;    
} SOPC_CircularLogFile_Configuration;
 
SOPC_CircularLogFile* SOPC_CircularLogFile_Create(const SOPC_CircularLogFile_Configuration* config);
 
char* SOPC_CircularLogFile_GetFileName(const SOPC_CircularLogFile* pFile);
 
void SOPC_CircularLogFile_PutLine(SOPC_CircularLogFile* pFile, const char* line);
 
void SOPC_CircularLogFile_Delete(SOPC_CircularLogFile** ppFile);
 
#endif /* SOPC_CIRCULAR_LOG_FILE_H_ */