param.h

Go to the documentation of this file.

/* SPDX-License-Identifier: Apache-2.0 */
 
/*
 * Copyright 2018-2022 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_PARAM_H
#  define __STUMPLESS_PARAM_H
 
#  include <stddef.h>
#  include <stumpless/config.h>
#  include <stumpless/entry.h>
 
#  define STUMPLESS_MAX_PARAM_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_param_namer_func_t )( const struct stumpless_entry *entry,
                                   size_t element_index,
                                   size_t param_index,
                                   char *destination,
                                   size_t size );
#endif
 
struct stumpless_param {
  char name[STUMPLESS_MAX_PARAM_NAME_LENGTH + 1];
  size_t name_length;
  char *value;
  size_t value_length;
#  ifdef STUMPLESS_JOURNALD_TARGETS_SUPPORTED
  stumpless_param_namer_func_t get_journald_name;
#  endif
#  ifdef STUMPLESS_THREAD_SAFETY_SUPPORTED
  void *mutex;
#  endif
};
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_param *
stumpless_copy_param( const struct stumpless_param *param );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_destroy_param( const struct stumpless_param *param );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_param_name( const struct stumpless_param *param );
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_get_param_value( const struct stumpless_param *param );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_param *
stumpless_load_param( struct stumpless_param *param,
                      const char *name,
                      const char *value );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_param *
stumpless_new_param( const char *name, const char *value );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_param *
stumpless_new_param_from_string( const char *string );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_param *
stumpless_set_param_name( struct stumpless_param *param, const char *name );
 
STUMPLESS_PUBLIC_FUNCTION
struct stumpless_param *
stumpless_set_param_value( struct stumpless_param *param, const char *value );
 
 
STUMPLESS_PUBLIC_FUNCTION
const char *
stumpless_param_to_string( const struct stumpless_param *param );
 
STUMPLESS_PUBLIC_FUNCTION
void
stumpless_unload_param( const struct stumpless_param *param );
 
#  ifdef __cplusplus
}                               /* extern "C" */
#  endif
 
#endif /* __STUMPLESS_PARAM_H */