stumpless  2.1.0
function.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: Apache-2.0 */
2 
3 /*
4  * Copyright 2021-2022 Joel E. Anderson
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
44 #ifndef __STUMPLESS_TARGET_FUNCTION_H
45 # define __STUMPLESS_TARGET_FUNCTION_H
46 
47 # include <stumpless/config.h>
48 # include <stumpless/entry.h>
49 # include <stumpless/target.h>
50 
51 # ifdef __cplusplus
52 extern "C" {
53 # endif
54 
56 typedef int ( *stumpless_log_func_t )( const struct stumpless_target *,
57  const struct stumpless_entry * );
58 
59 
80 void
82 
121 struct stumpless_target *
123  stumpless_log_func_t log_function );
124 
125 # ifdef __cplusplus
126 } /* extern "C" */
127 # endif
128 #endif /* __STUMPLESS_TARGET_FUNCTION_H */
stumpless_close_function_target
void stumpless_close_function_target(const struct stumpless_target *target)
Closes a function target.
stumpless_target::name
char * name
The name of this target.
Definition: target.h:153
stumpless_target
A target that log entries can be sent to.
Definition: target.h:136
entry.h
stumpless_log_func_t
int(* stumpless_log_func_t)(const struct stumpless_target *, const struct stumpless_entry *)
A handler for entries sent to a function target.
Definition: function.h:56
stumpless_open_function_target
struct stumpless_target * stumpless_open_function_target(const char *name, stumpless_log_func_t log_function)
Opens a function target.
target.h
STUMPLESS_PUBLIC_FUNCTION
#define STUMPLESS_PUBLIC_FUNCTION
Marks functions that are provided for use by the library.
Definition: config.h:31
config.h
stumpless_entry
A log entry.
Definition: entry.h:63