76 lines
1.9 KiB
C
76 lines
1.9 KiB
C
|
|
||
|
|
#ifndef AWS_COMMON_LOG_CHANNEL_H
|
||
|
|
#define AWS_COMMON_LOG_CHANNEL_H
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||
|
|
* SPDX-License-Identifier: Apache-2.0.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#include <aws/common/common.h>
|
||
|
|
|
||
|
|
#include <aws/common/logging.h>
|
||
|
|
|
||
|
|
AWS_PUSH_SANE_WARNING_LEVEL
|
||
|
|
|
||
|
|
struct aws_string;
|
||
|
|
struct aws_log_writer;
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Log channel interface and default implementations
|
||
|
|
*
|
||
|
|
* A log channel is an abstraction for the transfer of formatted log data between a source (formatter)
|
||
|
|
* and a sink (writer).
|
||
|
|
*/
|
||
|
|
struct aws_log_channel;
|
||
|
|
|
||
|
|
typedef int(aws_log_channel_send_fn)(struct aws_log_channel *channel, struct aws_string *output);
|
||
|
|
typedef void(aws_log_channel_clean_up_fn)(struct aws_log_channel *channel);
|
||
|
|
|
||
|
|
struct aws_log_channel_vtable {
|
||
|
|
aws_log_channel_send_fn *send;
|
||
|
|
aws_log_channel_clean_up_fn *clean_up;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct aws_log_channel {
|
||
|
|
struct aws_log_channel_vtable *vtable;
|
||
|
|
struct aws_allocator *allocator;
|
||
|
|
struct aws_log_writer *writer;
|
||
|
|
void *impl;
|
||
|
|
};
|
||
|
|
|
||
|
|
AWS_EXTERN_C_BEGIN
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Simple channel that results in log lines being written in the same thread they were generated in.
|
||
|
|
*
|
||
|
|
* The passed in log writer is not an ownership transfer. The log channel does not clean up the writer.
|
||
|
|
*/
|
||
|
|
AWS_COMMON_API
|
||
|
|
int aws_log_channel_init_foreground(
|
||
|
|
struct aws_log_channel *channel,
|
||
|
|
struct aws_allocator *allocator,
|
||
|
|
struct aws_log_writer *writer);
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Simple channel that sends log lines to a background thread.
|
||
|
|
*
|
||
|
|
* The passed in log writer is not an ownership transfer. The log channel does not clean up the writer.
|
||
|
|
*/
|
||
|
|
AWS_COMMON_API
|
||
|
|
int aws_log_channel_init_background(
|
||
|
|
struct aws_log_channel *channel,
|
||
|
|
struct aws_allocator *allocator,
|
||
|
|
struct aws_log_writer *writer);
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Channel cleanup function
|
||
|
|
*/
|
||
|
|
AWS_COMMON_API
|
||
|
|
void aws_log_channel_clean_up(struct aws_log_channel *channel);
|
||
|
|
|
||
|
|
AWS_EXTERN_C_END
|
||
|
|
AWS_POP_SANE_WARNING_LEVEL
|
||
|
|
|
||
|
|
#endif /* AWS_COMMON_LOG_CHANNEL_H */
|