element.h

浏览该文件的文档.

/* 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_ELEMENT_H
#  define __STUMPLESS_ELEMENT_H
 
#  include <stdbool.h>
#  include <stddef.h>
#  include <stumpless/config.h>
#  include <stumpless/entry.h>
#  include <stumpless/param.h>
 
#  define STUMPLESS_MAX_ELEMENT_NAME_LENGTH 32
 
#  ifdef __cplusplus
extern "C" {
#  endif
 
// this is required due to the circular dependency with the entry header.
struct stumpless_entry;
 
#ifdef STUMPLESS_JOURNALD_TARGETS_SUPPORTED
typedef
size_t
( *stumpless_element_namer_func_t )( const struct stumpless_entry *entry,
                                     size_t element_index,
                                     char *destination,
                                     size_t size );
#endif
 
struct stumpless_element {
  char name[STUMPLESS_MAX_ELEMENT_NAME_LENGTH + 1];
  size_t name_length;
  struct stumpless_param **params;
  size_t param_count;
#ifdef STUMPLESS_JOURNALD_TARGETS_SUPPORTED
  stumpless_element_namer_func_t get_journald_name;
#endif
#ifdef STUMPLESS_THREAD_SAFETY_SUPPORTED
  void *mutex;
#endif
};
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_add_new_param( struct stumpless_element *element,
                         const char *param_name,
                         const char *param_value );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_add_param( struct stumpless_element *element,
                     struct stumpless_param *param );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_copy_element( const struct stumpless_element *element );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_destroy_element( const struct stumpless_element *element );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_destroy_element_and_contents( const struct stumpless_element *e );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_destroy_element_only( const struct stumpless_element *element );
 
STUMPLESS_PUBLIC_FUNCTION
bool
stumpless_element_has_param( const struct stumpless_element *element,
                             const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_element_to_string( const struct stumpless_element *element );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_element_name( const struct stumpless_element *element );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_param *
stumpless_get_param_by_index( const struct stumpless_element *element,
                              size_t index );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_param *
stumpless_get_param_by_name( const struct stumpless_element *element,
                             const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
size_t
stumpless_get_param_count( const struct stumpless_element *element );
 
STUMPLESS_PUBLIC_FUNCTION
size_t
stumpless_get_param_index( const struct stumpless_element *element,
                           const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_param_name_by_index( const struct stumpless_element *element,
                                   size_t index );
 
STUMPLESS_PUBLIC_FUNCTION
size_t
stumpless_get_param_name_count( const struct stumpless_element *element,
                                const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_param_value_by_index( const struct stumpless_element *element,
                                    size_t index );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_param_value_by_name( const struct stumpless_element *element,
                                   const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_load_element( struct stumpless_element *element, const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_new_element( const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_set_element_name( struct stumpless_element *element,
                            const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_set_param( struct stumpless_element *element,
                     size_t index,
                     struct stumpless_param *param );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_set_param_value_by_index( struct stumpless_element *element,
                                    size_t index,
                                    const char *value );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_element *
stumpless_set_param_value_by_name( struct stumpless_element *element,
                                   const char *name,
                                   const char *value );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_unload_element_and_contents( const struct stumpless_element *e );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_unload_element_only( const struct stumpless_element *element );
 
 
#  ifdef __cplusplus
}                               /* extern "C" */
#  endif
 
#endif /* __STUMPLESS_ELEMENT_H */