Qpid Proton C API 0.40.0
 
Loading...
Searching...
No Matches
logger.h
Go to the documentation of this file.
1#ifndef LOGGER_H
2#define LOGGER_H
3/*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
31#include <proton/annotations.h>
32#include <proton/import_export.h>
33
34#include <stdarg.h>
35#include <stdint.h>
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
86typedef struct pn_logger_t pn_logger_t;
87
93typedef enum pn_log_subsystem_t {
102 PN_SUBSYSTEM_ALL = 65535
103} pn_log_subsystem_t; /* We hint to the compiler it can use 16 bits for this value */
104
110typedef enum pn_log_level_t {
120 PN_LEVEL_ALL = 65535
121} pn_log_level_t; /* We hint to the compiler that it can use 16 bits for this value */
122
126typedef void (*pn_log_sink_t)(intptr_t sink_context, pn_log_subsystem_t subsystem, pn_log_level_t severity, const char *message);
127
134
141PN_EXTERN const char *pn_logger_level_name(pn_log_level_t level);
142
149PN_EXTERN const char *pn_logger_subsystem_name(pn_log_subsystem_t subsystem);
150
171PN_EXTERN void pn_logger_set_mask(pn_logger_t *logger, uint16_t subsystem, uint16_t level);
172
193PN_EXTERN void pn_logger_reset_mask(pn_logger_t *logger, uint16_t subsystem, uint16_t level);
194
206PN_EXTERN void pn_logger_set_log_sink(pn_logger_t *logger, pn_log_sink_t sink, intptr_t sink_context);
207
215
222PN_EXTERN intptr_t pn_logger_get_log_sink_context(pn_logger_t *logger);
223
235PN_EXTERN void pn_logger_logf(pn_logger_t *logger, pn_log_subsystem_t subsystem, pn_log_level_t level, PN_PRINTF_FORMAT const char *fmt, ...)
236 PN_PRINTF_FORMAT_ATTR(4, 5);
237
238#ifdef __cplusplus
239}
240#endif
241
246#endif
void pn_logger_logf(pn_logger_t *logger, pn_log_subsystem_t subsystem, pn_log_level_t level, PN_PRINTF_FORMAT const char *fmt,...) PN_PRINTF_FORMAT_ATTR(4
Log a printf formatted message using the logger.
pn_logger_t * pn_default_logger(void)
Return the default library logger.
const char * pn_logger_level_name(pn_log_level_t level)
Get a human readable name for a logger severity.
intptr_t pn_logger_get_log_sink_context(pn_logger_t *logger)
Get the sink context used by a logger.
const char * pn_logger_subsystem_name(pn_log_subsystem_t subsystem)
Get a human readable name for a logger subsystem.
void(* pn_log_sink_t)(intptr_t sink_context, pn_log_subsystem_t subsystem, pn_log_level_t severity, const char *message)
Callback for sinking logger messages.
Definition logger.h:126
void pn_logger_set_log_sink(pn_logger_t *logger, pn_log_sink_t sink, intptr_t sink_context)
Set the tracing function used by a logger.
void pn_logger_reset_mask(pn_logger_t *logger, uint16_t subsystem, uint16_t level)
Clear a logger's tracing flags.
void pn_logger_set_mask(pn_logger_t *logger, uint16_t subsystem, uint16_t level)
Set a logger's tracing flags.
pn_log_subsystem_t
Definitions for different subsystems that can log messages.
Definition logger.h:93
pn_log_sink_t pn_logger_get_log_sink(pn_logger_t *logger)
Get the tracing function used by a logger.
pn_log_level_t
Definitions for different severities of log messages Note that these are exclusive bits so that you c...
Definition logger.h:110
struct pn_logger_t pn_logger_t
The logger object allows library logging to be controlled.
Definition logger.h:86
@ PN_SUBSYSTEM_NONE
No subsystem.
Definition logger.h:94
@ PN_SUBSYSTEM_IO
Low level Input/Output.
Definition logger.h:96
@ PN_SUBSYSTEM_SSL
TLS/SSL protocol processing.
Definition logger.h:99
@ PN_SUBSYSTEM_MEMORY
Memory usage.
Definition logger.h:95
@ PN_SUBSYSTEM_EVENT
Events.
Definition logger.h:97
@ PN_SUBSYSTEM_AMQP
AMQP protocol processing.
Definition logger.h:98
@ PN_SUBSYSTEM_BINDING
Language binding.
Definition logger.h:101
@ PN_SUBSYSTEM_ALL
Every subsystem.
Definition logger.h:102
@ PN_SUBSYSTEM_SASL
SASL protocol processing.
Definition logger.h:100
@ PN_LEVEL_FRAME
Protocol frame traces.
Definition logger.h:118
@ PN_LEVEL_TRACE
Detail about something that happened.
Definition logger.h:117
@ PN_LEVEL_RAW
Raw protocol bytes.
Definition logger.h:119
@ PN_LEVEL_ERROR
Something went wrong.
Definition logger.h:113
@ PN_LEVEL_NONE
No level.
Definition logger.h:111
@ PN_LEVEL_WARNING
Something unusual happened but not necessarily an error.
Definition logger.h:114
@ PN_LEVEL_DEBUG
Something you might want to know about happened.
Definition logger.h:116
@ PN_LEVEL_CRITICAL
Something is wrong and can't be fixed - probably a library bug.
Definition logger.h:112
@ PN_LEVEL_INFO
Something that might be interesting happened.
Definition logger.h:115
@ PN_LEVEL_ALL
Every possible level.
Definition logger.h:120