mcl_event.h File Reference

Event module interface header file. More...

#include "mcl/mcl_common.h"
Include dependency graph for mcl_event.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef struct mcl_event_t mcl_event_t
 This struct is used for building only one message of event. More...
 

Functions

MCL_EXPORT E_MCL_ERROR_CODE mcl_event_set_option (mcl_event_t *event, E_MCL_EVENT_OPTION option, const void *value)
 This function is used to set optional payload fields of event. More...
 

Detailed Description

Event module interface header file.


Date
Jul 27, 2016

Definition in file mcl_event.h.

Typedef Documentation

typedef struct mcl_event_t mcl_event_t

This struct is used for building only one message of event.

Definition at line 27 of file mcl_event.h.

Function Documentation

MCL_EXPORT E_MCL_ERROR_CODE mcl_event_set_option ( mcl_event_t event,
E_MCL_EVENT_OPTION  option,
const void *  value 
)

This function is used to set optional payload fields of event.

Parameters
[in]eventEvent to set its option.
[in]optionOne of the options listed in E_MCL_EVENT_OPTION.
[in]valueNew value of the option.
Returns

Definition at line 77 of file event.c.

References ASSERT_NOT_NULL, DEBUG_ENTRY, DEBUG_LEAVE, json_util_destroy(), json_util_duplicate(), MCL_EVENT_OPTION_CORRELATION_ID, MCL_EVENT_OPTION_DESCRIPTION, MCL_EVENT_OPTION_DETAILS, MCL_INVALID_PARAMETER, MCL_TRUE, string_destroy(), and string_initialize_new().

Here is the call graph for this function: