logger.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
 * Licensed 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 logger_h
#define logger_h
 
#ifndef _WIN32
#include <sys/time.h>
#endif
#include <parc/algol/parc_Buffer.h>
#include <parc/algol/parc_Clock.h>
#include <parc/logging/parc_LogLevel.h>
#include <parc/logging/parc_LogReporter.h>
#include <stdarg.h>
 
struct logger;
typedef struct logger Logger;
 
typedef enum {
  LoggerFacility_Config,
  LoggerFacility_Core,
  LoggerFacility_IO,
  LoggerFacility_Processor,
  LoggerFacility_Message,
  LoggerFacility_Strategy,
  LoggerFacility_END  // sentinel value
} LoggerFacility;
 
const char *logger_FacilityString(LoggerFacility facility);
 
const char *logger_LevelString(PARCLogLevel level);
 
Logger *logger_Create(PARCLogReporter *reporter, const PARCClock *clock);
 
void logger_Release(Logger **loggerPtr);
 
Logger *logger_Acquire(const Logger *logger);
 
void logger_SetLogLevel(Logger *logger, LoggerFacility facility,
                        PARCLogLevel minimumLevel);
 
bool logger_IsLoggable(const Logger *logger, LoggerFacility facility,
                       PARCLogLevel level);
 
void logger_Log(Logger *logger, LoggerFacility facility, PARCLogLevel level,
                const char *module, const char *format, ...);
 
void logger_SetReporter(Logger *logger, PARCLogReporter *reporter);
 
void logger_SetClock(Logger *logger, PARCClock *clock);
#endif  // logger_h