target.h

Go to the documentation of this file.

/* SPDX-License-Identifier: Apache-2.0 */
 
/*
 * Copyright 2018-2024 Joel E. Anderson
 *
 * 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 __STUMPLESS_TARGET_H
#define __STUMPLESS_TARGET_H
 
#include <stdarg.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include <stumpless/config.h>
#include <stumpless/entry.h>
#include <stumpless/id.h>
#include <stumpless/generator.h>
 
#define STUMPLESS_DEFAULT_TARGET_NAME "stumpless-default"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define STUMPLESS_BUFFER_TARGET_VALUE 0
 
#define STUMPLESS_FILE_TARGET_VALUE 1
 
#define STUMPLESS_FUNCTION_TARGET_VALUE 2
 
#define STUMPLESS_JOURNALD_TARGET_VALUE 3
 
#define STUMPLESS_NETWORK_TARGET_VALUE 4
 
#define STUMPLESS_SOCKET_TARGET_VALUE 5
 
#define STUMPLESS_STREAM_TARGET_VALUE 6
 
#define STUMPLESS_WINDOWS_EVENT_LOG_TARGET_VALUE 7
 
#define STUMPLESS_SQLITE3_TARGET_VALUE 8
 
#define STUMPLESS_CHAIN_TARGET_VALUE 9
 
#define STUMPLESS_FOREACH_TARGET_TYPE( ACTION )\
ACTION( STUMPLESS_BUFFER_TARGET, STUMPLESS_BUFFER_TARGET_VALUE )\
ACTION( STUMPLESS_FILE_TARGET, STUMPLESS_FILE_TARGET_VALUE )\
ACTION( STUMPLESS_FUNCTION_TARGET, STUMPLESS_FUNCTION_TARGET_VALUE )\
ACTION( STUMPLESS_JOURNALD_TARGET, STUMPLESS_JOURNALD_TARGET_VALUE )\
ACTION( STUMPLESS_NETWORK_TARGET, STUMPLESS_NETWORK_TARGET_VALUE )\
ACTION( STUMPLESS_SOCKET_TARGET, STUMPLESS_SOCKET_TARGET_VALUE )\
ACTION( STUMPLESS_STREAM_TARGET, STUMPLESS_STREAM_TARGET_VALUE )\
ACTION( STUMPLESS_WINDOWS_EVENT_LOG_TARGET, STUMPLESS_WINDOWS_EVENT_LOG_TARGET_VALUE )\
ACTION( STUMPLESS_SQLITE3_TARGET, STUMPLESS_SQLITE3_TARGET_VALUE )\
ACTION( STUMPLESS_CHAIN_TARGET, STUMPLESS_CHAIN_TARGET_VALUE )
 
enum stumpless_target_type {
  STUMPLESS_FOREACH_TARGET_TYPE( STUMPLESS_GENERATE_ENUM )
};
 
// needed so that we can define the filter function type before targets
struct stumpless_target;
 
typedef bool ( *stumpless_filter_func_t )(
  const struct stumpless_target *target,
  const struct stumpless_entry *entry );
 
struct stumpless_target {
  stumpless_id_t id;
  enum stumpless_target_type type;
  char *name;
  size_t name_length;
  int options;
  int default_prival;
  char default_app_name[STUMPLESS_MAX_APP_NAME_LENGTH];
  size_t default_app_name_length;
  char default_msgid[STUMPLESS_MAX_MSGID_LENGTH];
  size_t default_msgid_length;
  int mask;
  stumpless_filter_func_t filter;
#ifdef STUMPLESS_THREAD_SAFETY_SUPPORTED
  void *mutex;
#endif
};
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_add_entry( struct stumpless_target *target,
                     const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_add_log( struct stumpless_target *target,
                   int priority,
                   const char *message,
                   ... );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_add_log_str( struct stumpless_target *target,
                       int priority,
                       const char *message );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_add_message( struct stumpless_target *target,
                       const char *message,
                       ... );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_add_message_str( struct stumpless_target *target,
                           const char *message );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_close_target( struct stumpless_target *target );
 
/*
 * Gets the current console stream where logs are written to.
 *
 * **Thread Safety: MT-Safe**
 * This function is thread safe. Atomic variables are used to store and
 * retrieve the console stream.
 *
 * **Async Signal Safety: AS-Safe**
 * This function is safe to call from signal handlers.
 *
 * **Async Cancel Safety: AC-Safe**
 * This function is safe to call from threads that may be ansynchronously
 * cancelled.
 *
 * @since release v2.1.0
 *
 * @return The current stream where messages are logged to on setting the
 * the CONS option.
 */
STUMPLESS_PUBLIC_FUNCTION
FILE *
stumpless_get_cons_stream( void );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_get_current_target( void );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_get_default_facility( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_get_default_target( void );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_get_option( const struct stumpless_target *target, int option );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_target_default_app_name( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_target_default_msgid( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
stumpless_filter_func_t
stumpless_get_target_filter( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_get_target_mask( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_target_name( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_open_target( struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_set_cons_stream( FILE *stream );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_set_current_target( struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_set_default_facility( struct stumpless_target *target,
                                int default_facility );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_set_option( struct stumpless_target *target, int option );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_set_target_default_app_name( struct stumpless_target *target,
                                       const char *app_name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_set_target_default_msgid( struct stumpless_target *target,
                                    const char *msgid );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_set_target_filter( struct stumpless_target *target,
                             stumpless_filter_func_t filter );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_set_target_mask( struct stumpless_target *target, int mask );
 
STUMPLESS_PUBLIC_FUNCTION
const struct stumpless_target *
stumpless_target_is_open( const struct stumpless_target *target );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_trace_entry( struct stumpless_target *target,
                       struct stumpless_entry *entry,
                       const char *file,
                       int line,
                       const char *func );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_trace_log( struct stumpless_target *target,
                     int priority,
                     const char *file,
                     int line,
                     const char *func,
                     const char *message,
                     ... );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_trace_log_str( struct stumpless_target *target,
                         int priority,
                         const char *file,
                         int line,
                         const char *func,
                         const char *message );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_trace_message( struct stumpless_target *target,
                         const char *file,
                         int line,
                         const char *func,
                         const char *message,
                         ... );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_trace_message_str( struct stumpless_target *target,
                             const char *file,
                             int line,
                             const char *func,
                             const char *message );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_target *
stumpless_unset_option( struct stumpless_target *target, int option );
 
STUMPLESS_PUBLIC_FUNCTION
int
vstumpless_add_log( struct stumpless_target *target,
                    int priority,
                    const char *message,
                    va_list subs );
 
STUMPLESS_PUBLIC_FUNCTION
int
vstumpless_add_message( struct stumpless_target *target,
                        const char *message,
                        va_list subs );
 
STUMPLESS_PUBLIC_FUNCTION
int
vstumpless_trace_log( struct stumpless_target *target,
                      int priority,
                      const char *file,
                      int line,
                      const char *func,
                      const char *message,
                      va_list subs );
 
STUMPLESS_PUBLIC_FUNCTION
int
vstumpless_trace_message( struct stumpless_target *target,
                          const char *file,
                          int line,
                          const char *func,
                          const char *message,
                          va_list subs );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_target_type_string( enum stumpless_target_type target_type );
 
 
#ifdef __cplusplus
}                               /* extern "C" */
#endif
 
#endif                          /* __STUMPLESS_TARGET_H */