entry.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_ENTRY_H
#  define __STUMPLESS_ENTRY_H
 
#  include <stdarg.h>
#  include <stdbool.h>
#  include <stddef.h>
#  include <stumpless/config.h>
#  include <stumpless/element.h>
#  include <stumpless/facility.h>
#  include <stumpless/id.h>
#  include <stumpless/param.h>
#  include <stumpless/severity.h>
 
#define STUMPLESS_MAX_PROCID_LENGTH 128
 
#define STUMPLESS_MAX_HOSTNAME_LENGTH 255
 
#  define STUMPLESS_MAX_APP_NAME_LENGTH 48
 
#  define STUMPLESS_MAX_MSGID_LENGTH 32
 
#  ifdef __cplusplus
extern "C" {
#  endif
 
struct stumpless_entry {
  stumpless_id_t id;
  char procid[STUMPLESS_MAX_PROCID_LENGTH + 1];
  size_t procid_length;
  char hostname[STUMPLESS_MAX_HOSTNAME_LENGTH + 1];
  size_t hostname_length;
  int prival;
  char app_name[STUMPLESS_MAX_APP_NAME_LENGTH + 1];
  size_t app_name_length;
  char *message;
  size_t message_length;
  char msgid[STUMPLESS_MAX_MSGID_LENGTH + 1];
  size_t msgid_length;
  struct stumpless_element **elements;
  size_t element_count;
#  ifdef STUMPLESS_WINDOWS_EVENT_LOG_TARGETS_SUPPORTED
  void *wel_data;
#  endif
#  ifdef STUMPLESS_THREAD_SAFETY_SUPPORTED
  void *mutex;
#  endif
};
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_add_element( struct stumpless_entry *entry,
                       struct stumpless_element *element );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_add_new_element( struct stumpless_entry *entry,
                           const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_add_new_param_to_entry( struct stumpless_entry *entry,
                                  const char *element_name,
                                  const char *param_name,
                                  const char *param_value );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_copy_entry( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_destroy_entry( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_destroy_entry_and_contents( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_destroy_entry_only( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
bool
stumpless_entry_has_element( const struct stumpless_entry *entry,
                             const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_get_element_by_index( const struct stumpless_entry *entry,
                                size_t index );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_get_element_by_name( const struct stumpless_entry *entry,
                               const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
size_t
stumpless_get_element_count( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
size_t
stumpless_get_element_index( const struct stumpless_entry *entry,
                             const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_entry_app_name( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
enum stumpless_facility
stumpless_get_entry_facility( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_entry_hostname( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_entry_message( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_entry_msgid( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_param *
stumpless_get_entry_param_by_index( const struct stumpless_entry *entry,
                                    size_t element_index,
                                    size_t param_index );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_param *
stumpless_get_entry_param_by_name( const struct stumpless_entry *entry,
                                   const char *element_name,
                                   const char *param_name );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_entry_param_value_by_index( const struct stumpless_entry *entry,
                                          size_t element_index,
                                          size_t param_index );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_entry_param_value_by_name( const struct stumpless_entry *entry,
                                         const char *element_name,
                                         const char *param_name );
 
STUMPLESS_PUBLIC_FUNCTION
int
stumpless_get_entry_prival( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_entry_procid( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
enum stumpless_severity
stumpless_get_entry_severity( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_load_entry( struct stumpless_entry *entry,
                      enum stumpless_facility facility,
                      enum stumpless_severity severity,
                      const char *app_name,
                      const char *msgid,
                      const char *message,
                      ... );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_load_entry_str( struct stumpless_entry *entry,
                          enum stumpless_facility facility,
                          enum stumpless_severity severity,
                          const char *app_name,
                          const char *msgid,
                          const char *message );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_new_entry( enum stumpless_facility facility,
                     enum stumpless_severity severity,
                     const char *app_name,
                     const char *msgid,
                     const char *message,
                     ... );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_new_entry_str( enum stumpless_facility facility,
                         enum stumpless_severity severity,
                         const char *app_name,
                         const char *msgid,
                         const char *message );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_element( struct stumpless_entry *entry,
                       size_t index,
                       struct stumpless_element *element );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_app_name( struct stumpless_entry *entry,
                              const char *app_name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_facility( struct stumpless_entry *entry,
                              enum stumpless_facility facility );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_hostname( struct stumpless_entry *entry,
                              const char *hostname );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_message( struct stumpless_entry *entry,
                             const char *message,
                             ... );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_message_str( struct stumpless_entry *entry,
                                 const char *message );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_message_str_w( struct stumpless_entry *entry,
                                   const wchar_t *message );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_msgid( struct stumpless_entry *entry,
                           const char *msgid );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_param_by_index( struct stumpless_entry *entry,
                                    size_t element_index,
                                    size_t param_index,
                                    struct stumpless_param *param );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_param_value_by_index( struct stumpless_entry *entry,
                                          size_t element_index,
                                          size_t param_index,
                                          const char *value );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_param_value_by_name( struct stumpless_entry *entry,
                                         const char *element_name,
                                         const char *param_name,
                                         const char *value );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_priority( struct stumpless_entry *entry,
                              enum stumpless_facility facility,
                              enum stumpless_severity severity );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_prival( struct stumpless_entry *entry,
                            int prival );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_procid( struct stumpless_entry *entry, const char *procid );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
stumpless_set_entry_severity( struct stumpless_entry *entry,
                              enum stumpless_severity severity );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_unload_entry_and_contents( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_unload_entry_only( const struct stumpless_entry *entry );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
vstumpless_load_entry( struct stumpless_entry *entry,
                       enum stumpless_facility facility,
                       enum stumpless_severity severity,
                       const char *app_name,
                       const char *msgid,
                       const char *message,
                       va_list subs );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
vstumpless_new_entry( enum stumpless_facility facility,
                      enum stumpless_severity severity,
                      const char *app_name,
                      const char *msgid,
                      const char *message,
                      va_list subs );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_entry *
vstumpless_set_entry_message( struct stumpless_entry *entry,
                              const char *message,
                              va_list subs );
 
#  ifdef __cplusplus
}                               /* extern "C" */
#  endif
#endif                          /* __STUMPLESS_ENTRY_H */