AT&T ECOMP Vendor Event Listener library  0.1
Functions
evel_option.c File Reference

Source module relating to EVEL_OPTION_ types. More...

#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include "evel_internal.h"
Include dependency graph for evel_option.c:

Go to the source code of this file.

Functions

void evel_free_option_string (EVEL_OPTION_STRING *const option)
 Free the underlying resources of an EVEL_OPTION_STRING. More...
 
void evel_init_option_string (EVEL_OPTION_STRING *const option)
 Initialize an EVEL_OPTION_STRING to a not-set state. More...
 
void evel_set_option_string (EVEL_OPTION_STRING *const option, const char *const value, const char *const description)
 Set the value of an EVEL_OPTION_STRING. More...
 
void evel_force_option_string (EVEL_OPTION_STRING *const option, const char *const value)
 Force the value of an EVEL_OPTION_STRING. More...
 
void evel_init_option_int (EVEL_OPTION_INT *const option)
 Initialize an EVEL_OPTION_INT to a not-set state. More...
 
void evel_force_option_int (EVEL_OPTION_INT *const option, const int value)
 Force the value of an EVEL_OPTION_INT. More...
 
void evel_set_option_int (EVEL_OPTION_INT *const option, const int value, const char *const description)
 Set the value of an EVEL_OPTION_INT. More...
 
void evel_init_option_double (EVEL_OPTION_DOUBLE *const option)
 Initialize an EVEL_OPTION_DOUBLE to a not-set state. More...
 
void evel_force_option_double (EVEL_OPTION_DOUBLE *const option, const double value)
 Force the value of an EVEL_OPTION_DOUBLE. More...
 
void evel_set_option_double (EVEL_OPTION_DOUBLE *const option, const double value, const char *const description)
 Set the value of an EVEL_OPTION_DOUBLE. More...
 
void evel_init_option_ull (EVEL_OPTION_ULL *const option)
 Initialize an EVEL_OPTION_ULL to a not-set state. More...
 
void evel_force_option_ull (EVEL_OPTION_ULL *const option, const unsigned long long value)
 Force the value of an EVEL_OPTION_ULL. More...
 
void evel_set_option_ull (EVEL_OPTION_ULL *const option, const unsigned long long value, const char *const description)
 Set the value of an EVEL_OPTION_ULL. More...
 
void evel_init_option_time (EVEL_OPTION_TIME *const option)
 Initialize an EVEL_OPTION_TIME to a not-set state. More...
 
void evel_force_option_time (EVEL_OPTION_TIME *const option, const time_t value)
 Force the value of an EVEL_OPTION_TIME. More...
 
void evel_set_option_time (EVEL_OPTION_TIME *const option, const time_t value, const char *const description)
 Set the value of an EVEL_OPTION_TIME. More...
 

Detailed Description

Source module relating to EVEL_OPTION_ types.

License

Copyright(c) <2016>, AT&T Intellectual Property. All other rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by the AT&T.
  4. Neither the name of AT&T nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY AT&T INTELLECTUAL PROPERTY ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL AT&T INTELLECTUAL PROPERTY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file evel_option.c.

Function Documentation

§ evel_force_option_double()

void evel_force_option_double ( EVEL_OPTION_DOUBLE *const  option,
const double  value 
)

Force the value of an EVEL_OPTION_DOUBLE.

Parameters
optionPointer to the EVEL_OPTION_DOUBLE.
valueThe value to set.

Definition at line 248 of file evel_option.c.

§ evel_force_option_int()

void evel_force_option_int ( EVEL_OPTION_INT *const  option,
const int  value 
)

Force the value of an EVEL_OPTION_INT.

Parameters
optionPointer to the EVEL_OPTION_INT.
valueThe value to set.

Definition at line 172 of file evel_option.c.

§ evel_force_option_string()

void evel_force_option_string ( EVEL_OPTION_STRING *const  option,
const char *const  value 
)

Force the value of an EVEL_OPTION_STRING.

Parameters
optionPointer to the EVEL_OPTION_STRING.
valueThe value to set.

Definition at line 128 of file evel_option.c.

§ evel_force_option_time()

void evel_force_option_time ( EVEL_OPTION_TIME *const  option,
const time_t  value 
)

Force the value of an EVEL_OPTION_TIME.

Parameters
optionPointer to the EVEL_OPTION_TIME.
valueThe value to set.

Definition at line 395 of file evel_option.c.

§ evel_force_option_ull()

void evel_force_option_ull ( EVEL_OPTION_ULL *const  option,
const unsigned long long  value 
)

Force the value of an EVEL_OPTION_ULL.

Parameters
optionPointer to the EVEL_OPTION_ULL.
valueThe value to set.

Definition at line 322 of file evel_option.c.

§ evel_free_option_string()

void evel_free_option_string ( EVEL_OPTION_STRING *const  option)

Free the underlying resources of an EVEL_OPTION_STRING.

Parameters
optionPointer to the EVEL_OPTION_STRING.

Definition at line 48 of file evel_option.c.

§ evel_init_option_double()

void evel_init_option_double ( EVEL_OPTION_DOUBLE *const  option)

Initialize an EVEL_OPTION_DOUBLE to a not-set state.

Parameters
optionPointer to the EVEL_OPTION_DOUBLE.

Definition at line 227 of file evel_option.c.

§ evel_init_option_int()

void evel_init_option_int ( EVEL_OPTION_INT *const  option)

Initialize an EVEL_OPTION_INT to a not-set state.

Parameters
optionPointer to the EVEL_OPTION_INT.

Definition at line 151 of file evel_option.c.

§ evel_init_option_string()

void evel_init_option_string ( EVEL_OPTION_STRING *const  option)

Initialize an EVEL_OPTION_STRING to a not-set state.

Parameters
optionPointer to the EVEL_OPTION_STRING.

Definition at line 72 of file evel_option.c.

§ evel_init_option_time()

void evel_init_option_time ( EVEL_OPTION_TIME *const  option)

Initialize an EVEL_OPTION_TIME to a not-set state.

Parameters
optionPointer to the EVEL_OPTION_TIME.

Definition at line 376 of file evel_option.c.

§ evel_init_option_ull()

void evel_init_option_ull ( EVEL_OPTION_ULL *const  option)

Initialize an EVEL_OPTION_ULL to a not-set state.

Parameters
optionPointer to the EVEL_OPTION_ULL.

Definition at line 303 of file evel_option.c.

§ evel_set_option_double()

void evel_set_option_double ( EVEL_OPTION_DOUBLE *const  option,
const double  value,
const char *const  description 
)

Set the value of an EVEL_OPTION_DOUBLE.

Parameters
optionPointer to the EVEL_OPTION_DOUBLE.
valueThe value to set.
descriptionDescription to be used in logging.

Definition at line 271 of file evel_option.c.

§ evel_set_option_int()

void evel_set_option_int ( EVEL_OPTION_INT *const  option,
const int  value,
const char *const  description 
)

Set the value of an EVEL_OPTION_INT.

Parameters
optionPointer to the EVEL_OPTION_INT.
valueThe value to set.
descriptionDescription to be used in logging.

Definition at line 195 of file evel_option.c.

§ evel_set_option_string()

void evel_set_option_string ( EVEL_OPTION_STRING *const  option,
const char *const  value,
const char *const  description 
)

Set the value of an EVEL_OPTION_STRING.

Parameters
optionPointer to the EVEL_OPTION_STRING.
valueThe value to set.
descriptionDescription to be used in logging.

Definition at line 94 of file evel_option.c.

§ evel_set_option_time()

void evel_set_option_time ( EVEL_OPTION_TIME *const  option,
const time_t  value,
const char *const  description 
)

Set the value of an EVEL_OPTION_TIME.

Parameters
optionPointer to the EVEL_OPTION_TIME.
valueThe value to set.
descriptionDescription to be used in logging.

Definition at line 418 of file evel_option.c.

§ evel_set_option_ull()

void evel_set_option_ull ( EVEL_OPTION_ULL *const  option,
const unsigned long long  value,
const char *const  description 
)

Set the value of an EVEL_OPTION_ULL.

Parameters
optionPointer to the EVEL_OPTION_ULL.
valueThe value to set.
descriptionDescription to be used in logging.

Definition at line 345 of file evel_option.c.